TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Scheduler\Example\TestTaskAdditionalFieldProvider Class Reference
Inheritance diagram for TYPO3\CMS\Scheduler\Example\TestTaskAdditionalFieldProvider:
TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface

Public Member Functions

 getAdditionalFields (array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
 
 validateAdditionalFields (array &$submittedData, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
 
 saveAdditionalFields (array $submittedData, \TYPO3\CMS\Scheduler\Task\AbstractTask $task)
 
- Public Member Functions inherited from TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface
 saveAdditionalFields (array $submittedData, \TYPO3\CMS\Scheduler\Task\AbstractTask $task)
 

Detailed Description

Additional fields provider class for usage with the Scheduler's test task

Definition at line 22 of file TestTaskAdditionalFieldProvider.php.

Member Function Documentation

◆ getAdditionalFields()

TYPO3\CMS\Scheduler\Example\TestTaskAdditionalFieldProvider::getAdditionalFields ( array &  $taskInfo,
  $task,
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject 
)

This method is used to define new fields for adding or editing a task In this case, it adds an email field

Parameters
array$taskInfoReference to the array containing the info used in the add/edit form
AbstractTask | NULL$taskWhen editing, reference to the current task. NULL when adding.
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$parentObjectReference to the calling object (Scheduler's BE module)
Returns
array Array containing all the information pertaining to the additional fields

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 33 of file TestTaskAdditionalFieldProvider.php.

References $GLOBALS.

◆ saveAdditionalFields()

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

This method is used to save any additional input into the current task object if the task class matches

Parameters
array$submittedDataArray containing the data submitted by the user
\TYPO3\CMS\Scheduler\Task\AbstractTask$taskReference to the current task object
Returns
void

Definition at line 89 of file TestTaskAdditionalFieldProvider.php.

◆ validateAdditionalFields()

TYPO3\CMS\Scheduler\Example\TestTaskAdditionalFieldProvider::validateAdditionalFields ( array &  $submittedData,
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject 
)

This method checks any additional data that is relevant to the specific task If the task class is not relevant, the method is expected to return TRUE

Parameters
array$submittedDataReference to the array containing the data submitted by the user
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$parentObjectReference to the calling object (Scheduler's BE module)
Returns
bool TRUE if validation was ok (or selected class is not relevant), FALSE otherwise

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 69 of file TestTaskAdditionalFieldProvider.php.

References $GLOBALS.