Class: Console_Application_Abstract

Console_Application_Abstract __construct( string $scriptname, [int $maxExecTime = 60], [string $memoryLimit = '128M'])

On construction time a sapiCheck is done for CLI sapi.

The php enviroment will be set and some default signal handlers are registered.

Throws a excpetion if the php enviroment ist not the command line.

Tags:

Parameters:

void echoMsg( [string $msg = ''])

Echoes a string appended with PHP_EOL.

If you call it without parameter it makes newlines ;-)

Tags:

Parameters:

void execute( )

Template method. Try to run some method stubs in this order:

1. Console_Application_Abstract::findConsoleParameters()
2. Console_Application_Abstract::setUp()
3. Console_Application_Abstract::run()
4. Console_Application_Abstract::tearDown()

If Console_Application_Abstract::findConsoleParameters() returns true the script execution aborts imediately.

If in the templateed method structure any exception occures it is catched an the method Console_Application_Abstract::onError() is called. The exception object is passed to it.

After that procedure two additional tear down methods will be called:

1. Console_Application_Abstract::setExecuted()
2. Console_Application_Abstract::resetPhpEnviroment()

Tags:

---

Console_Application_Interface::execute()

Executes the application object

bool findConsoleParameters( )

This method listens by default to the console parameters -v and -h.

By default -v enables the verbose mode (see Console_Application_Abstract::isVerbose()).

By default -h calls Console_Application_Abstract::printHelpMessage() and returns with false.

To retrieve custom options overwite this mithed. Call the method an checks against false. Then check your options. If a required option is not set you should throw an Console_Exception_MissingParameter. This errors are handled in an default way to the console user (see Console_Exception_MissingParameter::onError()).

Example implementation. Full example @see HelloWorldApplication

1.  protected function findConsoleParameters() {
2.   $options = getopt('n:s:');
3.  
4.   if (!parent::findConsoleParameters()) {
5.        return false;
6.    }
7.  
8.    if (isset($options['n']) && !empty($options['n'])) {
9.        $this->name = $options['n'];
10.    }
11.  
12.    if (isset($options['s']) && !empty($options['s'])) {
13.        $this->sleep = (int) $options['s'];
14.    }
15.  
16.    return true;
17.  }

To brek the script if a user omitted a required console option you should implement it that way, because the onError() method handles Console_Exception_MissingParameter by default with nice user experience.

1.  protected function findConsoleParameters() {
2.   $options = getopt('n:');
3.  
4.   if (!parent::findConsoleParameters()) {
5.        return false;
6.    }
7.  
8.    if (isset($options['n']) && !empty($options['n'])) {
9.        $this->name = $options['n'];
10.    } else {
11.       throw new Console_Exception_MissingParameter('n');
12.    }
13.  
14.    return true;
15.  }

For more details about getting options by getopt()

Tags:

Overridden in child classes as:

Console_Application_Concrete::findConsoleParameters()

HelloWorldApplication::findConsoleParameters()

string getHelpMessage( [string $author = ''], [string $email = 'foo@bar.de'])

Returns a help message. Its called by default object behavier, if you suply -h to the script. By default it returns a line break formatted help message like:

  This is a sample console application. It prints some hello world statements.

  Usage:  {$scriptName} [-h] [-v]
          {$scriptName} -v : Sets the script in verbose mode.
          {$scriptName} -h : prints this help message.

  For bug reporting or issues contact: foo@bar.de

You can customize the help message your wy. See an example implementation (@see HelloWorldApplication)

1.  protected function getHelpMessage($author = '...', $email = '...') {
2.       $message  = "This is a sample console application. It prints some ";
3.       $message .= "hello world statements." . PHP_EOL . PHP_EOL;
4.       $message .= $this->getUsage() . PHP_EOL;
5.       $message .= "\t{$this->scriptname} -n : You can specify a name to ";
6.       $message .= §be hellowed" . PHP_EOL;
7.       $message .= "t{$this->scriptname} -s : You can specify the seconds ";
8.       $message .= §to sleep between hello and name."  . PHP_EOL;
9.       $message .= parent::getHelpMessage($author, $email);
10.  
11.       throw new Console_Exception($message);
12.  }

Tags:

Overridden in child classes as:

HelloWorldApplication::getHelpMessage()

Parameters:

string getUsage( [string $options = ''])

Returns a usage string like:

 Usage: {$scriptName} {$options} [-h] [-v]

By example implementation (@see HelloWorldApplication) its:

 Usage:  helloworld.sh [-n] [-s] [-h] [-v]

Tags:

Overridden in child classes as:

HelloWorldApplication::getUsage()

Parameters:

mixed iniSet( string $name, mixed $value)

This method wraps the php internal ini_set() that way, that it returns the old value.

Tags:

Parameters:

bool isExecuted( )

Returns whether the application object is executed or not.

Tags:

---

Console_Application_Interface::isExecuted()

Returns whether the application object is executed or nit.

void isPcntlEnabled( )

Tags:

Overridden in child classes as:

Console_Application_Concrete::isPcntlEnabled()

bool isVerbose( )

Returns whether the application object is verbose or not.

This is set by the comandline option -v (in Console_Application_Abstract::findConsoleParameters()).

Tags:

void onError( mixed $errorData)

This method is called if in the three followed methods a exception was

throwed:

• Console_Application_Abstract::findConsoleParameters()
• Console_Application_Abstract::setUp()
• Console_Application_Abstract::run()
• Console_Application_Abstract::tearDown()

Exceptions of the (sub)type Console_Exception are handled by defaukt in a special way: <dl> <dt>Console_Exception_MissingParameter</dt> <dd>The exeption message and the return string of getUsage() will be echoed.</dd> <dt>Console_Exception</dt> <dd>The excpetion message will be echoed.</dd> </dl>

Tags:

Overridden in child classes as:

Console_Application_Concrete::onError()

Parameters:

void registerSignalHandlers( )

Registers some signal handlers:

<dl> <dd>SIGTERM</dd> <dt>Console_Application_Abstract::signalTerm()</dt> <dd>SIGINT</dd> <dt>Console_Application_Abstract::signalInt()</dt> <dd>SIGHUP</dd> <dt>Console_Application_Abstract::signalHangUp()</dt> </dl>

IS called on construction time. Overwrite this methid

Tags:

void run( )

You need to implement this method. Put your stuff to do here.

Return values are not evaluated.

Tags:

Overridden in child classes as:

Console_Application_Concrete::run()

TestApplication::run()

Console_Deamon_Abstract::run()

Template method from Console_Application_Abstract.

HelloWorldApplication::run()

void setExecuted( )

Sets object executed.

Tags:

void setPhpEnviroment( string $memoryLimit, int $maxExecutionTime)

Sets the the php enviroment by ini settings to a proper default.

These are:

• memory_limit
• max_execution_time
• html_errors = false
• implicit_flush = true

The old values are stored in Console_Application_Abstract::iniSet array. So they can be restored by Console_Application_Abstract::resetPhpEnviroment().

If you wanne make some custom ini settings in your script overwrite this method this way:

Tags:

Parameters:

void setUp( )

Template method stub. Overwrite this method to hook the set up phase of your script. This method is called after Console_Application_Abstract::findConsoleParameters(), unless it returns false. And before Console_Application_Abstract::run().

By default this method does nothing!

Return values are not evaluated.

Tags:

Overridden in child classes as:

Console_Application_Concrete::setUp()

void signalHangUp( int $signal)

Signal handler registered by Console_Application_Abstract::registerSignalHandlers().

By default it echoes a message and calls Console_Application_Abstract::tearDown().

Overwrite this method to react on SIGHUP.

Tags:

Overridden in child classes as:

Console_Application_Concrete::signalHangUp()

Parameters:

void signalInt( int $signal)

Signal handler registered by Console_Application_Abstract::registerSignalHandlers().

By default it echoes a message and calls Console_Application_Abstract::tearDown().

Overwrite this method to react on SIGINT.

Tags:

Overridden in child classes as:

Console_Application_Concrete::signalInt()

Console_Deamon_Abstract::signalInt()

Bind the signal SIG_INT to brek the loop.

HelloWorldApplication::signalInt()

Parameters:

void signalTerm( int $signal)

Signal handler registered by Console_Application_Abstract::registerSignalHandlers().

By default it echoes a message and calls Console_Application_Abstract::tearDown().

Overwrite this method to react on SIGTERM.

Tags:

Overridden in child classes as:

Console_Application_Concrete::signalTerm()

Console_Deamon_Abstract::signalTerm()

Bind the signal SIG_TERM to brek the loop.

Parameters:

void tearDown( )

Template method stub. Overwrite this method to hook the tear down phase of your script. This method is called after Console_Application_Abstract::run(), unless any exception was throwed.

And before Console_Application_Abstract::setExecuted().

By default this method does nothing!

Return values are not evaluated.

Tags:

Overridden in child classes as:

Console_Application_Concrete::tearDown()