‪TYPO3CMS  ‪main
TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider Class Reference
Inheritance diagram for TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider:
TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface

Public Member Functions

array getAdditionalFields (array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
 
bool validateAdditionalFields (array &$submittedData, SchedulerModuleController $schedulerModule)
 
bool validateAllTablesAdditionalField (array &$submittedData)
 
bool validateTableAdditionalField (array &$submittedData)
 
bool validateNumberOfDaysAdditionalField (array &$submittedData)
 
 saveAdditionalFields (array $submittedData, AbstractTask $task)
 

Protected Member Functions

 initDefaultNumberOfDays ()
 
array getAllTablesAdditionalField (array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
 
array getTableAdditionalField (array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
 
array getNumberOfDaysAdditionalField (array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
 
 getLanguageService ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider
 addMessage (string $message, ContextualFeedbackSeverity $severity=ContextualFeedbackSeverity::OK)
 

Protected Attributes

array $defaultNumberOfDays = array( )
 

Detailed Description

Additional BE fields for sys log table garbage collection task.

This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.

Definition at line 29 of file TableGarbageCollectionAdditionalFieldProvider.php.

Member Function Documentation

◆ getAdditionalFields()

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

Add additional fields

Parameters
array$taskInfo‪Reference to the array containing the info used in the add/edit form
TableGarbageCollectionTask | null$task‪When editing, reference to the current task. NULL when adding.
SchedulerModuleController$schedulerModule‪Reference to the calling object (Scheduler's BE module)
Returns
‪array Array containing all the information pertaining to the additional fields

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

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

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

Add a select field of available tables.

Parameters
array$taskInfo‪Reference to the array containing the info used in the add/edit form
TableGarbageCollectionTask | null$task‪When editing, reference to the current task. NULL when adding.
SchedulerModuleController$schedulerModule‪Reference to the calling object (Scheduler's BE module)
Returns
‪array Array containing all the information pertaining to the additional fields

Definition at line 74 of file TableGarbageCollectionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getCurrentAction().

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

◆ getLanguageService()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::getLanguageService ( )
protected

◆ getNumberOfDaysAdditionalField()

array TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::getNumberOfDaysAdditionalField ( array &  $taskInfo,
  $task,
SchedulerModuleController  $schedulerModule 
)
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
TableGarbageCollectionTask | null$task‪When editing, reference to the current task. NULL when adding.
SchedulerModuleController$schedulerModule‪Reference to the calling object (Scheduler's BE module)
Returns
‪array Array containing all the information pertaining to the additional fields

Definition at line 154 of file TableGarbageCollectionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getCurrentAction().

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

◆ getTableAdditionalField()

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

Add a select field of available tables.

Parameters
array$taskInfo‪Reference to the array containing the info used in the add/edit form
TableGarbageCollectionTask | null$task‪When editing, reference to the current task. NULL when adding.
SchedulerModuleController$schedulerModule‪Reference to the calling object (Scheduler's BE module)
Returns
‪array Array containing all the information pertaining to the additional fields

Definition at line 107 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS, and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getCurrentAction().

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

Definition at line 56 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS.

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

◆ saveAdditionalFields()

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

Save additional field in task

Parameters
array$submittedData‪Contains data submitted by the user
TableGarbageCollectionTask$task‪Reference to the current task object

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 271 of file TableGarbageCollectionAdditionalFieldProvider.php.

◆ validateAdditionalFields()

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

Validate additional fields

Parameters
array$submittedData‪Reference to the array containing the data submitted by the user
SchedulerModuleController$schedulerModule‪Reference to the calling object (Scheduler's BE module)
Returns
‪bool True if validation was ok (or selected class is not relevant), false otherwise

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

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

bool TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::validateAllTablesAdditionalField ( array &  $submittedData)

Checks if all table field is correct

Parameters
array$submittedData‪Reference to the array containing the data submitted by the user
Returns
‪bool True if data is valid

Definition at line 216 of file TableGarbageCollectionAdditionalFieldProvider.php.

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

◆ validateNumberOfDaysAdditionalField()

bool TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::validateNumberOfDaysAdditionalField ( array &  $submittedData)

Checks if given number of days is a positive integer

Parameters
array$submittedData‪Reference to the array containing the data submitted by the user
Returns
‪bool True if validation was ok (or selected class is not relevant), false otherwise

Definition at line 251 of file TableGarbageCollectionAdditionalFieldProvider.php.

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

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

◆ validateTableAdditionalField()

bool TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::validateTableAdditionalField ( array &  $submittedData)

Checks given table for existence in configuration array

Parameters
array$submittedData‪Reference to the array containing the data submitted by the user
Returns
‪bool True if table exists in configuration, false otherwise

Definition at line 233 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS.

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

Member Data Documentation

◆ $defaultNumberOfDays

array TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::$defaultNumberOfDays = array( )
protected

Default number of days by table

Definition at line 33 of file TableGarbageCollectionAdditionalFieldProvider.php.