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

Public Member Functions

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

Protected Member Functions

 getLanguageService ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider
 addMessage (string $message, ContextualFeedbackSeverity $severity=ContextualFeedbackSeverity::OK)
 

Protected Attributes

int $defaultNumberOfDays = 30
 

Detailed Description

Additional BE fields for recycler garbage collection task.

Creates an integer input field for difference between scheduler run time and file modification time in days to select from.

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

Definition at line 31 of file RecyclerGarbageCollectionAdditionalFieldProvider.php.

Member Function Documentation

◆ getAdditionalFields()

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

Add an integer input field for difference between scheduler run time and file modification time in days to select from

Parameters
array$taskInfo‪Reference to the array containing the info used in the add/edit form
RecyclerGarbageCollectionTask | 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 48 of file RecyclerGarbageCollectionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\RecyclerGarbageCollectionAdditionalFieldProvider\$defaultNumberOfDays, and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getCurrentAction().

◆ getLanguageService()

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

◆ saveAdditionalFields()

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

Saves given integer value in task object

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

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 100 of file RecyclerGarbageCollectionAdditionalFieldProvider.php.

◆ validateAdditionalFields()

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

Checks if the given value is an integer

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 82 of file RecyclerGarbageCollectionAdditionalFieldProvider.php.

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

Member Data Documentation

◆ $defaultNumberOfDays

int TYPO3\CMS\Scheduler\Task\RecyclerGarbageCollectionAdditionalFieldProvider::$defaultNumberOfDays = 30
protected

Default period in days to remove a recycled file

Default number of days

Definition at line 37 of file RecyclerGarbageCollectionAdditionalFieldProvider.php.

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