‪TYPO3CMS  9.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Extbase\Scheduler\Task Class Reference
Inheritance diagram for TYPO3\CMS\Extbase\Scheduler\Task:
TYPO3\CMS\Scheduler\Task\AbstractTask

Public Member Functions

 __construct ()
 
array __sleep ()
 
 __wakeup ()
 
bool execute ()
 
 setCommandIdentifier ($commandIdentifier)
 
string getCommandIdentifier ()
 
 setArguments ($arguments)
 
array getArguments ()
 
 setDefaults (array $defaults)
 
array getDefaults ()
 
 addDefaultValue ($argumentName, $argumentValue)
 
string getAdditionalInformation ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Scheduler\Task\AbstractTask
 setTaskUid ($id)
 
int getTaskUid ()
 
string getTaskTitle ()
 
string getTaskDescription ()
 
string getTaskClassName ()
 
bool isDisabled ()
 
 setDisabled ($flag)
 
 setRunOnNextCronJob ($flag)
 
bool getRunOnNextCronJob ()
 
 setExecutionTime ($timestamp)
 
int getTaskGroup ()
 
 setTaskGroup ($taskGroup)
 
int getExecutionTime ()
 
 setDescription ($description)
 
string getDescription ()
 
 setScheduler ()
 
 unsetScheduler ()
 
 registerSingleExecution ($timestamp)
 
 registerRecurringExecution ($start, $interval, $end=0, $multiple=false, $cron_cmd='')
 
 setExecution (Execution $execution)
 
Execution getExecution ()
 
int getNextDueExecution ()
 
bool areMultipleExecutionsAllowed ()
 
bool isExecutionRunning ()
 
int markExecution ()
 
 unmarkExecution ($executionID, \Throwable $failure=null)
 
bool unmarkAllExecutions ()
 
bool save ()
 
 stop ()
 
 remove ()
 
int getType ()
 

Protected Member Functions

 logException (\Exception $e)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Scheduler\Task\AbstractTask
 logException (\Exception $e)
 

Protected Attributes

string $commandIdentifier
 
array $arguments = array( )
 
array $defaults = array( )
 
TYPO3 CMS Extbase Object ObjectManagerInterface $objectManager
 
CommandManager $commandManager
 
TaskExecutor $taskExecutor
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Scheduler\Task\AbstractTask
TYPO3 CMS Scheduler Scheduler $scheduler
 
int $taskUid
 
bool $disabled = false
 
bool $runOnNextCronJob = false
 
Execution $execution
 
int $executionTime = 0
 
string $description = ''
 
int $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

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0. Use symfony/console commands instead.

Definition at line 27 of file Task.php.

Constructor & Destructor Documentation

◆ __construct()

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

Instantiates the Object Manager

Reimplemented from TYPO3\CMS\Scheduler\Task\AbstractTask.

Definition at line 56 of file Task.php.

Member Function Documentation

◆ __sleep()

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

Sleep

Returns
‪array Properties to serialize

Definition at line 69 of file Task.php.

◆ __wakeup()

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

Wakeup

Definition at line 84 of file Task.php.

◆ addDefaultValue()

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

Definition at line 162 of file Task.php.

◆ execute()

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

Function execute from the Scheduler

Returns
‪bool TRUE on successful execution
Exceptions

Reimplemented from TYPO3\CMS\Scheduler\Task\AbstractTask.

Definition at line 98 of file Task.php.

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

◆ getAdditionalInformation()

string TYPO3\CMS\Extbase\Scheduler\Task::getAdditionalInformation ( )

Return a text representation of the selected command and arguments

Returns
‪string Information to display

Reimplemented from TYPO3\CMS\Scheduler\Task\AbstractTask.

Definition at line 175 of file Task.php.

References TYPO3\CMS\Extbase\Scheduler\Task\$arguments, and TYPO3\CMS\Extbase\Scheduler\Task\$commandIdentifier.

◆ getArguments()

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

Definition at line 137 of file Task.php.

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

◆ getCommandIdentifier()

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

Definition at line 121 of file Task.php.

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

◆ getDefaults()

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

Definition at line 153 of file Task.php.

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

◆ logException()

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

Definition at line 193 of file Task.php.

Referenced by TYPO3\CMS\Extbase\Scheduler\Task\execute().

◆ setArguments()

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

Definition at line 129 of file Task.php.

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

Referenced by TYPO3\CMS\Extbase\Scheduler\FieldProvider\saveAdditionalFields().

◆ setCommandIdentifier()

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

Definition at line 113 of file Task.php.

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

Referenced by TYPO3\CMS\Extbase\Scheduler\FieldProvider\saveAdditionalFields().

◆ setDefaults()

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

Definition at line 145 of file Task.php.

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

Member Data Documentation

◆ $arguments

array TYPO3\CMS\Extbase\Scheduler\Task::$arguments = array( )
protected

Definition at line 35 of file Task.php.

Referenced by TYPO3\CMS\Extbase\Scheduler\Task\getAdditionalInformation(), TYPO3\CMS\Extbase\Scheduler\Task\getArguments(), and TYPO3\CMS\Extbase\Scheduler\Task\setArguments().

◆ $commandIdentifier

string TYPO3\CMS\Extbase\Scheduler\Task::$commandIdentifier
protected

Definition at line 31 of file Task.php.

Referenced by TYPO3\CMS\Extbase\Scheduler\Task\getAdditionalInformation(), TYPO3\CMS\Extbase\Scheduler\Task\getCommandIdentifier(), and TYPO3\CMS\Extbase\Scheduler\Task\setCommandIdentifier().

◆ $commandManager

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

Definition at line 47 of file Task.php.

◆ $defaults

array TYPO3\CMS\Extbase\Scheduler\Task::$defaults = array( )
protected

Definition at line 39 of file Task.php.

Referenced by TYPO3\CMS\Extbase\Scheduler\Task\getDefaults(), and TYPO3\CMS\Extbase\Scheduler\Task\setDefaults().

◆ $objectManager

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

Definition at line 43 of file Task.php.

◆ $taskExecutor

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

Definition at line 51 of file Task.php.