TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Extbase\Scheduler\Task Class Reference
Inheritance diagram for TYPO3\CMS\Extbase\Scheduler\Task:
TYPO3\CMS\Scheduler\Task\AbstractTask

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 TYPO3\CMS\Scheduler\Task\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 ()
 
 getType ()
 

Protected Member Functions

 logException (\Exception $e)
 

Protected Attributes

 $commandIdentifier
 
 $arguments = []
 
 $defaults = []
 
 $objectManager
 
 $commandManager
 
 $taskExecutor
 
- Protected Attributes inherited from TYPO3\CMS\Scheduler\Task\AbstractTask
 $scheduler
 
 $taskUid
 
 $disabled = false
 
 $execution
 
 $executionTime = 0
 
 $description = ''
 
 $taskGroup
 

Additional Inherited Members

- Public Attributes inherited from TYPO3\CMS\Scheduler\Task\AbstractTask
const TYPE_SINGLE = 1
 
const TYPE_RECURRING = 2
 

Detailed Description

Scheduler task to execute CommandController commands

Definition at line 20 of file Task.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extbase\Scheduler\Task::__construct ( )

Instantiates the Object Manager

Definition at line 55 of file Task.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

◆ __sleep()

TYPO3\CMS\Extbase\Scheduler\Task::__sleep ( )

Sleep

Returns
array Properties to serialize

Definition at line 68 of file Task.php.

◆ __wakeup()

TYPO3\CMS\Extbase\Scheduler\Task::__wakeup ( )

Wakeup

Returns
void

Definition at line 82 of file Task.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ addDefaultValue()

TYPO3\CMS\Extbase\Scheduler\Task::addDefaultValue (   $argumentName,
  $argumentValue 
)
Parameters
string$argumentName
mixed$argumentValue

Definition at line 159 of file Task.php.

◆ execute()

TYPO3\CMS\Extbase\Scheduler\Task::execute ( )

Function execute from the Scheduler

Returns
bool TRUE on successful execution
Exceptions

Definition at line 95 of file Task.php.

References TYPO3\CMS\Extbase\Scheduler\Task\logException().

◆ getAdditionalInformation()

TYPO3\CMS\Extbase\Scheduler\Task::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 TYPO3\CMS\Extbase\Scheduler\Task\$arguments, and TYPO3\CMS\Extbase\Scheduler\Task\$commandIdentifier.

◆ getArguments()

TYPO3\CMS\Extbase\Scheduler\Task::getArguments ( )
Returns
array

Definition at line 134 of file Task.php.

References TYPO3\CMS\Extbase\Scheduler\Task\$arguments.

◆ getCommandIdentifier()

TYPO3\CMS\Extbase\Scheduler\Task::getCommandIdentifier ( )
Returns
string

Definition at line 118 of file Task.php.

References TYPO3\CMS\Extbase\Scheduler\Task\$commandIdentifier.

◆ getDefaults()

TYPO3\CMS\Extbase\Scheduler\Task::getDefaults ( )
Returns
array

Definition at line 150 of file Task.php.

References TYPO3\CMS\Extbase\Scheduler\Task\$defaults.

◆ logException()

TYPO3\CMS\Extbase\Scheduler\Task::logException ( \Exception  $e)
protected

◆ setArguments()

TYPO3\CMS\Extbase\Scheduler\Task::setArguments (   $arguments)
Parameters
array$arguments

Definition at line 126 of file Task.php.

References TYPO3\CMS\Extbase\Scheduler\Task\$arguments.

◆ setCommandIdentifier()

TYPO3\CMS\Extbase\Scheduler\Task::setCommandIdentifier (   $commandIdentifier)
Parameters
string$commandIdentifier

Definition at line 110 of file Task.php.

References TYPO3\CMS\Extbase\Scheduler\Task\$commandIdentifier.

◆ setDefaults()

TYPO3\CMS\Extbase\Scheduler\Task::setDefaults ( array  $defaults)
Parameters
array$defaults

Definition at line 142 of file Task.php.

References TYPO3\CMS\Extbase\Scheduler\Task\$defaults.

Member Data Documentation

◆ $arguments

TYPO3\CMS\Extbase\Scheduler\Task::$arguments = []
protected

◆ $commandIdentifier

◆ $commandManager

TYPO3\CMS\Extbase\Scheduler\Task::$commandManager
protected

Definition at line 45 of file Task.php.

◆ $defaults

TYPO3\CMS\Extbase\Scheduler\Task::$defaults = []
protected

◆ $objectManager

TYPO3\CMS\Extbase\Scheduler\Task::$objectManager
protected

Definition at line 40 of file Task.php.

◆ $taskExecutor

TYPO3\CMS\Extbase\Scheduler\Task::$taskExecutor
protected

Definition at line 50 of file Task.php.