TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FieldProvider Class Reference
Inheritance diagram for FieldProvider:
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 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 20 of file FieldProvider.php.

Constructor & Destructor Documentation

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

References FieldProvider\$commandManager, FieldProvider\$objectManager, and FieldProvider\$reflectionService.

Member Function Documentation

getActionLabel ( )
protected

Get a human-readable label for the action field

Returns
string

Definition at line 278 of file FieldProvider.php.

References FieldProvider\getLanguageLabel().

Referenced by FieldProvider\getCommandControllerActionField().

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

References FieldProvider\$task, FieldProvider\getCommandControllerActionArgumentFields(), FieldProvider\getCommandControllerActionDescriptionField(), and FieldProvider\getCommandControllerActionField().

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

References FieldProvider\getLanguageLabel().

Referenced by FieldProvider\getCommandControllerActionArgumentFields().

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

Referenced by FieldProvider\getDefaultArgumentValue(), and FieldProvider\renderField().

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

References FieldProvider\getArgumentLabel(), FieldProvider\getDefaultArgumentValue(), and FieldProvider\renderField().

Referenced by FieldProvider\getAdditionalFields().

getCommandControllerActionDescriptionField ( )
protected

Get description of selected command

Returns
string

Definition at line 114 of file FieldProvider.php.

Referenced by FieldProvider\getAdditionalFields().

getCommandControllerActionField ( )
protected

Gets a select field containing all possible CommandController actions

Returns
array

Definition at line 128 of file FieldProvider.php.

References FieldProvider\getActionLabel(), and FieldProvider\renderSelectField().

Referenced by FieldProvider\getAdditionalFields().

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

References FieldProvider\getArgumentType().

Referenced by FieldProvider\getCommandControllerActionArgumentFields().

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

Referenced by FieldProvider\getActionLabel(), and FieldProvider\getArgumentLabel().

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

References FieldProvider\getArgumentType().

Referenced by FieldProvider\getCommandControllerActionArgumentFields().

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

Referenced by FieldProvider\getCommandControllerActionField().

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

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

Member Data Documentation

$commandManager
protected

Definition at line 25 of file FieldProvider.php.

Referenced by FieldProvider\__construct().

$objectManager
protected

Definition at line 30 of file FieldProvider.php.

Referenced by FieldProvider\__construct().

$reflectionService
protected

Definition at line 35 of file FieldProvider.php.

Referenced by FieldProvider\__construct().

$task
protected

Definition at line 40 of file FieldProvider.php.

Referenced by FieldProvider\getAdditionalFields().