StatusAnyCommand Class Reference
[Status]

Implementation of delegated command to set status. More...

Inheritance diagram for StatusAnyCommand:

List of all members.

Public Member Functions
	get_description ()
	Returns a description of this command.
	get_name ()
	Returns title of command.
	get_params ()
	Returns params.
Protected Member Functions
	do_can_execute ($user)
	Returns true, if changing status is allowed.
	do_can_execute_status ($user, IStatusHolder $inst, $new_status)
	Check if command can be executed.
	do_execute ()
	Change status.

---

Detailed Description

Implementation of delegated command to set status.

Expects new status as param.

Specialized status commands should derive from this class

Author:

Gerd Riesselmann

Definition at line 12 of file status.any.cmd.php.

---

Member Function Documentation

StatusAnyCommand::do_can_execute

(

$

user

)

[protected]

Returns true, if changing status is allowed.

Validates $user and than calls template method do_can_execute_status()

Reimplemented from CommandChain.

Definition at line 18 of file status.any.cmd.php.

                                                 {
                $ret = false;
                $inst = $this->get_instance();
                if ($inst instanceof IStatusHolder) {
                        $new_status = $this->get_params();
                        $ret = ($inst->get_status() != $new_status);
                        // Note that functions below are not be called, if $ret becomes false   
                        $ret = $ret && parent::do_can_execute($user);
                        $ret = $ret && $this->do_can_execute_status($user, $inst, $new_status);
                }
                return $ret;
        }

StatusAnyCommand::do_can_execute_status	(	$	user,
		IStatusHolder $	inst,
		$	new_status
	)			[protected]

Check if command can be executed.

Parameters:

	mixed	$user
	IStatusHolder	$inst
	mixed	$new_status

Returns:

bool

Definition at line 39 of file status.any.cmd.php.

                                                                                          {
                return true;
        }

StatusAnyCommand::do_execute

(

)

[protected]

Change status.

Returns:

Status

Reimplemented from CommandChain.

Definition at line 48 of file status.any.cmd.php.

                                        {
                $ret = new Status();
                Load::commands('generics/setstatus');
                $this->append(new SetstatusCommand($this->get_instance(), $this->get_params()));
                $this->set_result($this->get_instance());
                return $ret;
        }

StatusAnyCommand::get_description

(

)

Returns a description of this command.

Reimplemented from CommandBase.

Definition at line 79 of file status.any.cmd.php.

                                          {
                $text = 'Change to ' . Cast::string($this->get_params());
                $transmods = array('app', 'status');
                $inst = $this->get_instance();
                if ($inst instanceof IDataObject) {
                        array_unshift($transmods, $inst->get_table_name());
                }
                return tr(
                        $text, 
                        $transmods
                );      
        } 

StatusAnyCommand::get_name

(

)

Returns title of command.

Reimplemented from CommandBase.

Definition at line 72 of file status.any.cmd.php.

                                   {
                return 'status';
        }

StatusAnyCommand::get_params

(

)

Returns params.

Returns:

mixed

Reimplemented from CommandBase.

Definition at line 61 of file status.any.cmd.php.

                                     {
                $ret = parent::get_params();
                if (is_array($ret)) {
                        $ret = Arr::get_item($ret, 0, '');
                }
                return $ret;
        }       

---

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

• gyro/modules/status/behaviour/commands/generics/status.any.cmd.php