FileStorageIndexingAdditionalFieldProvider implements AdditionalFieldProviderInterface
Additional BE fields for tasks which indexes files in a storage
This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
Table of Contents
Interfaces
- AdditionalFieldProviderInterface
- Interface for classes who want to provide additional fields when adding a task
Methods
- getAdditionalFields() : array<string|int, mixed>
- Add additional fields
- saveAdditionalFields() : mixed
- Save additional field in task
- validateAdditionalFields() : bool
- Validate additional fields
- getAllStoragesField() : array{code: string, label: string, cshKey: string, cshLabel: string, type: string}
- Add a select field of available storages.
Methods
getAdditionalFields()
Add additional fields
public
getAdditionalFields(array<string|int, mixed> &$taskInfo, AbstractTask|null $task, SchedulerModuleController $parentObject) : array<string|int, mixed>
Parameters
- $taskInfo : array<string|int, mixed>
-
Reference to the array containing the info used in the add/edit form
- $task : AbstractTask|null
-
When editing, reference to the current task. NULL when adding.
- $parentObject : SchedulerModuleController
-
Reference to the calling object (Scheduler's BE module)
Tags
Return values
array<string|int, mixed> —Array containing all the information pertaining to the additional fields
saveAdditionalFields()
Save additional field in task
public
saveAdditionalFields(array<string|int, mixed> $submittedData, AbstractTask $task) : mixed
Parameters
- $submittedData : array<string|int, mixed>
-
Contains data submitted by the user
- $task : AbstractTask
-
Reference to the current task object
Tags
validateAdditionalFields()
Validate additional fields
public
validateAdditionalFields(array<string|int, mixed> &$submittedData, SchedulerModuleController $parentObject) : bool
Parameters
- $submittedData : array<string|int, mixed>
-
Reference to the array containing the data submitted by the user
- $parentObject : 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
getAllStoragesField()
Add a select field of available storages.
protected
getAllStoragesField(FileStorageIndexingTask|null $task, array<string|int, mixed> $taskInfo) : array{code: string, label: string, cshKey: string, cshLabel: string, type: string}
Parameters
- $task : FileStorageIndexingTask|null
-
When editing, reference to the current task object. NULL when adding.
- $taskInfo : array<string|int, mixed>
-
Reference to the array containing the info used in the add/edit form