AbstractTask implements TaskInterface

AbstractYes

Abstract base implementation of a task.

If you extend this class, make sure that you redefine the member variables $type and $name or set them in the constructor. Otherwise your task won't be recognized by the system and several things will fail.

Table of Contents

Interfaces

TaskInterface
A task is a unit of work that can be performed by a file processor. This may include multiple steps in any order, details depend on the configuration of the task and the tools the processor uses.

Properties

$checksumData  : array<string|int, mixed>
$configuration  : array<string|int, mixed>
$executed  : bool
$name  : string
$sourceFile  : File
$successful  : bool
$targetFile  : ProcessedFile
$type  : string

Methods

__construct()  : mixed
getConfiguration()  : array<string|int, mixed>
Returns the configuration for this task.
getConfigurationChecksum()  : string
Returns the checksum for this task's configuration, also taking the file and task type into account.
getName()  : string
Returns the name of this task
getSourceFile()  : File
Returns the original file this task is based on.
getTargetFile()  : ProcessedFile
Returns the processed file this task is executed on.
getTargetFileExtension()  : string
Gets the file extension the processed file should have in the filesystem.
getTargetFilename()  : string
Returns the filename
getType()  : string
Returns the type of this task
isExecuted()  : bool
Returns TRUE if this task has been executed, no matter if the execution was successful.
isSuccessful()  : bool
Returns TRUE if this task has been successfully executed. Only call this method if the task has been processed at all.
setExecuted()  : mixed
Set this task executed. This is used by the Processors in order to transfer the state of this task to the file processing service.
setSourceFile()  : mixed
setTargetFile()  : mixed
getChecksumData()  : array<string|int, mixed>
Sets parameters needed in the checksum. Can be overridden to add additional parameters to the checksum.
isValidConfiguration()  : bool
Checks if the given configuration is sensible for this task, i.e. if all required parameters are given, within the boundaries and don't conflict with each other.

Properties

$checksumData

protected array<string|int, mixed> $checksumData = []

$configuration

protected array<string|int, mixed> $configuration

Methods

__construct()

public __construct(ProcessedFile $targetFile, array<string|int, mixed> $configuration) : mixed
Parameters
$targetFile : ProcessedFile
$configuration : array<string|int, mixed>

getConfiguration()

Returns the configuration for this task.

public getConfiguration() : array<string|int, mixed>
Return values
array<string|int, mixed>

getConfigurationChecksum()

Returns the checksum for this task's configuration, also taking the file and task type into account.

public getConfigurationChecksum() : string
Return values
string

getName()

Returns the name of this task

public getName() : string
Return values
string

getSourceFile()

Returns the original file this task is based on.

public getSourceFile() : File
Return values
File

getTargetFileExtension()

Gets the file extension the processed file should have in the filesystem.

public getTargetFileExtension() : string
Return values
string

getTargetFilename()

Returns the filename

public getTargetFilename() : string
Return values
string

getType()

Returns the type of this task

public getType() : string
Return values
string

isExecuted()

Returns TRUE if this task has been executed, no matter if the execution was successful.

public isExecuted() : bool
Return values
bool

isSuccessful()

Returns TRUE if this task has been successfully executed. Only call this method if the task has been processed at all.

public isSuccessful() : bool
Tags
throws
LogicException

If the task has not been executed already

Return values
bool

setExecuted()

Set this task executed. This is used by the Processors in order to transfer the state of this task to the file processing service.

public setExecuted(bool $successful) : mixed
Parameters
$successful : bool

Set this to FALSE if executing the task failed

setSourceFile()

public setSourceFile(File $sourceFile) : mixed
Parameters
$sourceFile : File

getChecksumData()

Sets parameters needed in the checksum. Can be overridden to add additional parameters to the checksum.

protected getChecksumData() : array<string|int, mixed>

This should include all parameters that could possibly vary between different task instances, e.g. the TYPO3 image configuration in TYPO3_CONF_VARS[GFX] for graphic processing tasks.

Return values
array<string|int, mixed>

isValidConfiguration()

Checks if the given configuration is sensible for this task, i.e. if all required parameters are given, within the boundaries and don't conflict with each other.

protected abstract isValidConfiguration(array<string|int, mixed> $configuration) : bool
Parameters
$configuration : array<string|int, mixed>
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results