TYPO3\CMS\Core\Resource\Processing\TaskInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Core\Resource\Processing\TaskInterface:

Public Member Functions
	getName ()
	getType ()
	getTargetFile ()
	getSourceFile ()
	getConfiguration ()
	getConfigurationChecksum ()
	getTargetFileName ()
	getTargetFileExtension ()
	fileNeedsProcessing ()
	isExecuted ()
	setExecuted (bool $successful)
	isSuccessful ()
	sanitizeConfiguration ()

Detailed Description

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.

Each task has a type and a name. The type describes the category of the task, like "image" and "video". If your task is generic or applies to multiple types of files, use "general".

A task also already has to know the target file it should be executed on, so there is no "abstract" task that just specifies the steps to be executed without a concrete file. However, new tasks can easily be created from an existing task object.

Definition at line 33 of file TaskInterface.php.

Member Function Documentation

fileNeedsProcessing()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::fileNeedsProcessing

(

)

Returns TRUE if the file has to be processed at all, such as e.g. the original file does.

Note: This does not indicate if the concrete ProcessedFile attached to this task has to be (re)processed. This check is done in ProcessedFile::isOutdated().

Todo:

‪isOutdated()/needsReprocessing()?

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask.

getConfiguration()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::getConfiguration

(

)

Returns the configuration for this task.

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask.

Referenced by TYPO3\CMS\Core\Resource\Processing\LocalPreviewHelper\process(), TYPO3\CMS\Core\Resource\Processing\LocalCropScaleMaskHelper\processWithLocalFile(), and TYPO3\CMS\Core\Resource\Processing\LocalPreviewHelper\processWithLocalFile().

getConfigurationChecksum()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::getConfigurationChecksum

(

)

Returns the configuration checksum of this task.

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask.

Referenced by TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\applyCropping(), TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\checkForExistingTargetFile(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\checkForExistingTargetFile(), TYPO3\CMS\Backend\Resource\Processing\DeferredBackendImageProcessor\processTask(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\processTask(), and TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\processTaskWithLocalFile().

getName()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::getName

(

)

Returns the name of this task.

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask, TYPO3\CMS\Core\Resource\Processing\ImagePreviewTask, and TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask.

Referenced by TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\canProcessTask(), TYPO3\CMS\Backend\Resource\Processing\DeferredBackendImageProcessor\canProcessTask(), TYPO3\CMS\Core\Resource\OnlineMedia\Processing\PreviewProcessing\canProcessTask(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\canProcessTask(), TYPO3\CMS\Core\Resource\Processing\ProcessorRegistry\getProcessorByTask(), and TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\processTaskWithLocalFile().

getSourceFile()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::getSourceFile

(

)

Returns the original file this task is based on.

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask.

Referenced by TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\applyCropping(), TYPO3\CMS\Backend\Resource\Processing\DeferredBackendImageProcessor\canProcessTask(), TYPO3\CMS\Core\Resource\OnlineMedia\Processing\PreviewProcessing\canProcessTask(), TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\checkForExistingTargetFile(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\checkForExistingTargetFile(), TYPO3\CMS\Core\Resource\Processing\LocalCropScaleMaskHelper\process(), TYPO3\CMS\Core\Resource\Processing\LocalPreviewHelper\process(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\processTask(), TYPO3\CMS\Core\Resource\OnlineMedia\Processing\PreviewProcessing\processTask(), and TYPO3\CMS\Core\Resource\Processing\LocalCropScaleMaskHelper\processWithLocalFile().

getTargetFile()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::getTargetFile

(

)

Returns the processed file this task is executed on.

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask.

Referenced by TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\applyCropping(), TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\checkForExistingTargetFile(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\checkForExistingTargetFile(), TYPO3\CMS\Core\Resource\Processing\LocalCropScaleMaskHelper\getFilenameForImageCropScaleMask(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\getFilenameForSvgCropScaleMask(), TYPO3\CMS\Backend\Resource\Processing\DeferredBackendImageProcessor\processTask(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\processTask(), TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\processTaskWithLocalFile(), and TYPO3\CMS\Core\Resource\Processing\LocalCropScaleMaskHelper\processWithLocalFile().

getTargetFileExtension()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::getTargetFileExtension

(

)

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

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask, TYPO3\CMS\Core\Resource\Processing\ImagePreviewTask, and TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask.

Referenced by TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\canProcessTask(), TYPO3\CMS\Core\Resource\Processing\LocalCropScaleMaskHelper\getFilenameForImageCropScaleMask(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\getFilenameForSvgCropScaleMask(), TYPO3\CMS\Core\Resource\Processing\LocalPreviewHelper\getTemporaryFilePath(), and TYPO3\CMS\Core\Resource\Processing\LocalCropScaleMaskHelper\processWithLocalFile().

getTargetFileName()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::getTargetFileName

(

)

Returns the name the processed file should have in the filesystem.

Implemented in TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask.

Referenced by TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\applyCropping(), TYPO3\CMS\Backend\Resource\Processing\DeferredBackendImageProcessor\canProcessTask(), TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\checkForExistingTargetFile(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\checkForExistingTargetFile(), TYPO3\CMS\Backend\Resource\Processing\DeferredBackendImageProcessor\processTask(), and TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\processTaskWithLocalFile().

getType()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::getType

(

)

Returns the type of this task.

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask, TYPO3\CMS\Core\Resource\Processing\ImagePreviewTask, and TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask.

Referenced by TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\canProcessTask(), TYPO3\CMS\Backend\Resource\Processing\DeferredBackendImageProcessor\canProcessTask(), TYPO3\CMS\Core\Resource\OnlineMedia\Processing\PreviewProcessing\canProcessTask(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\canProcessTask(), and TYPO3\CMS\Core\Resource\Processing\ProcessorRegistry\getProcessorByTask().

isExecuted()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::isExecuted

(

)

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

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask.

isSuccessful()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::isSuccessful

(

)

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

Exceptions

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask.

sanitizeConfiguration()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::sanitizeConfiguration

(

)

For some tasks it might be important and useful to clean up the configuration, in order to find the ProcessedFile that uses this configuration.

Ideally, a task has some information what needs to be used or not.

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask, and TYPO3\CMS\Core\Resource\Processing\ImagePreviewTask.

Referenced by TYPO3\CMS\Core\Resource\Processing\LocalPreviewHelper\process().

setExecuted()

TYPO3\CMS\Core\Resource\Processing\TaskInterface::setExecuted

(

bool

$successful

)

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

Parameters

bool

$successful

‪Set this to FALSE if executing the task failed

Implemented in TYPO3\CMS\Core\Resource\Processing\AbstractTask.

Referenced by TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\applyCropping(), TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\checkForExistingTargetFile(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\checkForExistingTargetFile(), TYPO3\CMS\Backend\Resource\Processing\DeferredBackendImageProcessor\processTask(), TYPO3\CMS\Core\Resource\Processing\SvgImageProcessor\processTask(), and TYPO3\CMS\Core\Resource\Processing\LocalImageProcessor\processTaskWithLocalFile().