ExecuteSchedulableCommandAdditionalFieldProvider implements AdditionalFieldProviderInterface

Internal

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

Table of Contents

Interfaces

AdditionalFieldProviderInterface
Interface for classes who want to provide additional fields when adding a task

Properties

$schedulableCommands  : array<string|int, Command>
$task  : ExecuteSchedulableCommandTask|null

Methods

__construct()  : mixed
getAdditionalFields()  : array<string|int, mixed>
Render additional information fields within the scheduler backend.
saveAdditionalFields()  : bool
Saves additional field values
validateAdditionalFields()  : bool
Validates additional selected fields
getArgumentDescription()  : string
Get the description of a command argument
getArgumentLabel()  : string
Get a human-readable label for a command argument
getCommandArgumentFields()  : array<string|int, mixed>
Gets a set of fields covering arguments which can or must be used.
getCommandOptionFields()  : array<string|int, mixed>
Gets a set of fields covering options which can or must be used.
getLanguageService()  : LanguageService
getOptionDescription()  : string
Get the description of a command option
getOptionLabel()  : string
Get a human-readable label for a command option
getSchedulableCommandsField()  : array<string|int, mixed>
Gets a select field containing all possible schedulable commands
renderArgumentField()  : string
Renders a field for defining an argument's value
renderOptionField()  : array<string|int, mixed>
Renders a field for defining an option's value
renderSelectField()  : string

Properties

$schedulableCommands

protected array<string|int, Command> $schedulableCommands = []

Methods

getAdditionalFields()

Render additional information fields within the scheduler backend.

public getAdditionalFields(array<string|int, mixed> &$txSchedulerPostData, ExecuteSchedulableCommandTask|null $task, SchedulerModuleController $schedulerModule) : array<string|int, mixed>
Parameters
$txSchedulerPostData : array<string|int, mixed>

Incoming tx_scheduler POST data

$task : ExecuteSchedulableCommandTask|null

When editing, reference to the current task. NULL when adding.

$schedulerModule : SchedulerModuleController

Reference to the calling object (BE module of the Scheduler)

Tags
see
AdditionalFieldProviderInterface::getAdditionalFields
Return values
array<string|int, mixed> —

Additional fields

saveAdditionalFields()

Saves additional field values

public saveAdditionalFields(array<string|int, mixed> $submittedData, ExecuteSchedulableCommandTask $task) : bool
Parameters
$submittedData : array<string|int, mixed>

An array containing the data submitted by the add/edit task form

$task : ExecuteSchedulableCommandTask
Return values
bool

validateAdditionalFields()

Validates additional selected fields

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

An array containing the data submitted by the add/edit task form

$schedulerModule : SchedulerModuleController

Reference to the scheduler backend module

Return values
bool —

TRUE if validation was ok (or selected class is not relevant), FALSE otherwise

getArgumentDescription()

Get the description of a command argument

protected getArgumentDescription(InputArgument $argument) : string
Parameters
$argument : InputArgument
Return values
string

getArgumentLabel()

Get a human-readable label for a command argument

protected getArgumentLabel(InputArgument $argument) : string
Parameters
$argument : InputArgument
Return values
string

getCommandArgumentFields()

Gets a set of fields covering arguments which can or must be used.

protected getCommandArgumentFields(InputDefinition $inputDefinition) : array<string|int, mixed>

Also registers the default values of those fields with the Task, allowing them to be read upon execution.

Parameters
$inputDefinition : InputDefinition
Return values
array<string|int, mixed>

getCommandOptionFields()

Gets a set of fields covering options which can or must be used.

protected getCommandOptionFields(InputDefinition $inputDefinition) : array<string|int, mixed>

Also registers the default values of those fields with the Task, allowing them to be read upon execution.

Parameters
$inputDefinition : InputDefinition
Return values
array<string|int, mixed>

getOptionDescription()

Get the description of a command option

protected getOptionDescription(InputOption $option) : string
Parameters
$option : InputOption
Return values
string

getOptionLabel()

Get a human-readable label for a command option

protected getOptionLabel(InputOption $option) : string
Parameters
$option : InputOption
Return values
string

getSchedulableCommandsField()

Gets a select field containing all possible schedulable commands

protected getSchedulableCommandsField(array<string|int, mixed> $txSchedulerPostData) : array<string|int, mixed>
Parameters
$txSchedulerPostData : array<string|int, mixed>
Return values
array<string|int, mixed>

renderArgumentField()

Renders a field for defining an argument's value

protected renderArgumentField(InputArgument $argument, string $currentValue) : string
Parameters
$argument : InputArgument
$currentValue : string
Return values
string

renderOptionField()

Renders a field for defining an option's value

protected renderOptionField(InputOption $option, bool $enabled, string $currentValue) : array<string|int, mixed>
Parameters
$option : InputOption
$enabled : bool
$currentValue : string
Return values
array<string|int, mixed>

renderSelectField()

protected renderSelectField(array<string|int, mixed> $options, string $selectedOptionValue) : string
Parameters
$options : array<string|int, mixed>
$selectedOptionValue : string
Return values
string 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results