TYPO3\CMS\Recycler\Task\CleanerFieldProvider Class Reference

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

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

Protected Member Functions
string	getTcaSelectHtml ($selectedTables=[])
bool	validateAdditionalFieldTca ($tca)
bool	checkTcaIsNotEmpty ($tca)
bool	checkTcaIsValid (array $tca)
bool	validateAdditionalFieldPeriod ($period)
	getLanguageService ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider
	addMessage (string $message, ContextualFeedbackSeverity $severity=ContextualFeedbackSeverity::OK)

Detailed Description

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

Definition at line 30 of file CleanerFieldProvider.php.

Member Function Documentation

checkTcaIsNotEmpty()

bool TYPO3\CMS\Recycler\Task\CleanerFieldProvider::checkTcaIsNotEmpty (   $tca )

protected

Checks if the array is empty

Parameters

array

$tca

‪The given TCA-tables as array

Returns

‪bool TRUE if validation was ok, FALSE otherwise

Definition at line 131 of file CleanerFieldProvider.php.

References $tca, TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider\addMessage(), and TYPO3\CMS\Recycler\Task\CleanerFieldProvider\getLanguageService().

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

checkTcaIsValid()

bool TYPO3\CMS\Recycler\Task\CleanerFieldProvider::checkTcaIsValid ( array  $tca )

protected

Checks if the given tables are in the TCA

Parameters

array

$tca

‪The given TCA-tables as array

Returns

‪bool TRUE if validation was ok, FALSE otherwise

Definition at line 152 of file CleanerFieldProvider.php.

References $GLOBALS, $tca, TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider\addMessage(), and TYPO3\CMS\Recycler\Task\CleanerFieldProvider\getLanguageService().

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

getAdditionalFields()

array 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' => ''))

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 40 of file CleanerFieldProvider.php.

References TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getCurrentAction(), and TYPO3\CMS\Recycler\Task\CleanerFieldProvider\getTcaSelectHtml().

getLanguageService()

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

protected

Definition at line 211 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()

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

protected

Gets the select-box from the TCA-fields

Parameters

array

$selectedTables

Returns

‪string

Definition at line 76 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

Exceptions

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 198 of file CleanerFieldProvider.php.

validateAdditionalFieldPeriod()

bool TYPO3\CMS\Recycler\Task\CleanerFieldProvider::validateAdditionalFieldPeriod (   $period )

protected

Validates the input of period

Parameters

int

$period

‪The given period as integer

Returns

‪bool TRUE if validation was ok, FALSE otherwise

Definition at line 176 of file CleanerFieldProvider.php.

References TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider\addMessage(), and TYPO3\CMS\Recycler\Task\CleanerFieldProvider\getLanguageService().

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

validateAdditionalFields()

bool 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

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 106 of file CleanerFieldProvider.php.

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

validateAdditionalFieldTca()

bool TYPO3\CMS\Recycler\Task\CleanerFieldProvider::validateAdditionalFieldTca (   $tca )

protected

Validates the selected Tables

Parameters

array

$tca

‪The given TCA-tables as array

Returns

‪bool TRUE if validation was ok, FALSE otherwise

Definition at line 120 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().