TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider Class Reference
Inheritance diagram for TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider:
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)
 
 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 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

 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 = []
 

Detailed Description

Additional BE fields for sys log table garbage collection task.

Definition at line 20 of file TableGarbageCollectionAdditionalFieldProvider.php.

Member Function Documentation

◆ getAdditionalFields()

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

Add additional fields

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

Definition at line 35 of file TableGarbageCollectionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getAllTablesAdditionalField(), TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getNumberOfDaysAdditionalField(), TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getTableAdditionalField(), and TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\initDefaultNumberOfDays().

◆ getAllTablesAdditionalField()

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

Add a select field of available tables.

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

Definition at line 68 of file TableGarbageCollectionAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

◆ getNumberOfDaysAdditionalField()

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

Add an input field to get the number of days.

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

Definition at line 142 of file TableGarbageCollectionAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

◆ getTableAdditionalField()

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

Add a select field of available tables.

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

Definition at line 95 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

◆ initDefaultNumberOfDays()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::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 TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

◆ saveAdditionalFields()

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

Save additional field in task

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

Definition at line 253 of file TableGarbageCollectionAdditionalFieldProvider.php.

◆ validateAdditionalFields()

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

Validate additional fields

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

Definition at line 180 of file TableGarbageCollectionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateAllTablesAdditionalField(), TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateNumberOfDaysAdditionalField(), and TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateTableAdditionalField().

◆ validateAllTablesAdditionalField()

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

Checks if all table field is correct

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 data is valid

Definition at line 195 of file TableGarbageCollectionAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateAdditionalFields().

◆ validateNumberOfDaysAdditionalField()

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

Checks if given number of days is a positive integer

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

Definition at line 232 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateAdditionalFields().

◆ validateTableAdditionalField()

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

Checks given table for existence in configuration array

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 table exists in configuration, false otherwise

Definition at line 213 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateAdditionalFields().

Member Data Documentation

◆ $defaultNumberOfDays

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::$defaultNumberOfDays = []
protected

Definition at line 25 of file TableGarbageCollectionAdditionalFieldProvider.php.