Functions
	CITask\statusUndefined ()
	CITask\statusRunning ()
	CITask\statusDone ()
	CITask\statusPBCT ()
	CITask\statusPBC ()
	CITask\statusSkipped ()
	CITask\statusError ()
	CITask\statusConfigError ()
	CITask\setStatus ($status)
	CITask\setStatusUndefined ()
	CITask\setStatusRunning ()
	CITask\setStatusDone ()
	CITask\setStatusPBCT ()
	CITask\setStatusPBC ()
	CITask\setStatusSkipped ()
	CITask\setStatusError ()
	CITask\setStatusConfigError ()
Variables
const	CITask\STATUS_UNDEFINED = 0
	Undefined. Default unless task changes it.
const	CITask\STATUS_RUNNING = 1
	Undefined, but indicates that the task is in progress.
const	CITask\STATUS_DONE = 5
	Success! This means the task completed successfully.
const	CITask\STATUS_PBCT = 6
	There were problems, but the task may continue.
const	CITask\STATUS_PBC = 7
	There were problems, but subsequent task may continue.
const	CITask\STATUS_ERROR = 10
	An error occurred. Abort execution as soon as possible.
const	CITask\STATUS_CONFIG_ERROR = 11
	If a config option was not valid.
const	CITask\STATUS_SKIPPED = 15
	If task was skipped.

Function Documentation

CITask::setStatus ( $ status ) [protected]

Updates the task's current status to $status. See CITask const definitions about valid task states.

Returns 'true' if status is good and task shall continue, and 'false' if a negative state was set, and task execution shall abort.

Return values:

boolean 'false' if task was set to a negative/faulty/unsuccessful status, such as STATUS_ERROR or STATUS_CONFIG_ERROR. 'true' for all other states.

CITask::setStatusConfigError ( ) [protected]

Set task status to STATUS_CONFIG_ERROR

See also:: setStatus()

CITask::setStatusDone ( ) [protected]

Set task status to STATUS_DONE

See also:: setStatus()

CITask::setStatusError ( ) [protected]

Set task status to STATUS_ERROR

See also:: setStatus()

CITask::setStatusPBC ( ) [protected]

Set task status to STATUS_PBC

See also:: setStatus()

CITask::setStatusPBCT ( ) [protected]

Set task status to STATUS_PBCT

See also:: setStatus()

CITask::setStatusRunning ( ) [protected]

Set task status to STATUS_RUNNING

See also:: setStatus()

CITask::setStatusSkipped ( ) [protected]

Set task status to STATUS_SKIPPED

See also:: setStatus()

CITask::setStatusUndefined ( ) [protected]

Set task status to STATUS_UNDEFINED

See also:: setStatus()

CITask::statusConfigError ( )

Queries the task's status.

Return values:

boolean 'true' if task status is STATUS_CONFIG_ERROR, 'false' if not.

CITask::statusDone ( )

Queries the task's status.

Return values:

boolean 'true' if task status is STATUS_DONE, 'false' if not.

CITask::statusError ( )

Queries the task's status.

Return values:

boolean 'true' if task status is STATUS_ERROR, 'false' if not.

CITask::statusPBC ( )

Queries the task's status.

Return values:

boolean 'true' if task status is STATUS_PBC, 'false' if not.

CITask::statusPBCT ( )

Queries the task's status.

Return values:

boolean 'true' if task status is STATUS_PBCT, 'false' if not.

CITask::statusRunning ( )

Queries the task's status.

Return values:

boolean 'true' if task status is STATUS_RUNNING, 'false' if not.

CITask::statusSkipped ( )

Queries the task's status.

Return values:

boolean 'true' if task status is STATUS_SKIPPED, 'false' if not.

CITask::statusUndefined ( )

Queries the task's status.

Return values:

boolean 'true' if task status is STATUS_UNDEFINED, 'false' if not.

Functions

Variables

Function Documentation