TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask Class Reference

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

Public Member Functions
string	getTargetFileName ()
	fileNeedsProcessing ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask
string	getTargetFilename ()
string	getTargetFileExtension ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Resource\Processing\AbstractTask
	__construct (ProcessedFile $targetFile, array $configuration)
string	getConfigurationChecksum ()
string	getName ()
string	getType ()
Resource ProcessedFile	getTargetFile ()
	setTargetFile (ProcessedFile $targetFile)
Resource File	getSourceFile ()
	setSourceFile (File $sourceFile)
array	getConfiguration ()
bool	isExecuted ()
	setExecuted ($successful)
bool	isSuccessful ()

Protected Member Functions
bool	isValidConfiguration (array $configuration)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask
string	determineTargetFileExtension ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Resource\Processing\AbstractTask
array	getChecksumData ()

Protected Attributes
string	$type = 'Image'
string	$name = 'CropScaleMask'
‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask
string null	$targetFileExtension
‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Resource\Processing\AbstractTask
array	$checksumData = array( )
Resource ProcessedFile	$targetFile
Resource File	$sourceFile
array	$configuration
string	$type
string	$name
bool	$executed = false
bool	$successful

Detailed Description

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

Definition at line 21 of file ImageCropScaleMaskTask.php.

Member Function Documentation

fileNeedsProcessing()

TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask::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()?

Returns

‪bool

Implements TYPO3\CMS\Core\Resource\Processing\TaskInterface.

Definition at line 51 of file ImageCropScaleMaskTask.php.

getTargetFileName()

string TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask::getTargetFileName

(

)

Returns

‪string

Implements TYPO3\CMS\Core\Resource\Processing\TaskInterface.

Definition at line 34 of file ImageCropScaleMaskTask.php.

isValidConfiguration()

bool TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask::isValidConfiguration ( array  $configuration )

protected

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.

Parameters

array

$configuration

Returns

‪bool

Reimplemented from TYPO3\CMS\Core\Resource\Processing\AbstractTask.

Definition at line 46 of file ImageCropScaleMaskTask.php.

Member Data Documentation

$name

string TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask::$name = 'CropScaleMask'

protected

Definition at line 29 of file ImageCropScaleMaskTask.php.

$type

string TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask::$type = 'Image'

protected

Definition at line 25 of file ImageCropScaleMaskTask.php.