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

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

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 (Resource\ProcessedFile $targetFile, array $configuration)
string	getConfigurationChecksum ()
string	getName ()
string	getType ()
Resource ProcessedFile	getTargetFile ()
	setTargetFile (Resource\ProcessedFile $targetFile)
Resource File	getSourceFile ()
	setSourceFile (Resource\File $sourceFile)
array	getConfiguration ()
bool	isExecuted ()
	setExecuted ($successful)
bool	isSuccessful ()

Protected Member Functions
	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 = 'Preview'
‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask
string	$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 for generating an image preview.

Definition at line 20 of file ImagePreviewTask.php.

Member Function Documentation

fileNeedsProcessing()

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

Checks to perform:

• ‪width/height smaller than image, keeping aspect ratio?

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

Definition at line 61 of file ImagePreviewTask.php.

getTargetFileName()

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

(

)

Returns the target filename for this task.

Returns

‪string

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

Definition at line 35 of file ImagePreviewTask.php.

isValidConfiguration()

TYPO3\CMS\Core\Resource\Processing\ImagePreviewTask::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

Checks to perform:

• ‪width and/or height given, integer values?

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

Definition at line 46 of file ImagePreviewTask.php.

Member Data Documentation

$name

string TYPO3\CMS\Core\Resource\Processing\ImagePreviewTask::$name = 'Preview'

protected

Definition at line 28 of file ImagePreviewTask.php.

$type

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

protected

Definition at line 24 of file ImagePreviewTask.php.