‪TYPO3CMS  ‪main
TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider Class Reference
Inheritance diagram for TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider:
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

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

Detailed Description

Additional BE fields for caching framework garbage collection task. Creates a multi selectbox with all available cache backends to select from.

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

Definition at line 30 of file CachingFrameworkGarbageCollectionAdditionalFieldProvider.php.

Member Function Documentation

◆ getAdditionalFields()

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

Add a multi select box with all available cache backends.

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

References TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider\getCacheBackendOptions(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getCurrentAction(), and TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider\getRegisteredBackends().

◆ getCacheBackendOptions()

string TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider::getCacheBackendOptions ( array  $selectedBackends)
protected

Build select options of available backends and set currently selected backends

Parameters
array$selectedBackends‪Selected backends
Returns
‪string HTML of selectbox options

Definition at line 114 of file CachingFrameworkGarbageCollectionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider\getRegisteredBackends().

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

◆ getLanguageService()

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

◆ getRegisteredBackends()

array TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider::getRegisteredBackends ( )
protected

◆ saveAdditionalFields()

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

Save selected backends in task object

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

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 103 of file CachingFrameworkGarbageCollectionAdditionalFieldProvider.php.

◆ validateAdditionalFields()

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

Checks that all selected backends exist in available backend list

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 80 of file CachingFrameworkGarbageCollectionAdditionalFieldProvider.php.

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