Docs For Class jCmdlineCoordinator

Description

The command line version of jCoordinator

This allows us to handle exit code of commands properly

Located in /core/jCmdlineCoordinator.class.php (line 19)

jCoordinator
   |
   --jCmdlineCoordinator

Variable Summary

mixed $allErrorMessages

Method Summary

jCmdlineCoordinator __construct ( $configFile, [ $enableErrorHandler = true])

void handleError (string $type, integer $code, string $message, string $file, integer $line, array $trace)

void process ([jRequestCmdline $request = null])

void setRequest ( $request)

Variables

mixed $allErrorMessages = array() (line 46)

access: public

Inherited Variables

Inherited from jCoordinator

jCoordinator::$action
jCoordinator::$actionName
jCoordinator::$errorMessage
jCoordinator::$moduleName
jCoordinator::$originalAction
jCoordinator::$plugins
jCoordinator::$request
jCoordinator::$response

Methods

Constructor __construct (line 21)

jCmdlineCoordinator __construct ( $configFile, [ $enableErrorHandler = true])

$configFile
$enableErrorHandler

Redefinition of:

jCoordinator::__construct()

handleError (line 58)

Handle an error event. Called by error handler and exception handler.

since: 1.1
access: public

void handleError (string $type, integer $code, string $message, string $file, integer $line, array $trace)

string $type: error type : 'error', 'warning', 'notice'
integer $code: error code
string $message: error message
string $file: the file name where the error appear
integer $line: the line number where the error appear
array $trace: the stack trace

Redefinition of:

jCoordinator::handleError(): Handle an error event. Called by error handler and exception handler.

process (line 41)

main method : launch the execution of the action.

This method should be called in a Command line entry point.

access: public

void process ([jRequestCmdline $request = null])

jRequestCmdline $request: the command line request object

Redefinition of:

jCoordinator::process(): main method : launch the execution of the action.

setRequest (line 30)

access: protected

void setRequest ( $request)

$request

Redefinition of:

jCoordinator::setRequest(): initialize the given request and some properties of the coordinator

Inherited Methods

Inherited From jCoordinator

jCoordinator::__construct()
jCoordinator::errorHandler()
jCoordinator::exceptionHandler()
jCoordinator::execOriginalAction()
jCoordinator::getController()
jCoordinator::getErrorMessage()
jCoordinator::getGenericErrorMessage()
jCoordinator::getPlugin()
jCoordinator::handleError()
jCoordinator::isPluginEnabled()
jCoordinator::process()
jCoordinator::setRequest()