Inheritance diagram for TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider:

Public Member Functions
	__construct ()

array	getAdditionalFields (array &$taskInfo, $task, SchedulerModuleController $schedulerModule)

bool	validateAdditionalFields (array &$submittedData, SchedulerModuleController $schedulerModule)

bool	saveAdditionalFields (array $submittedData, AbstractTask $task)

LanguageService	getLanguageService ()

Protected Member Functions
array	getCommandDescriptionField (string $description)

array	getSchedulableCommandsField ()

array	getCommandArgumentFields (InputDefinition $inputDefinition)

array	getCommandOptionFields (InputDefinition $inputDefinition)

string	getArgumentLabel (InputArgument $argument)

string	getOptionLabel (InputOption $option)

string	renderSelectField (array $options, string $selectedOptionValue)

string	renderArgumentField (InputArgument $argument, string $currentValue)

string	renderOptionField (InputOption $option, bool $enabled, string $currentValue)

Protected Attributes
Command[]	$schedulableCommands = array( )

ExecuteSchedulableCommandTask null	$task

Detailed Description

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

Definition at line 37 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 47 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

Member Function Documentation

◆ getAdditionalFields()

array TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::getAdditionalFields	(	array &	$taskInfo,
			$task,
		SchedulerModuleController	$schedulerModule
	)

Render additional information fields within the scheduler backend.

Parameters

array	$taskInfo	‪Array information of task to return
ExecuteSchedulableCommandTask \| null	$task	‪When editing, reference to the current task. NULL when adding.
SchedulerModuleController	$schedulerModule	‪Reference to the calling object (BE module of the Scheduler)

Returns: ‪array Additional fields

See also: ‪\TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface::getAdditionalFields

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 66 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

References $fields, TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\$task, TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getCommandArgumentFields(), TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getCommandDescriptionField(), TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getCommandOptionFields(), TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getSchedulableCommandsField(), and TYPO3\CMS\Scheduler\Task\AbstractTask\setScheduler().

◆ getArgumentLabel()

string TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::getArgumentLabel ( InputArgument $argument )

protected

Get a human-readable label for a command argument

Parameters

InputArgument $argument

Returns: ‪string

Definition at line 323 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getCommandArgumentFields().

◆ getCommandArgumentFields()

array TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::getCommandArgumentFields ( InputDefinition $inputDefinition )

protected

Gets a set of fields covering arguments which can or must be used. Also registers the default values of those fields with the Task, allowing them to be read upon execution.

Parameters

InputDefinition $inputDefinition

Returns: ‪array

Definition at line 261 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

References $fields, TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getArgumentLabel(), and TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\renderArgumentField().

Referenced by TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getAdditionalFields().

◆ getCommandDescriptionField()

array TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::getCommandDescriptionField ( string $description )

protected

Get description of selected command

Parameters

string $description

Returns: ‪array

Definition at line 227 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getAdditionalFields().

◆ getCommandOptionFields()

array TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::getCommandOptionFields ( InputDefinition $inputDefinition )

protected

Gets a set of fields covering options which can or must be used. Also registers the default values of those fields with the Task, allowing them to be read upon execution.

Parameters

InputDefinition $inputDefinition

Returns: ‪array

Definition at line 292 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

References $fields, TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getOptionLabel(), and TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\renderOptionField().

Referenced by TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getAdditionalFields().

◆ getLanguageService()

LanguageService TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::getLanguageService ( )

Returns: ‪LanguageService

Definition at line 439 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getSchedulableCommandsField(), TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\renderOptionField(), and TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\validateAdditionalFields().

◆ getOptionLabel()

string TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::getOptionLabel ( InputOption $option )

protected

Get a human-readable label for a command option

Parameters

InputOption $option

Returns: ‪string

Definition at line 334 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getCommandOptionFields().

◆ getSchedulableCommandsField()

array TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::getSchedulableCommandsField ( )

protected

Gets a select field containing all possible schedulable commands

Returns: ‪array

Definition at line 240 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getLanguageService(), TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\renderSelectField(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

Referenced by TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getAdditionalFields().

◆ renderArgumentField()

string TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::renderArgumentField	(	InputArgument	$argument,
		string	$currentValue
	)

protected

Renders a field for defining an argument's value

Parameters

InputArgument	$argument
string	$currentValue

Returns: ‪string

Definition at line 380 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getCommandArgumentFields().

◆ renderOptionField()

string TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::renderOptionField	(	InputOption	$option,
		bool	$enabled,
		string	$currentValue
	)

protected

Renders a field for defining an option's value

Parameters

InputOption	$option
bool	$enabled
string	$currentValue

Returns: ‪string

Definition at line 403 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

Referenced by TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getCommandOptionFields().

◆ renderSelectField()

string TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::renderSelectField	(	array	$options,
		string	$selectedOptionValue
	)

protected

Parameters

array	$options
string	$selectedOptionValue

Returns: ‪string

Definition at line 344 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\getSchedulableCommandsField().

◆ saveAdditionalFields()

bool TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::saveAdditionalFields	(	array	$submittedData,
		AbstractTask	$task
	)

Saves additional field values

Parameters

array	$submittedData
ExecuteSchedulableCommandTask	$task

Returns: ‪bool

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 172 of file ExecuteSchedulableCommandAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider\$task, TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask\setArguments(), TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask\setCommandIdentifier(), TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask\setOptions(), TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask\setOptionValues(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ validateAdditionalFields()

bool TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider::validateAdditionalFields	(	array &	$submittedData,
		SchedulerModuleController	$schedulerModule
	)