TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
AdditionalFieldProviderInterface Interface Reference
Inheritance diagram for AdditionalFieldProviderInterface:
FieldProvider ValidatorTaskAdditionalFieldProvider CleanerFieldProvider SystemStatusUpdateTaskNotificationEmailField BulkUpdateFieldProvider SleepTaskAdditionalFieldProvider TestTaskAdditionalFieldProvider CachingFrameworkGarbageCollectionAdditionalFieldProvider FileStorageExtractionAdditionalFieldProvider FileStorageIndexingAdditionalFieldProvider OptimizeDatabaseTableAdditionalFieldProvider RecyclerGarbageCollectionAdditionalFieldProvider TableGarbageCollectionAdditionalFieldProvider

Public Member Functions

 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)
 

Detailed Description

Interface for classes who want to provide additional fields when adding a task

Definition at line 20 of file AdditionalFieldProviderInterface.php.

Member Function Documentation

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

Gets additional fields to render in the form to add/edit a task

Parameters
array$taskInfoValues of the fields from the add/edit task form
\TYPO3\CMS\Scheduler\Task\AbstractTask$taskThe task object being edited. Null when adding a task!
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$schedulerModuleReference to the scheduler backend module
Returns
array A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))

Implemented in SleepTaskAdditionalFieldProvider, and TestTaskAdditionalFieldProvider.

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

Takes care of saving the additional fields' values in the task's object

Parameters
array$submittedDataAn array containing the data submitted by the add/edit task form
\TYPO3\CMS\Scheduler\Task\AbstractTask$taskReference to the scheduler backend module
Returns
void
validateAdditionalFields ( array &  $submittedData,
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $schedulerModule 
)

Validates the additional fields' values

Parameters
array$submittedDataAn array containing the data submitted by the add/edit task form
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$schedulerModuleReference to the scheduler backend module
Returns
bool TRUE if validation was ok (or selected class is not relevant), FALSE otherwise

Implemented in SleepTaskAdditionalFieldProvider, and TestTaskAdditionalFieldProvider.