TYPO3 CMS  TYPO3_6-2
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider Class Reference
Inheritance diagram for TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider:
TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface tx_scheduler_TableGarbageCollection_AdditionalFieldProvider

Public Member Functions

 getAdditionalFields (array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
 
 validateAdditionalFields (array &$submittedData, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
 
 validateAllTablesAdditionalField (array &$submittedData, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
 
 validateTableAdditionalField (array &$submittedData, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
 
 validateNumberOfDaysAdditionalField (array &$submittedData, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
 
 saveAdditionalFields (array $submittedData, \TYPO3\CMS\Scheduler\Task\AbstractTask $task)
 
- Public Member Functions inherited from TYPO3\CMS\Scheduler\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

 initDefaultNumberOfDays ()
 
 getAllTablesAdditionalField (array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
 
 getTableAdditionalField (array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
 
 getNumberOfDaysAdditionalField (array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
 

Protected Attributes

 $defaultNumberOfDays = array()
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Additional BE fields for sys log table garbage collection task.

Author
Christian Kuhn lolli.nosp@m.@sch.nosp@m.warzb.nosp@m.u.ch

Definition at line 21 of file TableGarbageCollectionAdditionalFieldProvider.php.

Member Function Documentation

◆ getAdditionalFields()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::getAdditionalFields ( array &  $taskInfo,
  $task,
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject 
)

Add additional fields

Parameters
array$taskInfoReference to the array containing the info used in the add/edit form
object$taskWhen editing, reference to the current task object. Null when adding.
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$parentObjectReference to the calling object (Scheduler's BE module)
Returns
array Array containing all the information pertaining to the additional fields

Definition at line 36 of file TableGarbageCollectionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getAllTablesAdditionalField(), TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getNumberOfDaysAdditionalField(), TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getTableAdditionalField(), and TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\initDefaultNumberOfDays().

◆ getAllTablesAdditionalField()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::getAllTablesAdditionalField ( array &  $taskInfo,
  $task,
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject 
)
protected

Add a select field of available tables.

Parameters
array$taskInfoReference to the array containing the info used in the add/edit form
object$taskWhen editing, reference to the current task object. Null when adding.
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$parentObjectReference to the calling object (Scheduler's BE module)
Returns
array Array containing all the information pertaining to the additional fields

Definition at line 66 of file TableGarbageCollectionAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

◆ getNumberOfDaysAdditionalField()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::getNumberOfDaysAdditionalField ( array &  $taskInfo,
  $task,
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject 
)
protected

Add a input field to get the number of days.

Parameters
array$taskInfoReference to the array containing the info used in the add/edit form
object$taskWhen editing, reference to the current task object. Null when adding.
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$parentObjectReference to the calling object (Scheduler's BE module)
Returns
array Array containing all the information pertaining to the additional fields

Definition at line 138 of file TableGarbageCollectionAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

◆ getTableAdditionalField()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::getTableAdditionalField ( array &  $taskInfo,
  $task,
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject 
)
protected

Add a select field of available tables.

Parameters
array$taskInfoReference to the array containing the info used in the add/edit form
object$taskWhen editing, reference to the current task object. Null when adding.
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$parentObjectReference to the calling object (Scheduler's BE module)
Returns
array Array containing all the information pertaining to the additional fields

Definition at line 92 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

◆ initDefaultNumberOfDays()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::initDefaultNumberOfDays ( )
protected

Initialize the default number of days for all configured tables

Returns
void

Definition at line 49 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\getAdditionalFields().

◆ saveAdditionalFields()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::saveAdditionalFields ( array  $submittedData,
\TYPO3\CMS\Scheduler\Task\AbstractTask  $task 
)

Save additional field in task

Parameters
array$submittedDataContains data submitted by the user
\TYPO3\CMS\Scheduler\Task\AbstractTask$taskReference to the current task object
Returns
void

Definition at line 244 of file TableGarbageCollectionAdditionalFieldProvider.php.

◆ validateAdditionalFields()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::validateAdditionalFields ( array &  $submittedData,
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject 
)

Validate additional fields

Parameters
array$submittedDataReference to the array containing the data submitted by the user
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$parentObjectReference to the calling object (Scheduler's BE module)
Returns
boolean True if validation was ok (or selected class is not relevant), false otherwise

Definition at line 175 of file TableGarbageCollectionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateAllTablesAdditionalField(), TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateNumberOfDaysAdditionalField(), and TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateTableAdditionalField().

◆ validateAllTablesAdditionalField()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::validateAllTablesAdditionalField ( array &  $submittedData,
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject 
)

Checks if all table field is correct

Parameters
array$submittedDataReference to the array containing the data submitted by the user
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$parentObjectReference to the calling object (Scheduler's BE module)
Returns
boolean True if data is valid

Definition at line 189 of file TableGarbageCollectionAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateAdditionalFields().

◆ validateNumberOfDaysAdditionalField()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::validateNumberOfDaysAdditionalField ( array &  $submittedData,
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject 
)

Checks if given number of days is a positive integer

Parameters
array$submittedDataReference to the array containing the data submitted by the user
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$parentObjectReference to the calling object (Scheduler's BE module)
Returns
boolean True if validation was ok (or selected class is not relevant), false otherwise

Definition at line 224 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS, and TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateAdditionalFields().

◆ validateTableAdditionalField()

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::validateTableAdditionalField ( array &  $submittedData,
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController  $parentObject 
)

Checks given table for existence in configuration array

Parameters
array$submittedDataReference to the array containing the data submitted by the user
\TYPO3\CMS\Scheduler\Controller\SchedulerModuleController$parentObjectReference to the calling object (Scheduler's BE module)
Returns
boolean True if table exists in configuration, false otherwise

Definition at line 206 of file TableGarbageCollectionAdditionalFieldProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateAdditionalFields().

Member Data Documentation

◆ $defaultNumberOfDays

TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider::$defaultNumberOfDays = array()
protected

Definition at line 26 of file TableGarbageCollectionAdditionalFieldProvider.php.