CommandChain Class Reference
[Behaviour]

The command chain executes commands that form a hierarchy. More...

Inheritance diagram for CommandChain:

List of all members.

Public Member Functions
	append ($cmd)
	Set the next command in chain.
	append_array ($commands)
	Append a command array to the chain.
	can_execute ($user)
	Returns TRUE, if the command can be executed by given user.
	execute ()
	Executes commands.
	undo ()
	Revert execution.
Protected Member Functions
	do_can_execute ($user)
	Does execution checking.
	do_execute ()
	Does executing.
	do_undo ()
	Does undo.
	get_next ()
	Return next command.
	get_prev ()
	Return previous command.
	set_prev ($cmd)
	Set previous command.
Protected Attributes
	$next = null
	$prev = null

---

Detailed Description

The command chain executes commands that form a hierarchy.

Every command you append is put at the end of the chain

This command wraps a database transaction around the execution of all commands

Author:

Gerd Riesselmann

Definition at line 14 of file commandchain.cls.php.

---

Member Function Documentation

CommandChain::append

(

$

cmd

)

Set the next command in chain.

Definition at line 104 of file commandchain.cls.php.

                                     {
                if ($this->next) {
                        $this->next->append($cmd);
                }
                else {
                        if ($cmd instanceof ICommand) {
                                if ($cmd instanceof CommandChain) {
                                        $this->next = $cmd;
                                        $cmd->set_prev($this);
                                }
                                else {
                                        $adapter = new CommandChainAdapter($cmd);
                                        $this->append($adapter);
                                }
                        }
                }
        }

CommandChain::append_array

(

$

commands

)

Append a command array to the chain.

Definition at line 125 of file commandchain.cls.php.

                                                {
                if (is_array($commands)) {
                        foreach($commands as $command) {
                                $this->append($command);
                        }
                }
        }

CommandChain::can_execute

(

$

user

)

Returns TRUE, if the command can be executed by given user.

Reimplemented from CommandBase.

Definition at line 31 of file commandchain.cls.php.

                                           {
                $ret = $this->do_can_execute($user);
                if ($ret) {
                        $next = $this->get_next();
                        if ($next) {
                                $ret = $next->can_execute($user);
                        }
                }
                return $ret;
        }

CommandChain::do_can_execute

(

$

user

)

[protected]

Does execution checking.

Reimplemented in CommandChainAdapter, and StatusAnyCommand.

Definition at line 145 of file commandchain.cls.php.

                                                 {
                return parent::can_execute($user);
        }

CommandChain::do_execute

(

)

[protected]

Does executing.

Reimplemented in CommandChainAdapter, and StatusAnyCommand.

Definition at line 152 of file commandchain.cls.php.

                                        {
                return parent::execute();
        } 

CommandChain::do_undo

(

)

[protected]

Does undo.

Reimplemented in CommandChainAdapter.

Definition at line 159 of file commandchain.cls.php.

                                     {
                parent::undo();
        }

CommandChain::execute

(

)

Executes commands.

Returns:

Status

Reimplemented from CommandBase.

Definition at line 47 of file commandchain.cls.php.

                                  {
                $ret = new Status();
                
                DB::start_trans();
                try { 
                        $ret = $this->do_execute();
                        if ($ret->is_ok()) {
                                $next = $this->get_next();
                                if ($next) {
                                        $ret = $next->execute();
                                }
                        }
                }
                catch (Exception $ex) {
                        $ret->merge($ex);
                }
                
                if ($ret->is_ok()) {
                        $ret->merge(parent::execute());
                }
                
                if ($ret->is_error()) {
                        $this->undo();
                }
                DB::end_trans($ret);            

                return $ret;
        }

CommandChain::get_next

(

)

[protected]

Return next command.

Definition at line 90 of file commandchain.cls.php.

                                      {
                return $this->next;
        }

CommandChain::get_prev

(

)

[protected]

Return previous command.

Definition at line 97 of file commandchain.cls.php.

                                      {
                return $this->prev;
        }

CommandChain::set_prev

(

$

cmd

)

[protected]

Set previous command.

Definition at line 136 of file commandchain.cls.php.

                                          {
                if ($cmd instanceof ICommand) {
                        $this->prev = $cmd;
                }               
        }

CommandChain::undo

(

)

Revert execution.

Reimplemented from CommandBase.

Definition at line 79 of file commandchain.cls.php.

                               {
                $this->do_undo();
                $prev = $this->get_prev();
                if ($prev) {
                        $prev->undo();
                }
        }

---

Member Data Documentation

CommandChain::$next = null [protected]

Definition at line 20 of file commandchain.cls.php.

CommandChain::$prev = null [protected]

Definition at line 26 of file commandchain.cls.php.

---

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

• gyro/core/behaviour/base/commandchain.cls.php