How to create a Command

A command is an implementation of the command pattern.
You can download the command sandbox in order to have a skeleton to develop your plug-in but you'll see how simple it is!

As software developer we like to start with some code:

require_once(COMMANDPATH.'/command.php');
require_once(COMMANDPATH.'/remote.php');

class ProofCommand implements Command {

function execute(){
echo "I'm a command!!!";
}

}

$command= new ProofCommand();

$remote = Remote::getInstance();

$remote->addCommandBeforeIndex($command);

So few lines of code?
Yes! :-)

Ad the start of the script we include the command interface and the remote singleton.
If you are curious about this script just check the files command.php and remote.php in the admin/command directory in your EasyMagazine installation.

Then we create the class ProofCommand that implements the interface Command. This means that we must create a method execute(). This method will be executed every time the trigger is pulled.

That's it, the command is ready! :-)

Now we need to decide when the command has to be executed.
We decide to let it execute before the index page is loaded, that means that every time an user opens our index page our command will be triggered!

So we create an instance of the command ProofCommand, we get the instance of the remote singleton and we add the $command instance to the command array that have to be executed before the index is loaded.

Now we finished, the command will be executed as we desire, every time the index page is loaded.

The events we can use to triger a command are:

addCommandBeforeArticle
addCommandAfterArticle
addCommandBeforeArticlesPerson
addCommandAfterArticlesPerson
addCommandBeforeCategory
addCommandAfterCategory
addCommandBeforeComments
addCommandAfterComments
addCommandBeforeNumber
addCommandAfterNumber
addCommandBeforeNumbersList
addCommandAfterNumbersList
addCommandBeforePage
addCommandAfterPage
addCommandBeforePeople
addCommandAfterPeople
addCommandBeforeResults
addCommandAfterResults
addCommandBeforeIndex
addCommandAfterIndex
addCommandBeforeHeader
addCommandAfterHeader
addCommandBeforeFooter
addCommandAfterFooter