TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface:

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

TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface::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	$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('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))

Implemented in TYPO3\CMS\Scheduler\Example\SleepTaskAdditionalFieldProvider, and TYPO3\CMS\Scheduler\Example\TestTaskAdditionalFieldProvider.

saveAdditionalFields()

TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface::saveAdditionalFields	(	array	$submittedData,
		\TYPO3\CMS\Scheduler\Task\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

Returns

void

Referenced by TYPO3\CMS\Linkvalidator\Task\ValidatorTaskAdditionalFieldProvider\validateAdditionalFields().

validateAdditionalFields()

TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface::validateAdditionalFields	(	array &	$submittedData,
		\TYPO3\CMS\Scheduler\Controller\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\Scheduler\Example\SleepTaskAdditionalFieldProvider, and TYPO3\CMS\Scheduler\Example\TestTaskAdditionalFieldProvider.