‪TYPO3CMS  ‪main
TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask Class Reference
Inheritance diagram for TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask:
TYPO3\CMS\Scheduler\Task\AbstractTask

Public Member Functions

 setCommandIdentifier (string $commandIdentifier)
 
 getCommandIdentifier ()
 
bool execute ()
 
string getAdditionalInformation ()
 
 getArguments ()
 
 setArguments (array $arguments)
 
 getOptions ()
 
 setOptions (array $options)
 
 getOptionValues ()
 
 setOptionValues (array $optionValues)
 
 addDefaultValue (string $argumentName, $argumentValue)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Scheduler\Task\AbstractTask
 __construct ()
 
 setTaskUid ($id)
 
int getTaskUid ()
 
string getTaskTitle ()
 
string getTaskDescription ()
 
string getTaskClassName ()
 
bool isDisabled ()
 
 setDisabled ($flag)
 
 setRunOnNextCronJob ($flag)
 
bool getRunOnNextCronJob ()
 
 setExecutionTime ($timestamp)
 
int null 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 object null getExecution ()
 
int getNextDueExecution ()
 
bool areMultipleExecutionsAllowed ()
 
bool save ()
 
 stop ()
 
int getType ()
 

Protected Attributes

string $commandIdentifier = ''
 
array $arguments = array( )
 
array $options = array( )
 
array $optionValues = array( )
 
array $defaults = array( )
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Scheduler\Task\AbstractTask
TYPO3 CMS Scheduler Scheduler null $scheduler
 
int $taskUid = 0
 
bool $disabled = false
 
bool $runOnNextCronJob = false
 
Execution $execution
 
int $executionTime = 0
 
string $description = ''
 
int null $taskGroup = 0
 

Private Member Functions

 getParameters (bool $forDisplay)
 

Additional Inherited Members

- ‪Public Attributes inherited from ‪TYPO3\CMS\Scheduler\Task\AbstractTask
const TYPE_SINGLE = 1
 
const TYPE_RECURRING = 2
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Scheduler\Task\AbstractTask
 logException (\Exception $e)
 
 getLanguageService ()
 

Detailed Description

This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.

Definition at line 31 of file ExecuteSchedulableCommandTask.php.

Member Function Documentation

◆ addDefaultValue()

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

Definition at line 173 of file ExecuteSchedulableCommandTask.php.

◆ execute()

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

This is the main method that is called when a task is executed It MUST be implemented by all classes inheriting from this one Note that there is no error handling, errors and failures are expected to be handled and logged by the client implementations. Should return TRUE on successful execution, FALSE on error.

Exceptions

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

Definition at line 74 of file ExecuteSchedulableCommandTask.php.

References $output, TYPO3\CMS\Scheduler\Task\AbstractTask\getLanguageService(), and TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask\getParameters().

◆ getAdditionalInformation()

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

◆ getArguments()

TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask::getArguments ( )

◆ getCommandIdentifier()

TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask::getCommandIdentifier ( )

◆ getOptions()

TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask::getOptions ( )

◆ getOptionValues()

TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask::getOptionValues ( )

◆ getParameters()

TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask::getParameters ( bool  $forDisplay)
private

◆ setArguments()

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

◆ setCommandIdentifier()

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

◆ setOptions()

TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask::setOptions ( array  $options)

◆ setOptionValues()

TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask::setOptionValues ( array  $optionValues)

Member Data Documentation

◆ $arguments

◆ $commandIdentifier

◆ $defaults

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

Definition at line 51 of file ExecuteSchedulableCommandTask.php.

◆ $options

◆ $optionValues

array TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask::$optionValues = array( )
protected