TableGarbageCollectionAdditionalFieldProvider Class Reference

Inheritance diagram for TableGarbageCollectionAdditionalFieldProvider:

Public Member Functions
	getAdditionalFields (array &$taskInfo, $task,\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
	validateAdditionalFields (array &$submittedData,\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
	validateAllTablesAdditionalField (array &$submittedData,\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
	validateTableAdditionalField (array &$submittedData,\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
	validateNumberOfDaysAdditionalField (array &$submittedData,\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
	saveAdditionalFields (array $submittedData,\TYPO3\CMS\Scheduler\Task\AbstractTask $task)
Public Member Functions inherited from 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
	initDefaultNumberOfDays ()
	getAllTablesAdditionalField (array &$taskInfo, $task,\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
	getTableAdditionalField (array &$taskInfo, $task,\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
	getNumberOfDaysAdditionalField (array &$taskInfo, $task,\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)

Protected Attributes
	$defaultNumberOfDays = array()

Detailed Description

Additional BE fields for sys log table garbage collection task.

Definition at line 20 of file TableGarbageCollectionAdditionalFieldProvider.php.

Member Function Documentation

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

Add additional fields

Parameters

array	$taskInfo	Reference to the array containing the info used in the add/edit form
AbstractTask | NULL	$task	When editing, reference to the current task. NULL when adding.
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController	$parentObject	Reference to the calling object (Scheduler's BE module)

Returns

array Array containing all the information pertaining to the additional fields

Definition at line 35 of file TableGarbageCollectionAdditionalFieldProvider.php.

References TableGarbageCollectionAdditionalFieldProvider\getAllTablesAdditionalField(), TableGarbageCollectionAdditionalFieldProvider\getNumberOfDaysAdditionalField(), TableGarbageCollectionAdditionalFieldProvider\getTableAdditionalField(), and TableGarbageCollectionAdditionalFieldProvider\initDefaultNumberOfDays().

getAllTablesAdditionalField ( array &  $taskInfo,   $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject  )

protected

Add a select field of available tables.

Parameters

array	$taskInfo	Reference to the array containing the info used in the add/edit form
AbstractTask | NULL	$task	When editing, reference to the current task. NULL when adding.
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController	$parentObject	Reference to the calling object (Scheduler's BE module)

Returns

array Array containing all the information pertaining to the additional fields

Definition at line 68 of file TableGarbageCollectionAdditionalFieldProvider.php.

Referenced by TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

getNumberOfDaysAdditionalField ( array &  $taskInfo,   $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject  )

protected

Add an input field to get the number of days.

Parameters

array	$taskInfo	Reference to the array containing the info used in the add/edit form
AbstractTask | NULL	$task	When editing, reference to the current task. NULL when adding.
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController	$parentObject	Reference to the calling object (Scheduler's BE module)

Returns

array Array containing all the information pertaining to the additional fields

Definition at line 142 of file TableGarbageCollectionAdditionalFieldProvider.php.

References elseif.

Referenced by TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

getTableAdditionalField ( array &  $taskInfo,   $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject  )

protected

Add a select field of available tables.

Parameters

array	$taskInfo	Reference to the array containing the info used in the add/edit form
AbstractTask | NULL	$task	When editing, reference to the current task. NULL when adding.
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController	$parentObject	Reference to the calling object (Scheduler's BE module)

Returns

array Array containing all the information pertaining to the additional fields

Definition at line 95 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS, and elseif.

Referenced by TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

initDefaultNumberOfDays ( )

protected

Initialize the default number of days for all configured tables

Returns

void

Definition at line 50 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS.

Referenced by TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

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

Save additional field in task

Parameters

array	$submittedData	Contains data submitted by the user
\TYPO3\CMS\Scheduler\Task\AbstractTask	$task	Reference to the current task object

Returns

void

Definition at line 253 of file TableGarbageCollectionAdditionalFieldProvider.php.

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

Validate additional fields

Parameters

array	$submittedData	Reference to the array containing the data submitted by the user
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController	$parentObject	Reference to the calling object (Scheduler's BE module)

Returns

bool True if validation was ok (or selected class is not relevant), false otherwise

Definition at line 180 of file TableGarbageCollectionAdditionalFieldProvider.php.

References TableGarbageCollectionAdditionalFieldProvider\validateAllTablesAdditionalField(), TableGarbageCollectionAdditionalFieldProvider\validateNumberOfDaysAdditionalField(), and TableGarbageCollectionAdditionalFieldProvider\validateTableAdditionalField().

validateAllTablesAdditionalField	(	array &	$submittedData,
		\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController	$parentObject
	)

Checks if all table field is correct

Parameters

array	$submittedData	Reference to the array containing the data submitted by the user
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController	$parentObject	Reference to the calling object (Scheduler's BE module)

Returns

bool True if data is valid

Definition at line 195 of file TableGarbageCollectionAdditionalFieldProvider.php.

References elseif.

Referenced by TableGarbageCollectionAdditionalFieldProvider\validateAdditionalFields().

validateNumberOfDaysAdditionalField	(	array &	$submittedData,
		\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController	$parentObject
	)

Checks if given number of days is a positive integer

Parameters

array	$submittedData	Reference to the array containing the data submitted by the user
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController	$parentObject	Reference to the calling object (Scheduler's BE module)

Returns

bool True if validation was ok (or selected class is not relevant), false otherwise

Definition at line 232 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS, elseif, and AbstractMessage\ERROR.

Referenced by TableGarbageCollectionAdditionalFieldProvider\validateAdditionalFields().

validateTableAdditionalField	(	array &	$submittedData,
		\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController	$parentObject
	)

Checks given table for existence in configuration array

Parameters

array	$submittedData	Reference to the array containing the data submitted by the user
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController	$parentObject	Reference to the calling object (Scheduler's BE module)

Returns

bool True if table exists in configuration, false otherwise

Definition at line 213 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS, and elseif.

Referenced by TableGarbageCollectionAdditionalFieldProvider\validateAdditionalFields().

Member Data Documentation

$defaultNumberOfDays = array()

protected

Definition at line 25 of file TableGarbageCollectionAdditionalFieldProvider.php.