NotifyallUsersCommand Class Reference

Send a notification to ALL users. More...

Inheritance diagram for NotifyallUsersCommand:

List of all members.

Public Member Functions
	get_name ()
	Returns title of command.
Protected Member Functions
	do_execute ()
	Do it.
	mass_insert ($title, $message, $source)
	Create the insert query an run it.
	validate ($params)
	Check if there are.

---

Detailed Description

Send a notification to ALL users.

Definition at line 5 of file notifyall.cmd.php.

---

Member Function Documentation

NotifyallUsersCommand::do_execute

(

)

[protected]

Do it.

See also:

core/behaviour/base/CommandTransactionaldo_execute()

Reimplemented from CommandTransactional.

Definition at line 18 of file notifyall.cmd.php.

                                        {
                $ret = new Status();
                Load::models('notifications');
                
                $params = $this->get_params();
                $ret->merge($this->validate($params));
                if ($ret->is_ok()) {            
                        $title = Arr::get_item($params, 'title', '');
                        $message = Arr::get_item($params, 'message', '');
                        $source = Arr::get_item($params, 'source', '');
                        
                        $ret->merge($this->mass_insert($title, $message, $source));
                }
                return $ret;
        }

NotifyallUsersCommand::get_name

(

)

Returns title of command.

Reimplemented from CommandBase.

Definition at line 9 of file notifyall.cmd.php.

                                   {
                return 'notifyall';
        }

NotifyallUsersCommand::mass_insert	(	$	title,
		$	message,
		$	source
	)			[protected]

Create the insert query an run it.

Definition at line 37 of file notifyall.cmd.php.

                                                                  {
                $user = new DAOUsers();
                $notification = new DAONotifications();
                
                $select = $user->create_select_query();
                $select->set_fields(array(
                        'id' => 'id_user',
                        $notification->quote($title) => 'title',
                        $notification->quote($message) => 'message',
                        $notification->quote($source) => 'source',
                ));
                
                $insert = $notification->create_insert_query();
                $insert->set_fields(array(
                        'id_user', 'title', 'message', 'source'
                )); 
                $insert->set_select($select);
                return DB::execute($insert->get_sql(), $notification->get_table_driver());
        }

NotifyallUsersCommand::validate

(

$

params

)

[protected]

Check if there are.

Definition at line 60 of file notifyall.cmd.php.

                                             {
                // Prepare a valid user id;
                $user = new DAOUsers();
                $user->limit(0, 1);
                $user->find(DAOUsers::AUTOFETCH);
                $params['id_user'] = $user->id;
                
                $test = new DAONotifications();
                $test->read_from_array($params);
                return $test->validate();               
        } 

---

The documentation for this class was generated from the following file:

• contributions/usermanagement.notifications/behaviour/commands/users/notifyall.cmd.php