TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider Class Reference

Inheritance diagram for TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider:

Public Member Functions
	getAdditionalFields (array &$taskInfo, $task, SchedulerModuleController $parentObject)
	validateAdditionalFields (array &$submittedData, 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
	getFileCountField (FileStorageExtractionTask $task=null)
	getRegisteredExtractorsField (FileStorageExtractionTask $task=null)
	formatExtractorClassName (ExtractorInterface $extractor)
	getLanguageService ()

Detailed Description

Additional BE fields for task which extracts metadata from storage

Definition at line 29 of file FileStorageExtractionAdditionalFieldProvider.php.

Member Function Documentation

formatExtractorClassName()

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.

Parameters

ExtractorInterface

$extractor

Returns

string

Definition at line 194 of file FileStorageExtractionAdditionalFieldProvider.php.

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

getAdditionalFields()

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

Definition at line 40 of file FileStorageExtractionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\getFileCountField(), TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\getRegisteredExtractorsField(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

getFileCountField()

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

protected

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

Parameters

FileStorageExtractionTask

$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 89 of file FileStorageExtractionAdditionalFieldProvider.php.

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

getLanguageService()

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

protected

Returns

Definition at line 203 of file FileStorageExtractionAdditionalFieldProvider.php.

References $GLOBALS.

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

getRegisteredExtractorsField()

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

protected

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

Parameters

FileStorageExtractionTask

$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 111 of file FileStorageExtractionAdditionalFieldProvider.php.

References TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\formatExtractorClassName(), TYPO3\CMS\Core\Resource\Index\ExtractorRegistry\getInstance(), and TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\getLanguageService().

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

saveAdditionalFields()

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

Save additional field in task

Parameters

array	$submittedData	Contains data submitted by the user
\TYPO3\CMS\Scheduler\Task\AbstractTask	$task	Reference to the current task object

Returns

void

Exceptions

Definition at line 178 of file FileStorageExtractionAdditionalFieldProvider.php.

validateAdditionalFields()

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

Definition at line 155 of file FileStorageExtractionAdditionalFieldProvider.php.

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