Task Class Reference

Inheritance diagram for Task:

Public Member Functions
	__construct ()
	__sleep ()
	__wakeup ()
	execute ()
	setCommandIdentifier ($commandIdentifier)
	getCommandIdentifier ()
	setArguments ($arguments)
	getArguments ()
	setDefaults (array $defaults)
	getDefaults ()
	addDefaultValue ($argumentName, $argumentValue)
	getAdditionalInformation ()
Public Member Functions inherited from AbstractTask
	__construct ()
	execute ()
	getAdditionalInformation ()
	setTaskUid ($id)
	getTaskUid ()
	getTaskTitle ()
	getTaskDescription ()
	getTaskClassName ()
	isDisabled ()
	setDisabled ($flag)
	setExecutionTime ($timestamp)
	getTaskGroup ()
	setTaskGroup ($taskGroup)
	getExecutionTime ()
	setDescription ($description)
	getDescription ()
	setScheduler ()
	unsetScheduler ()
	setExecution (\TYPO3\CMS\Scheduler\Execution $execution)
	getExecution ()
	getNextDueExecution ()
	areMultipleExecutionsAllowed ()
	isExecutionRunning ()
	markExecution ()
	unmarkExecution ($executionID,\Exception $failure=null)
	unmarkAllExecutions ()
	save ()
	stop ()
	remove ()

Protected Member Functions
	logException (\Exception $e)

Protected Attributes
	$commandIdentifier
	$arguments = array()
	$defaults = array()
	$objectManager
	$commandManager
	$taskExecutor
Protected Attributes inherited from AbstractTask
	$scheduler
	$taskUid
	$disabled = false
	$execution
	$executionTime = 0
	$description = ''
	$taskGroup

Detailed Description

Scheduler task to execute CommandController commands

Definition at line 20 of file Task.php.

Constructor & Destructor Documentation

__construct

(

)

Instantiates the Object Manager

Definition at line 55 of file Task.php.

Member Function Documentation

__sleep

(

)

Sleep

Returns

array Properties to serialize

Definition at line 68 of file Task.php.

__wakeup

(

)

Wakeup

Returns

void

Definition at line 82 of file Task.php.

addDefaultValue	(		$argumentName,
			$argumentValue
	)

Parameters

string	$argumentName
mixed	$argumentValue

Definition at line 159 of file Task.php.

execute

(

)

Function execute from the Scheduler

Returns

bool TRUE on successful execution

Exceptions

\Exception

If an error occurs

Definition at line 95 of file Task.php.

References Task\logException().

getAdditionalInformation

(

)

Return a text representation of the selected command and arguments

Returns

string Information to display

Definition at line 172 of file Task.php.

References Task\$arguments, and Task\$commandIdentifier.

getArguments

(

)

Returns

array

Definition at line 134 of file Task.php.

References Task\$arguments.

getCommandIdentifier

(

)

Returns

string

Definition at line 118 of file Task.php.

References Task\$commandIdentifier.

getDefaults

(

)

Returns

array

Definition at line 150 of file Task.php.

References Task\$defaults.

logException ( \Exception  $e )

protected

Parameters

\Exception

$e

Definition at line 190 of file Task.php.

References Task\$commandIdentifier.

Referenced by Task\execute().

setArguments

(

$arguments

)

Parameters

array

$arguments

Definition at line 126 of file Task.php.

References Task\$arguments.

setCommandIdentifier

(

$commandIdentifier

)

Parameters

string

$commandIdentifier

Definition at line 110 of file Task.php.

References Task\$commandIdentifier.

setDefaults

(

array

$defaults

)

Parameters

array

$defaults

Definition at line 142 of file Task.php.

References Task\$defaults.

Member Data Documentation

$arguments = array()

protected

Definition at line 30 of file Task.php.

Referenced by Task\getAdditionalInformation(), Task\getArguments(), and Task\setArguments().

$commandIdentifier

protected

Definition at line 25 of file Task.php.

Referenced by Task\getAdditionalInformation(), Task\getCommandIdentifier(), Task\logException(), and Task\setCommandIdentifier().

$commandManager

protected

Definition at line 45 of file Task.php.

$defaults = array()

protected

Definition at line 35 of file Task.php.

Referenced by Task\getDefaults(), and Task\setDefaults().

$objectManager

protected

Definition at line 40 of file Task.php.

$taskExecutor

protected

Definition at line 50 of file Task.php.