TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Extbase\Scheduler\FieldProvider Class Reference
Inheritance diagram for TYPO3\CMS\Extbase\Scheduler\FieldProvider:
TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface

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)
 
 getAdditionalFields (array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule)
 
 validateAdditionalFields (array &$submittedData, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule)
 
 saveAdditionalFields (array $submittedData, \TYPO3\CMS\Scheduler\Task\AbstractTask $task)
 
- Public Member Functions inherited from TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface
 getAdditionalFields (array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule)
 
 validateAdditionalFields (array &$submittedData, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule)
 
 saveAdditionalFields (array $submittedData, \TYPO3\CMS\Scheduler\Task\AbstractTask $task)
 

Protected Member Functions

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

Protected Attributes

 $commandManager
 
 $objectManager
 
 $reflectionService
 
 $task
 

Detailed Description

Field provider for Extbase CommandController Scheduler task

Definition at line 22 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, TYPO3\CMS\Extbase\Scheduler\FieldProvider\$reflectionService, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

◆ getActionLabel()

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

Get a human-readable label for the action field

Returns
string

Definition at line 280 of file FieldProvider.php.

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

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

◆ getAdditionalFields()

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

Render additional information fields within the scheduler backend.

Parameters
array&$taskInfoArray information of task to return
mixed$taskor instance
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$schedulerModuleReference to the calling object (BE module of the Scheduler)
Returns
array Additional fields
See also
getAdditionalFields($taskInfo, $task, $schedulerModule)

Definition at line 67 of file FieldProvider.php.

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

◆ getArgumentLabel()

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 235 of file FieldProvider.php.

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

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

◆ getArgumentType()

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 214 of file FieldProvider.php.

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

◆ getCommandControllerActionArgumentFields()

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 174 of file FieldProvider.php.

References 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()

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

Get description of selected command

Returns
string

Definition at line 116 of file FieldProvider.php.

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

◆ getCommandControllerActionField()

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()

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 262 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()

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 199 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()

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 318 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()

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 298 of file FieldProvider.php.

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

◆ saveAdditionalFields()

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

Saves additional field values

Parameters
array$submittedData
\TYPO3\CMS\Scheduler\Task\AbstractTask$task
Returns
bool

Definition at line 104 of file FieldProvider.php.

◆ validateAdditionalFields()

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

Validates additional selected fields

Parameters
array&$submittedData
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$schedulerModule
Returns
bool

Definition at line 92 of file FieldProvider.php.

Member Data Documentation

◆ $commandManager

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

◆ $objectManager

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

◆ $reflectionService

TYPO3\CMS\Extbase\Scheduler\FieldProvider::$reflectionService
protected

◆ $task

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