ValidatorTaskAdditionalFieldProvider extends AbstractAdditionalFieldProvider
This class provides Scheduler Additional Field plugin implementation
This class is a specific Scheduler task implementation and is not part of the TYPO3's Core API.
Table of Contents
Properties
- $languageFile : string
- Default language file of the extension linkvalidator
Methods
- getAdditionalFields() : array<string|int, mixed>
- Render additional information fields within the scheduler backend.
- saveAdditionalFields() : void
- This method is used to save any additional input into the current task object if the task class matches.
- validateAdditionalFields() : bool
- This method checks any additional data that is relevant to the specific task.
- addMessage() : void
- Add a flash message
- getLanguageService() : LanguageService
Properties
$languageFile
Default language file of the extension linkvalidator
protected
string
$languageFile
= 'LLL:EXT:linkvalidator/Resources/Private/Language/locallang.xlf'
Methods
getAdditionalFields()
Render additional information fields within the scheduler backend.
public
getAdditionalFields(array<string|int, mixed> &$taskInfo, ValidatorTask|null $task, SchedulerModuleController $schedulerModule) : array<string|int, mixed>
Parameters
- $taskInfo : array<string|int, mixed>
-
Array information of task to return
- $task : ValidatorTask|null
-
The task object being edited. Null when adding a task!
- $schedulerModule : SchedulerModuleController
-
Reference to the BE module of the Scheduler
Tags
Return values
array<string|int, mixed> —Additional fields
saveAdditionalFields()
This method is used to save any additional input into the current task object if the task class matches.
public
saveAdditionalFields(array<string|int, mixed> $submittedData, AbstractTask $task) : void
Parameters
- $submittedData : array<string|int, mixed>
-
Array containing the data submitted by the user
- $task : AbstractTask
-
Reference to the current task object
validateAdditionalFields()
This method checks any additional data that is relevant to the specific task.
public
validateAdditionalFields(array<string|int, mixed> &$submittedData, SchedulerModuleController $schedulerModule) : bool
If the task class is not relevant, the method is expected to return TRUE.
Parameters
- $submittedData : array<string|int, mixed>
-
Reference to the array containing the data submitted by the user
- $schedulerModule : SchedulerModuleController
-
Reference to the BE module of the Scheduler
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[, int $severity = FlashMessage::OK ]) : void
Parameters
- $message : string
-
the flash message content
- $severity : int = FlashMessage::OK
-
the flash message severity
getLanguageService()
protected
getLanguageService() : LanguageService