IpAnonymizationAdditionalFieldProvider extends AbstractAdditionalFieldProvider
Additional BE fields for ip address anonymization task.
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 additional fields
- saveAdditionalFields() : mixed
- Save additional field in task
- validateAdditionalFields() : bool
- Validate additional fields
- validateNumberOfDaysAdditionalField() : bool
- Checks if given number of days is a positive integer
- validateTableAdditionalField() : bool
- Checks given table for existence in configuration array
- addMessage() : void
- Add a flash message
- getLanguageService() : LanguageService
- Returns an instance of LanguageService
- getMaskAdditionalField() : array<string|int, mixed>
- Add an input field to get the mask.
- getNumberOfDaysAdditionalField() : array<string|int, mixed>
- Add an input field to get the number of days.
- getTableAdditionalField() : array<string|int, mixed>
- Add a select field of available tables.
Methods
getAdditionalFields()
Add additional fields
public
getAdditionalFields(array<string|int, mixed> &$taskInfo, IpAnonymizationTask|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 : IpAnonymizationTask|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 additional field in task
public
saveAdditionalFields(array<string|int, mixed> $submittedData, IpAnonymizationTask $task) : mixed
Parameters
- $submittedData : array<string|int, mixed>
-
Contains data submitted by the user
- $task : IpAnonymizationTask
-
Reference to the current task object
validateAdditionalFields()
Validate additional fields
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
validateNumberOfDaysAdditionalField()
Checks if given number of days is a positive integer
public
validateNumberOfDaysAdditionalField(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
validateTableAdditionalField()
Checks given table for existence in configuration array
public
validateTableAdditionalField(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 table exists in configuration, 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()
Returns an instance of LanguageService
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetMaskAdditionalField()
Add an input field to get the mask.
protected
getMaskAdditionalField(array<string|int, mixed> &$taskInfo, IpAnonymizationTask|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 : IpAnonymizationTask|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
getNumberOfDaysAdditionalField()
Add an input field to get the number of days.
protected
getNumberOfDaysAdditionalField(array<string|int, mixed> &$taskInfo, IpAnonymizationTask|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 : IpAnonymizationTask|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
getTableAdditionalField()
Add a select field of available tables.
protected
getTableAdditionalField(array<string|int, mixed> &$taskInfo, IpAnonymizationTask|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 : IpAnonymizationTask|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