‪TYPO3CMS  ‪main
TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField Class Reference
Inheritance diagram for TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField:
TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface

Public Member Functions

array getAdditionalFields (array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
 
bool validateAdditionalFields (array &$submittedData, SchedulerModuleController $schedulerModule)
 
 saveAdditionalFields (array $submittedData, AbstractTask $task)
 

Protected Member Functions

string getFullFieldName ($fieldName)
 
 getLanguageService ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider
 addMessage (string $message, ContextualFeedbackSeverity $severity=ContextualFeedbackSeverity::OK)
 

Protected Attributes

array $fields = array( 'notificationEmail', 'notificationAll' )
 
string $fieldPrefix = 'SystemStatusUpdate'
 

Detailed Description

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.

Definition at line 31 of file SystemStatusUpdateTaskNotificationEmailField.php.

Member Function Documentation

◆ getAdditionalFields()

array TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField::getAdditionalFields ( array &  $taskInfo,
  $task,
SchedulerModuleController  $schedulerModule 
)

Gets additional fields to render in the form to add/edit a task

Parameters
array$taskInfo‪Values of the fields from the add/edit task form
SystemStatusUpdateTask | null$task‪When editing, reference to the current task. NULL when adding.
SchedulerModuleController$schedulerModule‪Reference to the scheduler backend module
Returns
‪array A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 53 of file SystemStatusUpdateTaskNotificationEmailField.php.

References TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getCurrentAction(), and TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField\getFullFieldName().

◆ getFullFieldName()

string TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField::getFullFieldName (   $fieldName)
protected

Constructs the full field name which can be used in HTML markup.

Parameters
string$fieldName‪A raw field name
Returns
‪string Field name ready to use in HTML markup

Definition at line 141 of file SystemStatusUpdateTaskNotificationEmailField.php.

Referenced by TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField\getAdditionalFields().

◆ getLanguageService()

TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField::getLanguageService ( )
protected

◆ saveAdditionalFields()

TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField::saveAdditionalFields ( array  $submittedData,
AbstractTask  $task 
)

Takes care of saving the additional fields' values in the task's object

Parameters
array$submittedData‪An array containing the data submitted by the add/edit task form
SystemStatusUpdateTask$task‪Reference to the scheduler backend module
Exceptions

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 126 of file SystemStatusUpdateTaskNotificationEmailField.php.

◆ validateAdditionalFields()

bool TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField::validateAdditionalFields ( array &  $submittedData,
SchedulerModuleController  $schedulerModule 
)

Validates the additional fields' values

Parameters
array$submittedData‪An array containing the data submitted by the add/edit task form
SchedulerModuleController$schedulerModule‪Reference to the scheduler backend module
Returns
‪bool TRUE if validation was ok (or selected class is not relevant), FALSE otherwise

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 102 of file SystemStatusUpdateTaskNotificationEmailField.php.

References TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider\addMessage(), TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField\getLanguageService(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Member Data Documentation

◆ $fieldPrefix

string TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField::$fieldPrefix = 'SystemStatusUpdate'
protected

Field prefix.

Definition at line 43 of file SystemStatusUpdateTaskNotificationEmailField.php.

◆ $fields

array TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField::$fields = array( 'notificationEmail', 'notificationAll' )
protected

Additional fields

Definition at line 37 of file SystemStatusUpdateTaskNotificationEmailField.php.