TYPO3\CMS\Recycler\Task\CleanerFieldProvider Class Reference

Inheritance diagram for TYPO3\CMS\Recycler\Task\CleanerFieldProvider:

Public Member Functions
	getAdditionalFields (array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
	validateAdditionalFields (array &$submittedData, SchedulerModuleController $schedulerModule)
	saveAdditionalFields (array $submittedData, AbstractTask $task)
Public Member Functions inherited from TYPO3\CMS\Scheduler\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
	getTcaSelectHtml ($selectedTables=[])
	validateAdditionalFieldTca ($tca, SchedulerModuleController $schedulerModule)
	checkTcaIsNotEmpty ($tca, SchedulerModuleController $schedulerModule)
	checkTcaIsValid (array $tca, SchedulerModuleController $schedulerModule)
	validateAdditionalFieldPeriod ($period, SchedulerModuleController $schedulerModule)
	getLanguageService ()

Detailed Description

A task that should be run regularly that deletes datasets flagged as "deleted" from the DB.

Definition at line 25 of file CleanerFieldProvider.php.

Member Function Documentation

checkTcaIsNotEmpty()

TYPO3\CMS\Recycler\Task\CleanerFieldProvider::checkTcaIsNotEmpty (   $tca, SchedulerModuleController  $schedulerModule  )

protected

Checks if the array is empty

Parameters

array	$tca	The given TCA-tables as array
SchedulerModuleController	$schedulerModule	Reference to the scheduler backend module

Returns

bool TRUE if validation was ok, FALSE otherwise

Definition at line 122 of file CleanerFieldProvider.php.

References $tca, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, and TYPO3\CMS\Recycler\Task\CleanerFieldProvider\getLanguageService().

Referenced by TYPO3\CMS\Recycler\Task\CleanerFieldProvider\validateAdditionalFieldTca().

checkTcaIsValid()

TYPO3\CMS\Recycler\Task\CleanerFieldProvider::checkTcaIsValid ( array  $tca, SchedulerModuleController  $schedulerModule  )

protected

Checks if the given tables are in the TCA

Parameters

array	$tca	The given TCA-tables as array
SchedulerModuleController	$schedulerModule	Reference to the scheduler backend module

Returns

bool TRUE if validation was ok, FALSE otherwise

Definition at line 144 of file CleanerFieldProvider.php.

References $GLOBALS, TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, and TYPO3\CMS\Recycler\Task\CleanerFieldProvider\getLanguageService().

Referenced by TYPO3\CMS\Recycler\Task\CleanerFieldProvider\validateAdditionalFieldTca().

getAdditionalFields()

TYPO3\CMS\Recycler\Task\CleanerFieldProvider::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\Recycler\Task\CleanerTask	$task	The task object being edited. NULL when adding a task!
SchedulerModuleController	$schedulerModule	Reference to the scheduler backend module

Returns

array A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))

Definition at line 35 of file CleanerFieldProvider.php.

References TYPO3\CMS\Recycler\Task\CleanerFieldProvider\getTcaSelectHtml().

getLanguageService()

TYPO3\CMS\Recycler\Task\CleanerFieldProvider::getLanguageService ( )

protected

Returns

Definition at line 209 of file CleanerFieldProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Recycler\Task\CleanerFieldProvider\checkTcaIsNotEmpty(), TYPO3\CMS\Recycler\Task\CleanerFieldProvider\checkTcaIsValid(), TYPO3\CMS\Recycler\Task\CleanerFieldProvider\getTcaSelectHtml(), and TYPO3\CMS\Recycler\Task\CleanerFieldProvider\validateAdditionalFieldPeriod().

getTcaSelectHtml()

TYPO3\CMS\Recycler\Task\CleanerFieldProvider::getTcaSelectHtml (   $selectedTables = [] )

protected

Gets the select-box from the TCA-fields

Parameters

array

$selectedTables

Returns

string

Definition at line 65 of file CleanerFieldProvider.php.

References $GLOBALS, and TYPO3\CMS\Recycler\Task\CleanerFieldProvider\getLanguageService().

Referenced by TYPO3\CMS\Recycler\Task\CleanerFieldProvider\getAdditionalFields().

saveAdditionalFields()

TYPO3\CMS\Recycler\Task\CleanerFieldProvider::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
AbstractTask	$task	Reference to the scheduler backend module

Returns

void

Exceptions

Definition at line 193 of file CleanerFieldProvider.php.

validateAdditionalFieldPeriod()

TYPO3\CMS\Recycler\Task\CleanerFieldProvider::validateAdditionalFieldPeriod (   $period, SchedulerModuleController  $schedulerModule  )

protected

Validates the input of period

Parameters

int	$period	The given period as integer
SchedulerModuleController	$schedulerModule	Reference to the scheduler backend module

Returns

bool TRUE if validation was ok, FALSE otherwise

Definition at line 170 of file CleanerFieldProvider.php.

References TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, and TYPO3\CMS\Recycler\Task\CleanerFieldProvider\getLanguageService().

Referenced by TYPO3\CMS\Recycler\Task\CleanerFieldProvider\validateAdditionalFields().

validateAdditionalFields()

TYPO3\CMS\Recycler\Task\CleanerFieldProvider::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
SchedulerModuleController	$schedulerModule	Reference to the scheduler backend module

Returns

bool TRUE if validation was ok (or selected class is not relevant), FALSE otherwise

Definition at line 95 of file CleanerFieldProvider.php.

References TYPO3\CMS\Recycler\Task\CleanerFieldProvider\validateAdditionalFieldPeriod(), and TYPO3\CMS\Recycler\Task\CleanerFieldProvider\validateAdditionalFieldTca().

validateAdditionalFieldTca()

TYPO3\CMS\Recycler\Task\CleanerFieldProvider::validateAdditionalFieldTca (   $tca, SchedulerModuleController  $schedulerModule  )

protected

Validates the selected Tables

Parameters

array	$tca	The given TCA-tables as array
SchedulerModuleController	$schedulerModule	Reference to the scheduler backend module

Returns

bool TRUE if validation was ok, FALSE otherwise

Definition at line 110 of file CleanerFieldProvider.php.

References $tca, TYPO3\CMS\Recycler\Task\CleanerFieldProvider\checkTcaIsNotEmpty(), and TYPO3\CMS\Recycler\Task\CleanerFieldProvider\checkTcaIsValid().

Referenced by TYPO3\CMS\Recycler\Task\CleanerFieldProvider\validateAdditionalFields().