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

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

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

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

Protected Attributes
	$type = 'Image'
	$name = 'CropScaleMask'
Protected Attributes inherited from TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask
	$targetFileExtension
Protected Attributes inherited from TYPO3\CMS\Core\Resource\Processing\AbstractTask
	$checksumData = []
	$targetFile
	$sourceFile
	$configuration
	$type
	$name
	$executed = false
	$successful

Detailed Description

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

Definition at line 20 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 52 of file ImageCropScaleMaskTask.php.

getTargetFileName()

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

(

)

Returns

string

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

Definition at line 35 of file ImageCropScaleMaskTask.php.

isValidConfiguration()

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

Definition at line 47 of file ImageCropScaleMaskTask.php.

Member Data Documentation

$name

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

protected

Definition at line 30 of file ImageCropScaleMaskTask.php.

$type

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

protected

Definition at line 25 of file ImageCropScaleMaskTask.php.