‪TYPO3CMS  10.4
Public Member Functions | List of all members
TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface Interface Reference
Inheritance diagram for TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface:
TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider TYPO3\CMS\Scheduler\Task\FileStorageIndexingAdditionalFieldProvider TYPO3\CMS\Linkvalidator\Task\ValidatorTaskAdditionalFieldProvider TYPO3\CMS\Recycler\Task\CleanerFieldProvider TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField TYPO3\CMS\Scheduler\Example\SleepTaskAdditionalFieldProvider TYPO3\CMS\Scheduler\Example\TestTaskAdditionalFieldProvider TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider TYPO3\CMS\Scheduler\Task\IpAnonymizationAdditionalFieldProvider TYPO3\CMS\Scheduler\Task\OptimizeDatabaseTableAdditionalFieldProvider TYPO3\CMS\Scheduler\Task\RecyclerGarbageCollectionAdditionalFieldProvider TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider

Public Member Functions

array getAdditionalFields (array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
 
bool validateAdditionalFields (array &$submittedData, SchedulerModuleController $schedulerModule)
 
 saveAdditionalFields (array $submittedData, AbstractTask $task)
 

Detailed Description

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

Definition at line 24 of file AdditionalFieldProviderInterface.php.

Member Function Documentation

◆ getAdditionalFields()

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

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

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

Implemented in TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider, TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField, TYPO3\CMS\Linkvalidator\Task\ValidatorTaskAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\RecyclerGarbageCollectionAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\OptimizeDatabaseTableAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider, TYPO3\CMS\Scheduler\Example\SleepTaskAdditionalFieldProvider, TYPO3\CMS\Scheduler\Example\TestTaskAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider, TYPO3\CMS\Recycler\Task\CleanerFieldProvider, TYPO3\CMS\Scheduler\Task\IpAnonymizationAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider, and TYPO3\CMS\Scheduler\Task\FileStorageIndexingAdditionalFieldProvider.

◆ saveAdditionalFields()

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

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

Parameters
array$submittedData‪An array containing the data submitted by the add/edit task form
\TYPO3\CMS\Scheduler\Task\AbstractTask$task‪Reference to the scheduler backend module

Implemented in TYPO3\CMS\Linkvalidator\Task\ValidatorTaskAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\IpAnonymizationAdditionalFieldProvider, TYPO3\CMS\Recycler\Task\CleanerFieldProvider, TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider, TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField, TYPO3\CMS\Scheduler\Task\OptimizeDatabaseTableAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\FileStorageIndexingAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider, TYPO3\CMS\Scheduler\Example\TestTaskAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\RecyclerGarbageCollectionAdditionalFieldProvider, and TYPO3\CMS\Scheduler\Example\SleepTaskAdditionalFieldProvider.

◆ validateAdditionalFields()

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

Validates the additional fields' values

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

Implemented in TYPO3\CMS\Linkvalidator\Task\ValidatorTaskAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\IpAnonymizationAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider, TYPO3\CMS\Recycler\Task\CleanerFieldProvider, TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField, TYPO3\CMS\Scheduler\Task\OptimizeDatabaseTableAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\RecyclerGarbageCollectionAdditionalFieldProvider, TYPO3\CMS\Scheduler\Example\SleepTaskAdditionalFieldProvider, TYPO3\CMS\Scheduler\Example\TestTaskAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider, TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider, and TYPO3\CMS\Scheduler\Task\FileStorageIndexingAdditionalFieldProvider.