‪TYPO3CMS  ‪main
TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider Class Reference
Inheritance diagram for TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider:
TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface

Public Member Functions

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

Protected Member Functions

array getAllStoragesField (FileStorageExtractionTask $task=null)
 
array getFileCountField (FileStorageExtractionTask $task=null)
 
array getRegisteredExtractorsField (FileStorageExtractionTask $task=null)
 
string formatExtractorClassName (ExtractorInterface $extractor)
 
 getLanguageService ()
 

Detailed Description

Additional BE fields for task which extracts metadata from storage

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

Definition at line 32 of file FileStorageExtractionAdditionalFieldProvider.php.

Member Function Documentation

◆ formatExtractorClassName()

string TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider::formatExtractorClassName ( ExtractorInterface  $extractor)
protected

Since the class name can be very long considering the namespace, only take the final part for better readability. The FQN of the class will be displayed as tooltip.

Returns
‪string

Definition at line 202 of file FileStorageExtractionAdditionalFieldProvider.php.

Referenced by TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\getRegisteredExtractorsField().

◆ getAdditionalFields()

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

Add additional fields

Parameters
array$taskInfo‪Reference to the array containing the info used in the add/edit form
AbstractTask | null$task‪When editing, reference to the current task. NULL when adding.
SchedulerModuleController$parentObject‪Reference to the calling object (Scheduler's BE module)
Returns
‪array Array containing all the information pertaining to the additional fields
Exceptions

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 43 of file FileStorageExtractionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\getAllStoragesField(), TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\getFileCountField(), and TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\getRegisteredExtractorsField().

◆ getAllStoragesField()

array TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider::getAllStoragesField ( FileStorageExtractionTask  $task = null)
protected

Returns a field configuration including a selectbox for available storages

Parameters
FileStorageExtractionTask | null$task‪When editing, reference to the current task object. NULL when adding.
Returns
‪array Array containing all the information pertaining to the additional fields

Definition at line 61 of file FileStorageExtractionAdditionalFieldProvider.php.

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

◆ getFileCountField()

array TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider::getFileCountField ( FileStorageExtractionTask  $task = null)
protected

Returns a field configuration including an input field for the file count

Parameters
FileStorageExtractionTask | null$task‪When editing, reference to the current task object. NULL when adding.
Returns
‪array Array containing all the information pertaining to the additional fields

Definition at line 95 of file FileStorageExtractionAdditionalFieldProvider.php.

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

◆ getLanguageService()

TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider::getLanguageService ( )
protected

◆ getRegisteredExtractorsField()

array TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider::getRegisteredExtractorsField ( FileStorageExtractionTask  $task = null)
protected

Returns a field configuration telling about the status of registered extractors.

Parameters
FileStorageExtractionTask | null$task‪When editing, reference to the current task object. NULL when adding.
Returns
‪array Array containing all the information pertaining to the additional fields

Definition at line 119 of file FileStorageExtractionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\formatExtractorClassName(), and TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\getLanguageService().

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

◆ saveAdditionalFields()

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

Save additional field in task

Parameters
array$submittedData‪Contains data submitted by the user
AbstractTask$task‪Reference to the current task object
Exceptions

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 187 of file FileStorageExtractionAdditionalFieldProvider.php.

◆ validateAdditionalFields()

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

Validate additional fields

Parameters
array$submittedData‪Reference to the array containing the data submitted by the user
SchedulerModuleController$parentObject‪Reference to the calling object (Scheduler's BE module)
Returns
‪bool True if validation was ok (or selected class is not relevant), false otherwise

Implements TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface.

Definition at line 163 of file FileStorageExtractionAdditionalFieldProvider.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), and TYPO3\CMS\Core\Utility\MathUtility\isIntegerInRange().