ImageCropScaleMaskTask

class \TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask

Extends
AbstractGraphicalTask

A task that takes care of cropping, scaling and/or masking an image.

Table of Contents

Properties

$checksumData  : array
$configuration  : array
$executed  : bool
$name  : string
$sourceFile  : File
$successful  : bool
$targetFile  : ProcessedFile
$targetFileExtension  : string|null
$type  : string

Methods

__construct()  : mixed
fileNeedsProcessing()  : bool
Returns TRUE if the file has to be processed at all, such as e.g. the original file does.
getConfiguration()  : array
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
Determines the file extension the processed file should have in the filesystem.
getTargetFilename()  : string
Returns the name the processed file should have in the filesystem.
getTargetFileName()  : string
Returns the name the processed file should have in the filesystem.
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
determineTargetFileExtension()  : string
Gets the file extension the processed file should have in the filesystem by either using the configuration setting, or the extension of the original file.
getChecksumData()  : array
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 $checksumData = []

$configuration

protected array $configuration

$name

protected string $name = 'CropScaleMask'

$targetFileExtension

protected string|null $targetFileExtension

Methods

fileNeedsProcessing()

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

public fileNeedsProcessing() : bool

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()?

Return values

bool

getConfiguration()

Returns the configuration for this task.

public getConfiguration() : array

Return values

array

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()

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

public getTargetFileExtension() : string

Return values

string

getTargetFilename()

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

public getTargetFilename() : string

Return values

string

getTargetFileName()

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

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

determineTargetFileExtension()

Gets the file extension the processed file should have in the filesystem by either using the configuration setting, or the extension of the original file.

protected determineTargetFileExtension() : string

Return values

string

getChecksumData()

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

protected getChecksumData() : array

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

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 isValidConfiguration(array $configuration) : bool

Parameters

$configuration : array

Return values

bool
On this page