Example
[ class tree: Example ] [ index: Example ] [ all elements ]
Packages:
Console_Application
Console_Deamon
Console_Enviroment
Console_Exception
Example
Unittests


Files:
HelloWorldApplication.php

Classes:
HelloWorldApplication

Class: HelloWorldApplication

Source Location: /application/console/HelloWorldApplication.php

Class Overview

Console_Application_Abstract
   |
   --HelloWorldApplication

Template method class for CLI commands.


Author(s):

Copyright:

  • Copyright (c) 2009 Sven Strittmatter

Variables

Methods

Inherited Variables

Class: Console_Application_Abstract

Console_Application_Abstract::$scriptname

Inherited Methods

Class: Console_Application_Abstract

Console_Application_Abstract::__construct()
On construction time a sapiCheck is done for CLI sapi.
Console_Application_Abstract::echoMsg()
Echoes a string appended with PHP_EOL.
Console_Application_Abstract::execute()
Template method. Try to run some method stubs in this order:
Console_Application_Abstract::findConsoleParameters()
This method listens by default to the console parameters -v and -h.
Console_Application_Abstract::getHelpMessage()
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:
Console_Application_Abstract::getUsage()
Returns a usage string like:
Console_Application_Abstract::iniSet()
This method wraps the php internal ini_set() that way, that it returns the old value.
Console_Application_Abstract::isExecuted()
Returns whether the application object is executed or not.
Console_Application_Abstract::isPcntlEnabled()
Console_Application_Abstract::isVerbose()
Returns whether the application object is verbose or not.
Console_Application_Abstract::onError()
This method is called if in the three followed methods a exception was
Console_Application_Abstract::registerSignalHandlers()
Registers some signal handlers:
Console_Application_Abstract::run()
You need to implement this method. Put your stuff to do here.
Console_Application_Abstract::setExecuted()
Sets object executed.
Console_Application_Abstract::setPhpEnviroment()
Sets the the php enviroment by ini settings to a proper default.
Console_Application_Abstract::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().
Console_Application_Abstract::signalHangUp()
Signal handler registered by Console_Application_Abstract::registerSignalHandlers().
Console_Application_Abstract::signalInt()
Signal handler registered by Console_Application_Abstract::registerSignalHandlers().
Console_Application_Abstract::signalTerm()
Signal handler registered by Console_Application_Abstract::registerSignalHandlers().
Console_Application_Abstract::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.

Class Details

[line 47]
Template method class for CLI commands.



Tags:

copyright:  Copyright (c) 2009 Sven Strittmatter
see:  HelloWorldApplication for an example implementation.
abstract:  
uses:  Console_Application_Abstract
uses:  Console_Exception


[ Top ]

Class Variables

$name =  'world'

[line 52]



Tags:

access:  protected

Type:   string


[ Top ]

$sleep =  0

[line 57]



Tags:

access:  protected

Type:   int


[ Top ]


Class Methods

method findConsoleParameters [line 84]

void findConsoleParameters( )



Tags:

see:  Console_Application_Abstract::findConsoleParameters()
access:  protected


Overrides Console_Application_Abstract::findConsoleParameters() (This method listens by default to the console parameters -v and -h.)

[ Top ]

method getHelpMessage [line 112]

void getHelpMessage( [ $author = 'Sven Strittmatter'], [ $email = 'ich@weltraumschaf.de'])



Tags:

see:  Console_Application_Abstract::getHelpMessage()
access:  public


Overrides Console_Application_Abstract::getHelpMessage() (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:)

Parameters:

   $author  
   $email  

[ Top ]

method getUsage [line 105]

void getUsage( [ $options = null])



Tags:

see:  Console_Application_Abstract::getUsage()
access:  public


Overrides Console_Application_Abstract::getUsage() (Returns a usage string like:)

Parameters:

   $options  

[ Top ]

method run [line 62]

void run( )



Tags:

see:  Console_Application_Abstract::run()
access:  protected


Overrides Console_Application_Abstract::run() (You need to implement this method. Put your stuff to do here.)

[ Top ]

method signalInt [line 77]

void signalInt( $signal)



Tags:

see:  Console_Application_Abstract::signalInt()
access:  public


Overrides Console_Application_Abstract::signalInt() (Signal handler registered by Console_Application_Abstract::registerSignalHandlers().)

Parameters:

   $signal  

[ Top ]

Documentation generated on Mon, 17 Aug 2009 15:52:39 +0200 by phpDocumentor 1.4.2