SystemStatusUpdateTaskNotificationEmailField extends AbstractAdditionalFieldProvider
Additional field to set the notification email address(es) for system health issue notifications.
This class is a specific scheduler task implementation and is not considered part of the Public TYPO3 API.
Table of Contents
Properties
- $fieldPrefix : string
- Field prefix.
- $fields : array<string|int, mixed>
- Additional fields
Methods
- getAdditionalFields() : array<string|int, mixed>
- Gets additional fields to render in the form to add/edit a task
- saveAdditionalFields() : mixed
- Takes care of saving the additional fields' values in the task's object
- validateAdditionalFields() : bool
- Validates the additional fields' values
- addMessage() : void
- Add a flash message
- getFullFieldName() : string
- Constructs the full field name which can be used in HTML markup.
- getLanguageService() : LanguageService
Properties
$fieldPrefix
Field prefix.
protected
string
$fieldPrefix
= 'SystemStatusUpdate'
$fields
Additional fields
protected
array<string|int, mixed>
$fields
= ['notificationEmail', 'notificationAll']
Methods
getAdditionalFields()
Gets additional fields to render in the form to add/edit a task
public
getAdditionalFields(array<string|int, mixed> &$taskInfo, SystemStatusUpdateTask|null $task, SchedulerModuleController $schedulerModule) : array<string|int, mixed>
Parameters
- $taskInfo : array<string|int, mixed>
-
Values of the fields from the add/edit task form
- $task : SystemStatusUpdateTask|null
-
When editing, reference to the current task. NULL when adding.
- $schedulerModule : SchedulerModuleController
-
Reference to the scheduler backend module
Return values
array<string|int, mixed> —A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))
saveAdditionalFields()
Takes care of saving the additional fields' values in the task's object
public
saveAdditionalFields(array<string|int, mixed> $submittedData, SystemStatusUpdateTask $task) : mixed
Parameters
- $submittedData : array<string|int, mixed>
-
An array containing the data submitted by the add/edit task form
- $task : SystemStatusUpdateTask
-
Reference to the scheduler backend module
Tags
validateAdditionalFields()
Validates the additional fields' values
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
addMessage()
Add a flash message
protected
addMessage(string $message[, ContextualFeedbackSeverity $severity = ContextualFeedbackSeverity::OK ]) : void
Parameters
- $message : string
-
the flash message content
- $severity : ContextualFeedbackSeverity = ContextualFeedbackSeverity::OK
-
the flash message severity
getFullFieldName()
Constructs the full field name which can be used in HTML markup.
protected
getFullFieldName(string $fieldName) : string
Parameters
- $fieldName : string
-
A raw field name
Return values
string —Field name ready to use in HTML markup
getLanguageService()
protected
getLanguageService() : LanguageService