TaskService
Service class helping to retrieve data for EXT:scheduler
This is not a public API method, do not use in own extensions
Attributes
- #[Autoconfigure]
- $public: true
Table of Contents
Properties
Methods
- __construct() : mixed
- createNewTask() : AbstractTask
- getAllTaskTypes() : array<string|int, mixed>
- getCategorizedTaskTypes() : array<string|int, mixed>
- getFieldsForRecord() : array<string|int, mixed>
- Native fields are added / managed via FormEngine + dataHandler, so this only returns additional fields from the task object that are needed.
- getHumanReadableTaskName() : string
- getTaskDetailsFromTask() : array<string|int, mixed>|null
- getTaskDetailsFromTaskType() : array<string|int, mixed>|null
- getTaskTypesForTcaItems() : array<string|int, mixed>
- Used in FormEngine. Actually, this is only needed to task types can be "validated" by form data providers.
- isTaskTypeRegistered() : bool
- getAvailableTaskTypes() : array<string|int, mixed>
- This method fetches a list of all classes that have been registered with the Scheduler For each item the following information is provided, as an associative array:
Properties
$commandRegistry
protected
CommandRegistry
$commandRegistry
$tcaSchemaFactory
protected
TcaSchemaFactory
$tcaSchemaFactory
Methods
__construct()
public
__construct(CommandRegistry $commandRegistry, TcaSchemaFactory $tcaSchemaFactory) : mixed
Parameters
- $commandRegistry : CommandRegistry
- $tcaSchemaFactory : TcaSchemaFactory
createNewTask()
public
createNewTask(string $taskType) : AbstractTask
Parameters
- $taskType : string
Return values
AbstractTaskgetAllTaskTypes()
public
getAllTaskTypes([bool $includeNativeTypes = true ]) : array<string|int, mixed>
Parameters
- $includeNativeTypes : bool = true
Return values
array<string|int, mixed>getCategorizedTaskTypes()
public
getCategorizedTaskTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>getFieldsForRecord()
Native fields are added / managed via FormEngine + dataHandler, so this only returns additional fields from the task object that are needed.
public
getFieldsForRecord(AbstractTask $task) : array<string|int, mixed>
Parameters
- $task : AbstractTask
Return values
array<string|int, mixed>getHumanReadableTaskName()
public
getHumanReadableTaskName(AbstractTask $task) : string
Parameters
- $task : AbstractTask
Return values
stringgetTaskDetailsFromTask()
public
getTaskDetailsFromTask(AbstractTask $taskObject) : array<string|int, mixed>|null
Parameters
- $taskObject : AbstractTask
Return values
array<string|int, mixed>|nullgetTaskDetailsFromTaskType()
public
getTaskDetailsFromTaskType(string $taskType) : array<string|int, mixed>|null
Parameters
- $taskType : string
Return values
array<string|int, mixed>|nullgetTaskTypesForTcaItems()
Used in FormEngine. Actually, this is only needed to task types can be "validated" by form data providers.
public
getTaskTypesForTcaItems(array<string|int, mixed> &$config[, mixed $_ = null ][, bool $includeNativeItems = false ]) : array<string|int, mixed>
There is no possibility to "select" a task type in FormEngine. The field is a readonly information.
Parameters
- $config : array<string|int, mixed>
- $_ : mixed = null
- $includeNativeItems : bool = false
Return values
array<string|int, mixed>isTaskTypeRegistered()
public
isTaskTypeRegistered(string $taskType) : bool
Parameters
- $taskType : string
Return values
boolgetAvailableTaskTypes()
This method fetches a list of all classes that have been registered with the Scheduler For each item the following information is provided, as an associative array:
protected
getAvailableTaskTypes([bool $includeNativeTypes = true ]) : array<string|int, mixed>
['className'] => Name of the task PHP class ['extension'] => Key of the extension which provides the class ['filename'] => Path to the file containing the class ['title'] => String (possibly localized) containing a human-readable name for the class
The name of the class itself is used as the key of the list array
Parameters
- $includeNativeTypes : bool = true