CommandComposite Class Reference
[Behaviour]

The command composite executes a set of commands. More...

Inheritance diagram for CommandComposite:

List of all members.

Public Member Functions
	append ($command)
	Append a command to the chain.
	append_array ($commands)
	Append a command array to the chain.
	can_execute ($user)
	Returns TRUE, if all commands in the chain can be executed by given user.
	execute ()
	Execute all commands (until one fails.
	undo ()
	Undo all commands in chain.
Protected Member Functions
	do_can_execute ($user)
	Does execution checking.
	do_execute ()
	Does executing.
	do_undo ()
	Does undo.
	undo_on_chain ($commands)
	Undo comnmands passed.
Protected Attributes
	$commands = array()

---

Detailed Description

The command composite executes a set of commands.

Comamnds you append are executed in a tree-like manor.

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

Author:

Gerd Riesselmann

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

---

Member Function Documentation

CommandComposite::append

(

$

command

)

Append a command to the chain.

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

                                         {
                if ($command instanceof ICommand) {
                        $this->commands[] = $command;
                }
        }

CommandComposite::append_array

(

$

commands

)

Append a command array to the chain.

Definition at line 29 of file commandcomposite.cls.php.

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

CommandComposite::can_execute

(

$

user

)

Returns TRUE, if all commands in the chain can be executed by given user.

Reimplemented from CommandBase.

Definition at line 40 of file commandcomposite.cls.php.

                                           {
                $ret = $this->do_can_execute($user);
                if ($ret) {
                        foreach($this->commands as $command) {
                                if (!$command->can_execute($user)) {
                                        return false;
                                }                       
                        }
                }
                return $ret;
        }

CommandComposite::do_can_execute

(

$

user

)

[protected]

Does execution checking.

Returns:

bool

Definition at line 108 of file commandcomposite.cls.php.

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

CommandComposite::do_execute

(

)

[protected]

Does executing.

Returns:

Status

Definition at line 117 of file commandcomposite.cls.php.

                                        {
                return parent::execute();
        } 

CommandComposite::do_undo

(

)

[protected]

Does undo.

Definition at line 124 of file commandcomposite.cls.php.

                                     {
                parent::undo();
        }       

CommandComposite::execute

(

)

Execute all commands (until one fails.

.)

Reimplemented from CommandBase.

Definition at line 55 of file commandcomposite.cls.php.

                                  {
                $ret = new Status();
                $arr_executed = array();
                DB::start_trans();
                try { 
                        $ret = $this->do_execute(); 
                        if ($ret->is_ok()) {
                                foreach($this->commands as $command) {
                                        $ret->merge($command->execute());
                                        if ($ret->is_error()) {
                                                // Ups, something went wrong
                                                break;
                                        }
                                        $arr_executed[] = $command;
                                }
                        }
                }
                catch (Exception $ex) {
                        $ret->merge($ex);
                }
                
                if ($ret->is_error()) {
                        $this->undo_on_chain($arr_executed);
                        $this->undo();
                }
                DB::end_trans($ret);
                return $ret;
        }

CommandComposite::undo

(

)

Undo all commands in chain.

Reimplemented from CommandBase.

Definition at line 87 of file commandcomposite.cls.php.

                               {
                $this->do_undo();
                $this->undo_on_chain($this->commands);
        }

CommandComposite::undo_on_chain

(

$

commands

)

[protected]

Undo comnmands passed.

Definition at line 95 of file commandcomposite.cls.php.

                                                    {
                // Undoing is done reverse, that is last command first.
                $cnt = count($commands);
                for ($i = $cnt - 1; $i >= 0; $i--) {
                        $commands[$i]->undo();
                }       
        }

---

Member Data Documentation

CommandComposite::$commands = array() [protected]

Definition at line 15 of file commandcomposite.cls.php.

---

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

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