FileStorageExtractionAdditionalFieldProvider implements AdditionalFieldProviderInterface

Additional BE fields for task which extracts metadata from storage

Internal

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

Table of Contents

Interfaces

AdditionalFieldProviderInterface
Interface for classes who want to provide additional fields when adding a task

Methods

getAdditionalFields()  : array<string|int, mixed>
Add additional fields
saveAdditionalFields()  : mixed
Save additional field in task
validateAdditionalFields()  : bool
Validate additional fields
formatExtractorClassName()  : string
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.
getAllStoragesField()  : array<string|int, mixed>
Returns a field configuration including a selectbox for available storages
getFileCountField()  : array<string|int, mixed>
Returns a field configuration including an input field for the file count
getLanguageService()  : LanguageService
getRegisteredExtractorsField()  : array<string|int, mixed>
Returns a field configuration telling about the status of registered extractors.

Methods

getAdditionalFields()

Add additional fields

public getAdditionalFields(array<string|int, mixed> &$taskInfo, AbstractTask|null $task, SchedulerModuleController $parentObject) : array<string|int, mixed>
Parameters
$taskInfo : array<string|int, mixed>

Reference to the array containing the info used in the add/edit form

$task : AbstractTask|null

When editing, reference to the current task. NULL when adding.

$parentObject : SchedulerModuleController

Reference to the calling object (Scheduler's BE module)

Tags
throws
InvalidArgumentException
Return values
array<string|int, mixed> —

Array containing all the information pertaining to the additional fields

saveAdditionalFields()

Save additional field in task

public saveAdditionalFields(array<string|int, mixed> $submittedData, AbstractTask $task) : mixed
Parameters
$submittedData : array<string|int, mixed>

Contains data submitted by the user

$task : AbstractTask

Reference to the current task object

Tags
throws
InvalidArgumentException

validateAdditionalFields()

Validate additional fields

public validateAdditionalFields(array<string|int, mixed> &$submittedData, SchedulerModuleController $parentObject) : bool
Parameters
$submittedData : array<string|int, mixed>

Reference to the array containing the data submitted by the user

$parentObject : SchedulerModuleController

Reference to the calling object (Scheduler's BE module)

Return values
bool —

True if validation was ok (or selected class is not relevant), false otherwise

formatExtractorClassName()

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.

protected formatExtractorClassName(ExtractorInterface $extractor) : string
Parameters
$extractor : ExtractorInterface
Return values
string

getAllStoragesField()

Returns a field configuration including a selectbox for available storages

protected getAllStoragesField([FileStorageExtractionTask|null $task = null ]) : array<string|int, mixed>
Parameters
$task : FileStorageExtractionTask|null = null

When editing, reference to the current task object. NULL when adding.

Return values
array<string|int, mixed> —

Array containing all the information pertaining to the additional fields

getFileCountField()

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

protected getFileCountField([FileStorageExtractionTask|null $task = null ]) : array<string|int, mixed>
Parameters
$task : FileStorageExtractionTask|null = null

When editing, reference to the current task object. NULL when adding.

Return values
array<string|int, mixed> —

Array containing all the information pertaining to the additional fields

getRegisteredExtractorsField()

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

protected getRegisteredExtractorsField([FileStorageExtractionTask|null $task = null ]) : array<string|int, mixed>
Parameters
$task : FileStorageExtractionTask|null = null

When editing, reference to the current task object. NULL when adding.

Return values
array<string|int, mixed> —

Array containing all the information pertaining to the additional fields


        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results