TableGarbageCollectionAdditionalFieldProvider extends AbstractAdditionalFieldProvider

Additional BE fields for sys log table garbage collection task.

Internal

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

Table of Contents

Properties

$defaultNumberOfDays  : array<string|int, mixed>

Methods

getAdditionalFields()  : array<string|int, mixed>
Add additional fields
saveAdditionalFields()  : mixed
Save additional field in task
validateAdditionalFields()  : bool
Validate additional fields
validateAllTablesAdditionalField()  : bool
Checks if all table field is correct
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
getAllTablesAdditionalField()  : array<string|int, mixed>
Add a select field of available tables.
getLanguageService()  : LanguageService|null
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.
initDefaultNumberOfDays()  : mixed
Initialize the default number of days for all configured tables

Properties

$defaultNumberOfDays

protected array<string|int, mixed> $defaultNumberOfDays = []

Default number of days by table

Methods

getAdditionalFields()

Add additional fields

public getAdditionalFields(array<string|int, mixed> &$taskInfo, TableGarbageCollectionTask|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 : TableGarbageCollectionTask|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, TableGarbageCollectionTask $task) : mixed
Parameters
$submittedData : array<string|int, mixed>

Contains data submitted by the user

$task : TableGarbageCollectionTask

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

validateAllTablesAdditionalField()

Checks if all table field is correct

public validateAllTablesAdditionalField(array<string|int, mixed> &$submittedData) : bool
Parameters
$submittedData : array<string|int, mixed>

Reference to the array containing the data submitted by the user

Return values
bool

True if data is valid

validateNumberOfDaysAdditionalField()

Checks if given number of days is a positive integer

public validateNumberOfDaysAdditionalField(array<string|int, mixed> &$submittedData) : bool
Parameters
$submittedData : array<string|int, mixed>

Reference to the array containing the data submitted by the user

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) : bool
Parameters
$submittedData : array<string|int, mixed>

Reference to the array containing the data submitted by the user

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

getAllTablesAdditionalField()

Add a select field of available tables.

protected getAllTablesAdditionalField(array<string|int, mixed> &$taskInfo, TableGarbageCollectionTask|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 : TableGarbageCollectionTask|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, TableGarbageCollectionTask|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 : TableGarbageCollectionTask|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, TableGarbageCollectionTask|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 : TableGarbageCollectionTask|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

initDefaultNumberOfDays()

Initialize the default number of days for all configured tables

protected initDefaultNumberOfDays() : mixed

        
On this page

Search results