TYPO3  7.6
Public Member Functions | Protected Member Functions | List of all members
CleanerFieldProvider Class Reference
Inheritance diagram for CleanerFieldProvider:
AdditionalFieldProviderInterface

Public Member Functions

 getAdditionalFields (array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
 
 validateAdditionalFields (array &$submittedData, SchedulerModuleController $schedulerModule)
 
 saveAdditionalFields (array $submittedData, AbstractTask $task)
 
- Public Member Functions inherited from AdditionalFieldProviderInterface
 getAdditionalFields (array &$taskInfo, $task,\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule)
 
 validateAdditionalFields (array &$submittedData,\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule)
 
 saveAdditionalFields (array $submittedData,\TYPO3\CMS\Scheduler\Task\AbstractTask $task)
 

Protected Member Functions

 getTcaSelectHtml ($selectedTables=array())
 
 validateAdditionalFieldTca ($tca, SchedulerModuleController $schedulerModule)
 
 checkTcaIsNotEmpty ($tca, SchedulerModuleController $schedulerModule)
 
 checkTcaIsValid (array $tca, SchedulerModuleController $schedulerModule)
 
 validateAdditionalFieldPeriod ($period, SchedulerModuleController $schedulerModule)
 
 getLanguageService ()
 

Detailed Description

A task that should be run regularly that deletes datasets flagged as "deleted" from the DB.

Definition at line 25 of file CleanerFieldProvider.php.

Member Function Documentation

checkTcaIsNotEmpty (   $tca,
SchedulerModuleController  $schedulerModule 
)
protected

Checks if the array is empty

Parameters
array$tcaThe given TCA-tables as array
SchedulerModuleController$schedulerModuleReference to the scheduler backend module
Returns
bool TRUE if validation was ok, FALSE otherwise

Definition at line 122 of file CleanerFieldProvider.php.

References $tca, SchedulerModuleController\addMessage(), AbstractMessage\ERROR, and CleanerFieldProvider\getLanguageService().

Referenced by CleanerFieldProvider\validateAdditionalFieldTca().

checkTcaIsValid ( array  $tca,
SchedulerModuleController  $schedulerModule 
)
protected

Checks if the given tables are in the TCA

Parameters
array$tcaThe given TCA-tables as array
SchedulerModuleController$schedulerModuleReference to the scheduler backend module
Returns
bool TRUE if validation was ok, FALSE otherwise

Definition at line 144 of file CleanerFieldProvider.php.

References $GLOBALS, SchedulerModuleController\addMessage(), AbstractMessage\ERROR, and CleanerFieldProvider\getLanguageService().

Referenced by CleanerFieldProvider\validateAdditionalFieldTca().

getAdditionalFields ( array &  $taskInfo,
  $task,
SchedulerModuleController  $schedulerModule 
)

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

Parameters
array$taskInfoValues of the fields from the add/edit task form
\TYPO3\CMS\Recycler\Task\CleanerTask$taskThe task object being edited. NULL when adding a task!
SchedulerModuleController$schedulerModuleReference to the scheduler backend module
Returns
array A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))

Definition at line 35 of file CleanerFieldProvider.php.

References CleanerFieldProvider\getTcaSelectHtml().

getLanguageService ( )
protected
getTcaSelectHtml (   $selectedTables = array())
protected

Gets the select-box from the TCA-fields

Parameters
array$selectedTables
Returns
string

Definition at line 65 of file CleanerFieldProvider.php.

References $GLOBALS, and CleanerFieldProvider\getLanguageService().

Referenced by CleanerFieldProvider\getAdditionalFields().

saveAdditionalFields ( array  $submittedData,
AbstractTask  $task 
)

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

Parameters
array$submittedDataAn array containing the data submitted by the add/edit task form
AbstractTask$taskReference to the scheduler backend module
Returns
void
Exceptions
\InvalidArgumentException

Definition at line 193 of file CleanerFieldProvider.php.

validateAdditionalFieldPeriod (   $period,
SchedulerModuleController  $schedulerModule 
)
protected

Validates the input of period

Parameters
int$periodThe given period as integer
SchedulerModuleController$schedulerModuleReference to the scheduler backend module
Returns
bool TRUE if validation was ok, FALSE otherwise

Definition at line 170 of file CleanerFieldProvider.php.

References SchedulerModuleController\addMessage(), AbstractMessage\ERROR, and CleanerFieldProvider\getLanguageService().

Referenced by CleanerFieldProvider\validateAdditionalFields().

validateAdditionalFields ( array &  $submittedData,
SchedulerModuleController  $schedulerModule 
)

Validates the additional fields' values

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

Definition at line 95 of file CleanerFieldProvider.php.

References CleanerFieldProvider\validateAdditionalFieldPeriod(), and CleanerFieldProvider\validateAdditionalFieldTca().

validateAdditionalFieldTca (   $tca,
SchedulerModuleController  $schedulerModule 
)
protected

Validates the selected Tables

Parameters
array$tcaThe given TCA-tables as array
SchedulerModuleController$schedulerModuleReference to the scheduler backend module
Returns
bool TRUE if validation was ok, FALSE otherwise

Definition at line 110 of file CleanerFieldProvider.php.

References $tca, CleanerFieldProvider\checkTcaIsNotEmpty(), and CleanerFieldProvider\checkTcaIsValid().

Referenced by CleanerFieldProvider\validateAdditionalFields().