TYPO3\CMS\Extbase\Scheduler\FieldProvider Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Scheduler\FieldProvider:

Public Member Functions
	__construct (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager=null, \TYPO3\CMS\Extbase\Mvc\Cli\CommandManager $commandManager=null, \TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService=null)
array	getAdditionalFields (array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
bool	validateAdditionalFields (array &$submittedData, SchedulerModuleController $schedulerModule)
bool	saveAdditionalFields (array $submittedData, AbstractTask $task)
‪Public Member Functions inherited from ‪TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface
array	getAdditionalFields (array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule)
bool	validateAdditionalFields (array &$submittedData, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule)
	saveAdditionalFields (array $submittedData, \TYPO3\CMS\Scheduler\Task\AbstractTask $task)

Protected Member Functions
array	getCommandControllerActionDescriptionField ()
array	getCommandControllerActionField ()
array	getCommandControllerActionArgumentFields (array $argumentDefinitions)
string	getLanguageLabel ($localLanguageKey, $extensionName=null)
string	getArgumentType (\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument)
string	getArgumentLabel (\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument)
mixed	getDefaultArgumentValue (\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument)
string	getActionLabel ()
string	renderSelectField ($name, array $options, $selectedOptionValue)
string	renderField (\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument, $currentValue)

Protected Attributes
TYPO3 CMS Extbase Mvc Cli CommandManager	$commandManager
TYPO3 CMS Extbase Object ObjectManagerInterface	$objectManager
TYPO3 CMS Extbase Reflection ReflectionService	$reflectionService
TYPO3 CMS Extbase Scheduler Task	$task

Detailed Description

Field provider for Extbase CommandController Scheduler task

Deprecated:

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

Definition at line 26 of file FieldProvider.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extbase\Scheduler\FieldProvider::__construct	(	\TYPO3\CMS\Extbase\Object\ObjectManagerInterface	$objectManager = null,
		\TYPO3\CMS\Extbase\Mvc\Cli\CommandManager	$commandManager = null,
		\TYPO3\CMS\Extbase\Reflection\ReflectionService	$reflectionService = null
	)

Constructor

Parameters

\TYPO3\CMS\Extbase\Object\ObjectManagerInterface	$objectManager
\TYPO3\CMS\Extbase\Mvc\Cli\CommandManager	$commandManager
\TYPO3\CMS\Extbase\Reflection\ReflectionService	$reflectionService

Definition at line 51 of file FieldProvider.php.

References TYPO3\CMS\Extbase\Scheduler\FieldProvider\$commandManager, TYPO3\CMS\Extbase\Scheduler\FieldProvider\$objectManager, and TYPO3\CMS\Extbase\Scheduler\FieldProvider\$reflectionService.

Member Function Documentation

getActionLabel()

string TYPO3\CMS\Extbase\Scheduler\FieldProvider::getActionLabel ( )

protected

Get a human-readable label for the action field

Returns

‪string

Definition at line 281 of file FieldProvider.php.

References TYPO3\CMS\Extbase\Scheduler\FieldProvider\getLanguageLabel().

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

getAdditionalFields()

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

Render additional information fields within the scheduler backend.

Parameters

array	&$taskInfo	‪Array information of task to return
AbstractTask | 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\AdditionalFieldProvidergetAdditionalFields($taskInfo, $task, $schedulerModule)

Definition at line 67 of file FieldProvider.php.

References $fields, TYPO3\CMS\Extbase\Scheduler\FieldProvider\$task, TYPO3\CMS\Extbase\Scheduler\FieldProvider\getCommandControllerActionArgumentFields(), TYPO3\CMS\Extbase\Scheduler\FieldProvider\getCommandControllerActionDescriptionField(), TYPO3\CMS\Extbase\Scheduler\FieldProvider\getCommandControllerActionField(), and TYPO3\CMS\Scheduler\Task\AbstractTask\setScheduler().

getArgumentLabel()

string TYPO3\CMS\Extbase\Scheduler\FieldProvider::getArgumentLabel ( \TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition  $argument )

protected

Get a human-readable label for a command argument

Parameters

\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition

$argument

Returns

‪string

Definition at line 232 of file FieldProvider.php.

References TYPO3\CMS\Extbase\Scheduler\FieldProvider\getLanguageLabel().

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

getArgumentType()

string TYPO3\CMS\Extbase\Scheduler\FieldProvider::getArgumentType ( \TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition  $argument )

protected

Gets the data type required for the argument value

Parameters

\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition

$argument

Returns

‪string the argument type

Definition at line 208 of file FieldProvider.php.

Referenced by TYPO3\CMS\Extbase\Scheduler\FieldProvider\getDefaultArgumentValue(), and TYPO3\CMS\Extbase\Scheduler\FieldProvider\renderField().

getCommandControllerActionArgumentFields()

array TYPO3\CMS\Extbase\Scheduler\FieldProvider::getCommandControllerActionArgumentFields ( array  $argumentDefinitions )

protected

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

Parameters

array

$argumentDefinitions

Returns

‪array

Definition at line 168 of file FieldProvider.php.

References $fields, TYPO3\CMS\Extbase\Scheduler\FieldProvider\getArgumentLabel(), TYPO3\CMS\Extbase\Scheduler\FieldProvider\getDefaultArgumentValue(), and TYPO3\CMS\Extbase\Scheduler\FieldProvider\renderField().

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

getCommandControllerActionDescriptionField()

array TYPO3\CMS\Extbase\Scheduler\FieldProvider::getCommandControllerActionDescriptionField ( )

protected

Get description of selected command

Returns

‪array

Definition at line 116 of file FieldProvider.php.

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

getCommandControllerActionField()

array TYPO3\CMS\Extbase\Scheduler\FieldProvider::getCommandControllerActionField ( )

protected

Gets a select field containing all possible CommandController actions

Returns

‪array

Definition at line 130 of file FieldProvider.php.

References TYPO3\CMS\Extbase\Scheduler\FieldProvider\getActionLabel(), and TYPO3\CMS\Extbase\Scheduler\FieldProvider\renderSelectField().

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

getDefaultArgumentValue()

mixed TYPO3\CMS\Extbase\Scheduler\FieldProvider::getDefaultArgumentValue ( \TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition  $argument )

protected

Gets the default value of argument

Parameters

\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition

$argument

Returns

‪mixed

Definition at line 259 of file FieldProvider.php.

References TYPO3\CMS\Extbase\Scheduler\FieldProvider\getArgumentType(), and TYPO3\CMS\Extbase\Utility\TypeHandlingUtility\normalizeType().

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

getLanguageLabel()

string TYPO3\CMS\Extbase\Scheduler\FieldProvider::getLanguageLabel (   $localLanguageKey,   $extensionName = null  )

protected

Gets a label for $key based on either provided extension or currently selected CommandController extension,´

Parameters

string	$localLanguageKey
string	$extensionName

Returns

‪string

Definition at line 193 of file FieldProvider.php.

References TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\Extbase\Scheduler\FieldProvider\getActionLabel(), and TYPO3\CMS\Extbase\Scheduler\FieldProvider\getArgumentLabel().

renderField()

string TYPO3\CMS\Extbase\Scheduler\FieldProvider::renderField ( \TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition  $argument,   $currentValue  )

protected

Renders a field for defining an argument's value

Parameters

\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition	$argument
mixed	$currentValue

Returns

‪string

Definition at line 319 of file FieldProvider.php.

References TYPO3\CMS\Extbase\Scheduler\FieldProvider\getArgumentType(), and TYPO3\CMS\Extbase\Utility\TypeHandlingUtility\normalizeType().

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

renderSelectField()

string TYPO3\CMS\Extbase\Scheduler\FieldProvider::renderSelectField (   $name, array  $options,   $selectedOptionValue  )

protected

Render a select field with name $name and options $options

Parameters

string	$name
array	$options
string	$selectedOptionValue

Returns

‪string

Definition at line 299 of file FieldProvider.php.

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

saveAdditionalFields()

bool TYPO3\CMS\Extbase\Scheduler\FieldProvider::saveAdditionalFields	(	array	$submittedData,
		AbstractTask	$task
	)

Saves additional field values

Parameters

array	$submittedData
AbstractTask	$task

Returns

‪bool

Definition at line 104 of file FieldProvider.php.

References TYPO3\CMS\Extbase\Scheduler\FieldProvider\$task, TYPO3\CMS\Extbase\Scheduler\Task\setArguments(), and TYPO3\CMS\Extbase\Scheduler\Task\setCommandIdentifier().

validateAdditionalFields()

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

Validates additional selected fields

Parameters

array	&$submittedData
SchedulerModuleController	$schedulerModule

Returns

‪bool

Definition at line 92 of file FieldProvider.php.

Member Data Documentation

$commandManager

TYPO3 CMS Extbase Mvc Cli CommandManager TYPO3\CMS\Extbase\Scheduler\FieldProvider::$commandManager

protected

Definition at line 30 of file FieldProvider.php.

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

$objectManager

TYPO3 CMS Extbase Object ObjectManagerInterface TYPO3\CMS\Extbase\Scheduler\FieldProvider::$objectManager

protected

Definition at line 34 of file FieldProvider.php.

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

$reflectionService

TYPO3 CMS Extbase Reflection ReflectionService TYPO3\CMS\Extbase\Scheduler\FieldProvider::$reflectionService

protected

Definition at line 38 of file FieldProvider.php.

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

$task

TYPO3 CMS Extbase Scheduler Task TYPO3\CMS\Extbase\Scheduler\FieldProvider::$task

protected

Definition at line 42 of file FieldProvider.php.

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