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


Files:
Abstract.php
Abstract.php
Application.php
Enviroment.php
Exception.php
Interface.php
Loader.php
MissingParameter.php

Interfaces:
Console_Application_Interface
Classes:
Console_Application
Console_Application_Abstract
Console_Exception
Console_Loader

Element index for package Console_Application

[ a ] [ c ] [ e ] [ f ] [ g ] [ i ] [ l ] [ m ] [ o ] [ r ] [ s ] [ t ] [ _ ]

_

__construct
in file Abstract.php, method Console_Application_Abstract::__construct()
    On construction time a sapiCheck is done for CLI sapi.
__construct
in file Exception.php, method Console_Exception::__construct()
__toString
in file Exception.php, method Console_Exception::__toString()
    Formats the excpetion so we can echo it direct to the CLI.
top

a

Abstract.php
procedural page Abstract.php
Application.php
procedural page Application.php
Abstract.php
procedural page Abstract.php
top

c

Console_Application
in file Application.php, class Console_Application
    Class for running a Console_Application_Abstract-Script.
Console_Application_Abstract
in file Abstract.php, class Console_Application_Abstract
    Template method class for CLI commands.
Console_Application_Interface
in file Interface.php, class Console_Application_Interface
    Interface for console application objects.
Console_Exception
in file Exception.php, class Console_Exception
    Main exception calss.
Console_Loader
in file Loader.php, class Console_Loader
    Class for running a Console_Application_Abstract-Script.
top

e

echoMsg
in file Abstract.php, method Console_Application_Abstract::echoMsg()
    Echoes a string appended with PHP_EOL.
execute
in file Interface.php, method Console_Application_Interface::execute()
    Executes the application object
execute
in file Application.php, method Console_Application::execute()
    Loads a class named ${applicationName}Application in the direcotry ${directory} and executes it.
execute
in file Abstract.php, method Console_Application_Abstract::execute()
    Template method. Try to run some method stubs in this order:
Enviroment.php
procedural page Enviroment.php
Exception.php
procedural page Exception.php
top

f

findConsoleParameters
in file Abstract.php, method Console_Application_Abstract::findConsoleParameters()
    This method listens by default to the console parameters -v and -h.
top

g

getHelpMessage
in file Abstract.php, method 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:
getUsage
in file Abstract.php, method Console_Application_Abstract::getUsage()
    Returns a usage string like:
top

i

iniSet
in file Abstract.php, method Console_Application_Abstract::iniSet()
    This method wraps the php internal ini_set() that way, that it returns the old value.
isExecuted
in file Abstract.php, method Console_Application_Abstract::isExecuted()
    Returns whether the application object is executed or not.
isExecuted
in file Interface.php, method Console_Application_Interface::isExecuted()
    Returns whether the application object is executed or nit.
isFileNameValid
in file Loader.php, method Console_Loader::isFileNameValid()
    Checks if a filename is valid.
isPcntlEnabled
in file Abstract.php, method Console_Application_Abstract::isPcntlEnabled()
isReadable
in file Loader.php, method Console_Loader::isReadable()
    Checks if a file is readable.
isVerbose
in file Abstract.php, method Console_Application_Abstract::isVerbose()
    Returns whether the application object is verbose or not.
Interface.php
procedural page Interface.php
top

l

Loader.php
procedural page Loader.php
loadClass
in file Loader.php, method Console_Loader::loadClass()
    Loads a class depending on the class name.
top

m

MissingParameter.php
procedural page MissingParameter.php
top

o

onError
in file Abstract.php, method Console_Application_Abstract::onError()
    This method is called if in the three followed methods a exception was
top

r

registerSignalHandlers
in file Abstract.php, method Console_Application_Abstract::registerSignalHandlers()
    Registers some signal handlers:
run
in file Abstract.php, method Console_Application_Abstract::run()
    You need to implement this method. Put your stuff to do here.
top

s

$scriptname
in file Abstract.php, variable Console_Application_Abstract::$scriptname
    Name of the script. Appended with 'Application' its the Classname of your concrete implementation.
setExecuted
in file Abstract.php, method Console_Application_Abstract::setExecuted()
    Sets object executed.
setPhpEnviroment
in file Abstract.php, method Console_Application_Abstract::setPhpEnviroment()
    Sets the the php enviroment by ini settings to a proper default.
setUp
in file Abstract.php, method 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().
signalHangUp
in file Abstract.php, method Console_Application_Abstract::signalHangUp()
    Signal handler registered by Console_Application_Abstract::registerSignalHandlers().
signalInt
in file Abstract.php, method Console_Application_Abstract::signalInt()
    Signal handler registered by Console_Application_Abstract::registerSignalHandlers().
signalTerm
in file Abstract.php, method Console_Application_Abstract::signalTerm()
    Signal handler registered by Console_Application_Abstract::registerSignalHandlers().
top

t

tearDown
in file Abstract.php, method 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.
top
Documentation generated on Mon, 17 Aug 2009 15:51:50 +0200 by phpDocumentor 1.4.2