OptimizeDatabaseTableAdditionalFieldProvider extends AbstractAdditionalFieldProvider
Additional BE fields for optimize database table task.
This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
Table of Contents
Properties
- $languageFile : string
Methods
- getAdditionalFields() : array<string|int, mixed>
- Add a multi select box with all available database tables.
- 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
- getDatabaseTableOptions() : string
- Build select options of available backends and set currently selected backends
- getLanguageService() : LanguageService|null
- getOptimizableTables() : array<string|int, mixed>
- Get all tables that are capable of optimization
- getOptimizableTablesForConnection() : array<string|int, mixed>
- Retrieve all optimizable tables for a connection, optionally restricted to the subset of table names in the $tableNames array.
Properties
$languageFile
protected
string
$languageFile
= 'LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf'
Methods
getAdditionalFields()
Add a multi select box with all available database tables.
public
getAdditionalFields(array<string|int, mixed> &$taskInfo, OptimizeDatabaseTableTask|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 : OptimizeDatabaseTableTask|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, OptimizeDatabaseTableTask $task) : mixed
Parameters
- $submittedData : array<string|int, mixed>
-
Contains data submitted by the user
- $task : OptimizeDatabaseTableTask
-
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[, int $severity = FlashMessage::OK ]) : void
Parameters
- $message : string
-
the flash message content
- $severity : int = FlashMessage::OK
-
the flash message severity
getDatabaseTableOptions()
Build select options of available backends and set currently selected backends
protected
getDatabaseTableOptions(array<string|int, mixed> $selectedTables) : string
Parameters
- $selectedTables : array<string|int, mixed>
-
Selected backends
Return values
string —HTML of selectbox options
getLanguageService()
protected
getLanguageService() : LanguageService|null
Return values
LanguageService|nullgetOptimizableTables()
Get all tables that are capable of optimization
protected
getOptimizableTables() : array<string|int, mixed>
Return values
array<string|int, mixed> —Names of table that can be optimized.
getOptimizableTablesForConnection()
Retrieve all optimizable tables for a connection, optionally restricted to the subset of table names in the $tableNames array.
protected
getOptimizableTablesForConnection(Connection $connection[, array<string|int, mixed> $tableNames = [] ]) : array<string|int, mixed>
Parameters
- $connection : Connection
- $tableNames : array<string|int, mixed> = []