CachingFrameworkGarbageCollectionAdditionalFieldProvider extends AbstractAdditionalFieldProvider
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.
Table of Contents
Methods
- getAdditionalFields() : array<string|int, mixed>
- Add a multi select box with all available cache backends.
- saveAdditionalFields() : mixed
- Save selected backends in task object
- validateAdditionalFields() : bool
- Checks that all selected backends exist in available backend list
- addMessage() : void
- Add a flash message
- getCacheBackendOptions() : string
- Build select options of available backends and set currently selected backends
- getLanguageService() : LanguageService|null
- getRegisteredBackends() : array<string|int, mixed>
- Get all registered caching framework backends
Methods
getAdditionalFields()
Add a multi select box with all available cache backends.
public
getAdditionalFields(array<string|int, mixed> &$taskInfo, CachingFrameworkGarbageCollectionTask|null $task, SchedulerModuleController $schedulerModule) : array<string|int, mixed>
Parameters
- $taskInfo : array<string|int, mixed>
-
Reference to the array containing the info used in the add/edit form
- $task : CachingFrameworkGarbageCollectionTask|null
-
When editing, reference to the current task. NULL when adding.
- $schedulerModule : SchedulerModuleController
-
Reference to the calling object (Scheduler's BE module)
Return values
array<string|int, mixed> —Array containing all the information pertaining to the additional fields
saveAdditionalFields()
Save selected backends in task object
public
saveAdditionalFields(array<string|int, mixed> $submittedData, CachingFrameworkGarbageCollectionTask $task) : mixed
Parameters
- $submittedData : array<string|int, mixed>
-
Contains data submitted by the user
- $task : CachingFrameworkGarbageCollectionTask
-
Reference to the current task object
validateAdditionalFields()
Checks that all selected backends exist in available backend list
public
validateAdditionalFields(array<string|int, mixed> &$submittedData, SchedulerModuleController $schedulerModule) : bool
Parameters
- $submittedData : array<string|int, mixed>
-
Reference to the array containing the data submitted by the user
- $schedulerModule : SchedulerModuleController
-
Reference to the calling object (Scheduler's BE module)
Return values
bool —TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
addMessage()
Add a flash message
protected
addMessage(string $message[, ContextualFeedbackSeverity $severity = ContextualFeedbackSeverity::OK ]) : void
Parameters
- $message : string
-
the flash message content
- $severity : ContextualFeedbackSeverity = ContextualFeedbackSeverity::OK
-
the flash message severity
getCacheBackendOptions()
Build select options of available backends and set currently selected backends
protected
getCacheBackendOptions(array<string|int, mixed> $selectedBackends) : string
Parameters
- $selectedBackends : array<string|int, mixed>
-
Selected backends
Return values
string —HTML of selectbox options
getLanguageService()
protected
getLanguageService() : LanguageService|null
Return values
LanguageService|nullgetRegisteredBackends()
Get all registered caching framework backends
protected
getRegisteredBackends() : array<string|int, mixed>
Return values
array<string|int, mixed> —Registered backends