TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
ImagePreviewTask Class Reference
Inheritance diagram for ImagePreviewTask:
AbstractGraphicalTask AbstractTask TaskInterface

Public Member Functions

 getTargetFileName ()
 
 fileNeedsProcessing ()
 
- Public Member Functions inherited from AbstractGraphicalTask
 getTargetFilename ()
 
 getTargetFileExtension ()
 
- Public Member Functions inherited from 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 AbstractGraphicalTask
 determineTargetFileExtension ()
 
- Protected Member Functions inherited from AbstractTask
 getChecksumData ()
 
 isValidConfiguration (array $configuration)
 

Protected Attributes

 $type = 'Image'
 
 $name = 'Preview'
 
- Protected Attributes inherited from AbstractGraphicalTask
 $targetFileExtension
 
- Protected Attributes inherited from AbstractTask
 $checksumData = []
 
 $targetFile
 
 $sourceFile
 
 $configuration
 
 $type
 
 $name
 
 $executed = false
 
 $successful
 

Detailed Description

A task for generating an image preview.

Definition at line 20 of file ImagePreviewTask.php.

Member Function Documentation

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

Checks to perform:

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

Implements TaskInterface.

Definition at line 66 of file ImagePreviewTask.php.

getTargetFileName ( )

Returns the target filename for this task.

Returns
string

Implements TaskInterface.

Definition at line 37 of file ImagePreviewTask.php.

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

Checks to perform:

  • width and/or height given, integer values?

Definition at line 49 of file ImagePreviewTask.php.

Member Data Documentation

$name = 'Preview'
protected

Definition at line 30 of file ImagePreviewTask.php.

$type = 'Image'
protected

Definition at line 25 of file ImagePreviewTask.php.