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

Index of all elements

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ _ ]

a

Abstract.php
procedural page Abstract.php
Application.php
procedural page Application.php
Abstract.php
procedural page Abstract.php
AbstractTest.php
procedural page AbstractTest.php
ApplicationTest.php
procedural page ApplicationTest.php
AbstractTest.php
procedural page AbstractTest.php
top

b

BadTestApplication
in file ApplicationTest.php, class BadTestApplication
breakLoop
in file Abstract.php, method Console_Deamon_Abstract::breakLoop()
    Signals the object to do no more loop cycles.
top

c

Console_Application
in file Application.php, class Console_Application
    Class for running a Console_Application_Abstract-Script.
Console_ApplicationTest
in file ApplicationTest.php, class Console_ApplicationTest
Console_Application_Abstract
in file Abstract.php, class Console_Application_Abstract
    Template method class for CLI commands.
Console_Application_AbstractTest
in file AbstractTest.php, class Console_Application_AbstractTest
Console_Application_Concrete
in file AbstractTest.php, class Console_Application_Concrete
    Template method class for CLI commands.
Console_Application_Interface
in file Interface.php, class Console_Application_Interface
    Interface for console application objects.
Console_Deamon_Abstract
in file Abstract.php, class Console_Deamon_Abstract
    Class which is running in a loop.
Console_Deamon_AbstractTest
in file AbstractTest.php, class Console_Deamon_AbstractTest
Console_Enviroment
in file Enviroment.php, class Console_Enviroment
    Template method class for CLI commands.
Console_EnviromentTest
in file EnviromentTest.php, class Console_EnviromentTest
Console_Exception
in file Exception.php, class Console_Exception
    Main exception calss.
Console_ExceptionTest
in file ExceptionTest.php, class Console_ExceptionTest
Console_Exception_MissingParameter
in file MissingParameter.php, class Console_Exception_MissingParameter
    Class for running a Console_Application_Abstract-Script.
Console_Exception_MissingParameterTest
in file MissingParameterTest.php, class Console_Exception_MissingParameterTest
Console_Loader
in file Loader.php, class Console_Loader
    Class for running a Console_Application_Abstract-Script.
Console_LoaderTest
in file LoaderTest.php, class Console_LoaderTest
top

d

$didSomething
in file ApplicationTest.php, variable TestApplication::$didSomething
$disablePcntl
in file AbstractTest.php, variable Console_Application_Concrete::$disablePcntl
doLoopCycle
in file Abstract.php, method Console_Deamon_Abstract::doLoopCycle()
    You need to implement this method with your loop code.
top

e

echoMsg
in file Abstract.php, method Console_Application_Abstract::echoMsg()
    Echoes a string appended with PHP_EOL.
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:
execute
in file Interface.php, method Console_Application_Interface::execute()
    Executes the application object
Enviroment.php
procedural page Enviroment.php
Exception.php
procedural page Exception.php
EnviromentTest.php
procedural page EnviromentTest.php
ExceptionTest.php
procedural page ExceptionTest.php
top

f

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

g

getCallCounter
in file AbstractTest.php, method Console_Application_Concrete::getCallCounter()
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:
getHelpMessage
in file HelloWorldApplication.php, method HelloWorldApplication::getHelpMessage()
getName
in file MissingParameter.php, method Console_Exception_MissingParameter::getName()
getUsage
in file HelloWorldApplication.php, method HelloWorldApplication::getUsage()
getUsage
in file Abstract.php, method Console_Application_Abstract::getUsage()
    Returns a usage string like:
top

h

HelloWorldApplication.php
procedural page HelloWorldApplication.php
HelloWorldApplication
in file HelloWorldApplication.php, class HelloWorldApplication
    Template method class for CLI commands.
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.
isLinux
in file Enviroment.php, method Console_Enviroment::isLinux()
    Returns if the php enviroment os is Linux
isMacOs
in file Enviroment.php, method Console_Enviroment::isMacOs()
    Returns if the php enviroment os is Mac Os
isOs
in file Enviroment.php, method Console_Enviroment::isOs()
    Returns if the php enviromt is of an specific os type.
isPcntlEnabled
in file AbstractTest.php, method Console_Application_Concrete::isPcntlEnabled()
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.
isSapiCli
in file Enviroment.php, method Console_Enviroment::isSapiCli()
isVerbose
in file Abstract.php, method Console_Application_Abstract::isVerbose()
    Returns whether the application object is verbose or not.
isWindows
in file Enviroment.php, method Console_Enviroment::isWindows()
    Returns if the php enviroment os is Winows
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.
LoaderTest.php
procedural page LoaderTest.php
top

m

MissingParameter.php
procedural page MissingParameter.php
main
in file LoaderTest.php, method Console_LoaderTest::main()
    Runs the test methods of this class.
main
in file MissingParameterTest.php, method Console_Exception_MissingParameterTest::main()
    Runs the test methods of this class.
main
in file AbstractTest.php, method Console_Deamon_AbstractTest::main()
    Runs the test methods of this class.
main
in file ExceptionTest.php, method Console_ExceptionTest::main()
    Runs the test methods of this class.
main
in file AbstractTest.php, method Console_Application_AbstractTest::main()
    Runs the test methods of this class.
main
in file ApplicationTest.php, method Console_ApplicationTest::main()
    Runs the test methods of this class.
main
in file EnviromentTest.php, method Console_EnviromentTest::main()
    Runs the test methods of this class.
MissingParameterTest.php
procedural page MissingParameterTest.php
top

n

$name
in file HelloWorldApplication.php, variable HelloWorldApplication::$name
top

o

$onErrorCalled
in file AbstractTest.php, variable Console_Application_Concrete::$onErrorCalled
onBreakLoop
in file Abstract.php, method Console_Deamon_Abstract::onBreakLoop()
    Overwrite this method to hook the moment the internal breakLoop flag is set true by the script.
onError
in file Abstract.php, method Console_Application_Abstract::onError()
    This method is called if in the three followed methods a exception was
onError
in file AbstractTest.php, method Console_Application_Concrete::onError()
onPostLoop
in file Abstract.php, method Console_Deamon_Abstract::onPostLoop()
    Overwrite this method to hook the phase after the loop. This Method is called imediately after self::onBreakLoop(). But before Console_Application_Abstract::tearDown().
onPreLoop
in file Abstract.php, method Console_Deamon_Abstract::onPreLoop()
    Overwrite this method to hook the pre loop phase.
OS_LINIX
in file Enviroment.php, class constant Console_Enviroment::OS_LINIX
OS_MACOS
in file Enviroment.php, class constant Console_Enviroment::OS_MACOS
OS_WINDOWS
in file Enviroment.php, class constant Console_Enviroment::OS_WINDOWS
top

p

PHPUnit_MAIN_METHOD
in file AbstractTest.php, constant PHPUnit_MAIN_METHOD
top

r

$retValFindParams
in file AbstractTest.php, variable Console_Application_Concrete::$retValFindParams
$runCalled
in file AbstractTest.php, variable Console_Application_Concrete::$runCalled
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.
run
in file Abstract.php, method Console_Deamon_Abstract::run()
    Template method from Console_Application_Abstract.
run
in file ApplicationTest.php, method TestApplication::run()
run
in file AbstractTest.php, method Console_Application_Concrete::run()
run
in file HelloWorldApplication.php, method HelloWorldApplication::run()
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.
$setUpCalled
in file AbstractTest.php, variable Console_Application_Concrete::$setUpCalled
$sigHangUpCalled
in file AbstractTest.php, variable Console_Application_Concrete::$sigHangUpCalled
$sigIntCalled
in file AbstractTest.php, variable Console_Application_Concrete::$sigIntCalled
$sigTermCalled
in file AbstractTest.php, variable Console_Application_Concrete::$sigTermCalled
$sleep
in file HelloWorldApplication.php, variable HelloWorldApplication::$sleep
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 AbstractTest.php, method Console_Application_Concrete::setUp()
setUp
in file AbstractTest.php, method Console_Application_AbstractTest::setUp()
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().
setUp
in file LoaderTest.php, method Console_LoaderTest::setUp()
signalHangUp
in file Abstract.php, method Console_Application_Abstract::signalHangUp()
    Signal handler registered by Console_Application_Abstract::registerSignalHandlers().
signalHangUp
in file AbstractTest.php, method Console_Application_Concrete::signalHangUp()
signalInt
in file HelloWorldApplication.php, method HelloWorldApplication::signalInt()
signalInt
in file AbstractTest.php, method Console_Application_Concrete::signalInt()
signalInt
in file Abstract.php, method Console_Deamon_Abstract::signalInt()
    Bind the signal SIG_INT to brek the loop.
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_Deamon_Abstract::signalTerm()
    Bind the signal SIG_TERM to brek the loop.
signalTerm
in file Abstract.php, method Console_Application_Abstract::signalTerm()
    Signal handler registered by Console_Application_Abstract::registerSignalHandlers().
signalTerm
in file AbstractTest.php, method Console_Application_Concrete::signalTerm()
top

t

$tearDownCalled
in file AbstractTest.php, variable Console_Application_Concrete::$tearDownCalled
$thowsExceptionInRun
in file AbstractTest.php, variable Console_Application_Concrete::$thowsExceptionInRun
tearDown
in file AbstractTest.php, method Console_Application_AbstractTest::tearDown()
tearDown
in file ApplicationTest.php, method Console_ApplicationTest::tearDown()
tearDown
in file LoaderTest.php, method Console_LoaderTest::tearDown()
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.
tearDown
in file AbstractTest.php, method Console_Application_Concrete::tearDown()
TestApplication
in file ApplicationTest.php, class TestApplication
    Template method class for CLI commands.
testCallsFindConsoleParmetersHook
in file AbstractTest.php, method Console_Application_AbstractTest::testCallsFindConsoleParmetersHook()
testCallsOnErrorHookByExceptions
in file AbstractTest.php, method Console_Application_AbstractTest::testCallsOnErrorHookByExceptions()
testCallsRunHook
in file AbstractTest.php, method Console_Application_AbstractTest::testCallsRunHook()
testCallsSetUpHook
in file AbstractTest.php, method Console_Application_AbstractTest::testCallsSetUpHook()
testCallsTearDownHook
in file AbstractTest.php, method Console_Application_AbstractTest::testCallsTearDownHook()
testEchoMessage
in file AbstractTest.php, method Console_Application_AbstractTest::testEchoMessage()
testExecutes
in file AbstractTest.php, method Console_Application_AbstractTest::testExecutes()
testExecutesApplicationFromDirecotry
in file ApplicationTest.php, method Console_ApplicationTest::testExecutesApplicationFromDirecotry()
testExitsIfFindConsoleParametersReturnsFalse
in file AbstractTest.php, method Console_Application_AbstractTest::testExitsIfFindConsoleParametersReturnsFalse()
testFileNameIsValid
in file LoaderTest.php, method Console_LoaderTest::testFileNameIsValid()
testGetHelpMessage
in file AbstractTest.php, method Console_Application_AbstractTest::testGetHelpMessage()
testGetUsage
in file AbstractTest.php, method Console_Application_AbstractTest::testGetUsage()
testHandleSignalHup
in file AbstractTest.php, method Console_Application_AbstractTest::testHandleSignalHup()
testHandleSignalInt
in file AbstractTest.php, method Console_Application_AbstractTest::testHandleSignalInt()
testHandleSignalTerm
in file AbstractTest.php, method Console_Application_AbstractTest::testHandleSignalTerm()
testIsFileReadable
in file LoaderTest.php, method Console_LoaderTest::testIsFileReadable()
    Tests that isReadable works
testIsOs
in file EnviromentTest.php, method Console_EnviromentTest::testIsOs()
testIsSapiCli
in file EnviromentTest.php, method Console_EnviromentTest::testIsSapiCli()
testIsVerbose
in file AbstractTest.php, method Console_Application_AbstractTest::testIsVerbose()
testLoadClass
in file LoaderTest.php, method Console_LoaderTest::testLoadClass()
    Tests that a class can be loaded from a well-formed PHP file
testLoadInterface
in file LoaderTest.php, method Console_LoaderTest::testLoadInterface()
testRestorePhpEnviroment
in file AbstractTest.php, method Console_Application_AbstractTest::testRestorePhpEnviroment()
testReturnsExecutedApplication
in file ApplicationTest.php, method Console_ApplicationTest::testReturnsExecutedApplication()
testRunApplication
in file ApplicationTest.php, method Console_ApplicationTest::testRunApplication()
testSetPhpEnviroment
in file AbstractTest.php, method Console_Application_AbstractTest::testSetPhpEnviroment()
testSetsPhpEnviroment
in file ApplicationTest.php, method Console_ApplicationTest::testSetsPhpEnviroment()
testThisShit
in file AbstractTest.php, method Console_Deamon_AbstractTest::testThisShit()
testThrowExcpetionOnCantRegisterSignalHandler
in file AbstractTest.php, method Console_Application_AbstractTest::testThrowExcpetionOnCantRegisterSignalHandler()
testThrowsExceptionOnFileIsNotReadable
in file ApplicationTest.php, method Console_ApplicationTest::testThrowsExceptionOnFileIsNotReadable()
testThrowsExceptionOnLoadedObjectIsNotInstanceOfConsole_Application_Interface
in file ApplicationTest.php, method Console_ApplicationTest::testThrowsExceptionOnLoadedObjectIsNotInstanceOfConsole_Application_Interface()
testThrowsExceptionOnLoadIllegalFilename
in file LoaderTest.php, method Console_LoaderTest::testThrowsExceptionOnLoadIllegalFilename()
    Tests that the security filter catches illegal characters.
testThrowsExceptionOnLoadNotReadableFile
in file LoaderTest.php, method Console_LoaderTest::testThrowsExceptionOnLoadNotReadableFile()
testThrowsExceptionOnRequiredFileDoesNotContainType
in file LoaderTest.php, method Console_LoaderTest::testThrowsExceptionOnRequiredFileDoesNotContainType()
    With type either class or interface is ment!
testTosTring
in file MissingParameterTest.php, method Console_Exception_MissingParameterTest::testTosTring()
    We expect a string like:
testTosTring
in file ExceptionTest.php, method Console_ExceptionTest::testTosTring()
    We expect a string like:
top

_

__construct
in file MissingParameter.php, method Console_Exception_MissingParameter::__construct()
__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 MissingParameter.php, method Console_Exception_MissingParameter::__toString()
__toString
in file Exception.php, method Console_Exception::__toString()
    Formats the excpetion so we can echo it direct to the CLI.
top
Documentation generated on Mon, 17 Aug 2009 15:51:51 +0200 by phpDocumentor 1.4.2