‪TYPO3CMS  11.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\Resource\Processing\AbstractTask Class Reference
Inheritance diagram for TYPO3\CMS\Core\Resource\Processing\AbstractTask:
TYPO3\CMS\Core\Resource\Processing\TaskInterface TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask TYPO3\CMS\Core\Resource\Processing\ImagePreviewTask

Public Member Functions

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

Protected Member Functions

array getChecksumData ()
 
bool isValidConfiguration (array $configuration)
 

Protected Attributes

array $checksumData = array( )
 
Resource ProcessedFile $targetFile
 
Resource File $sourceFile
 
array $configuration
 
string $type
 
string $name
 
bool $executed = false
 
bool $successful
 

Detailed Description

Abstract base implementation of a task.

If you extend this class, make sure that you redefine the member variables $type and $name or set them in the constructor. Otherwise your task won't be recognized by the system and several things will fail.

Definition at line 30 of file AbstractTask.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Resource\Processing\AbstractTask::__construct ( ProcessedFile  $targetFile,
array  $configuration 
)
Parameters
Resource\ProcessedFile$targetFile
array$configuration

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

Definition at line 68 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\$configuration, TYPO3\CMS\Core\Resource\Processing\AbstractTask\$targetFile, and TYPO3\CMS\Core\Resource\ProcessedFile\getOriginalFile().

Member Function Documentation

◆ getChecksumData()

array TYPO3\CMS\Core\Resource\Processing\AbstractTask::getChecksumData ( )
protected

Sets parameters needed in the checksum. Can be overridden to add additional parameters to the checksum. 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.

Returns
‪array

Definition at line 82 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\AbstractFile\getModificationTime(), TYPO3\CMS\Core\Resource\Processing\AbstractTask\getName(), TYPO3\CMS\Core\Resource\Processing\AbstractTask\getSourceFile(), TYPO3\CMS\Core\Resource\Processing\AbstractTask\getType(), and TYPO3\CMS\Core\Resource\AbstractFile\getUid().

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractTask\getConfigurationChecksum().

◆ getConfiguration()

array TYPO3\CMS\Core\Resource\Processing\AbstractTask::getConfiguration ( )
Returns
‪array

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

Definition at line 179 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\$configuration.

◆ getConfigurationChecksum()

string TYPO3\CMS\Core\Resource\Processing\AbstractTask::getConfigurationChecksum ( )

Returns the checksum for this task's configuration, also taking the file and task type into account.

Returns
‪string

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

Definition at line 96 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\getChecksumData().

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask\getTargetFilename(), and TYPO3\CMS\Core\Resource\Processing\AbstractTask\getTargetFilename().

◆ getName()

string TYPO3\CMS\Core\Resource\Processing\AbstractTask::getName ( )

Returns the name of this task

Returns
‪string

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

Definition at line 129 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\$name.

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractTask\getChecksumData().

◆ getSourceFile()

Resource File TYPO3\CMS\Core\Resource\Processing\AbstractTask::getSourceFile ( )
Returns
‪Resource\File

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

Definition at line 163 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\$sourceFile.

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask\determineTargetFileExtension(), TYPO3\CMS\Core\Resource\Processing\AbstractTask\getChecksumData(), and TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask\getTargetFilename().

◆ getTargetFile()

Resource ProcessedFile TYPO3\CMS\Core\Resource\Processing\AbstractTask::getTargetFile ( )
Returns
‪Resource\ProcessedFile

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

Definition at line 147 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\$targetFile.

◆ getTargetFileExtension()

string TYPO3\CMS\Core\Resource\Processing\AbstractTask::getTargetFileExtension ( )

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

Returns
‪string

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

Reimplemented in TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask.

Definition at line 119 of file AbstractTask.php.

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractTask\getTargetFilename().

◆ getTargetFilename()

string TYPO3\CMS\Core\Resource\Processing\AbstractTask::getTargetFilename ( )

Returns the filename

Returns
‪string

Reimplemented in TYPO3\CMS\Core\Resource\Processing\AbstractGraphicalTask.

Definition at line 106 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\getConfigurationChecksum(), and TYPO3\CMS\Core\Resource\Processing\AbstractTask\getTargetFileExtension().

◆ getType()

string TYPO3\CMS\Core\Resource\Processing\AbstractTask::getType ( )

Returns the type of this task

Returns
‪string

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

Definition at line 139 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\$type.

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractTask\getChecksumData().

◆ isExecuted()

bool TYPO3\CMS\Core\Resource\Processing\AbstractTask::isExecuted ( )

Returns TRUE if this task has been executed, no matter if the execution was successful.

Returns
‪bool

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

Definition at line 198 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\$executed.

◆ isSuccessful()

bool TYPO3\CMS\Core\Resource\Processing\AbstractTask::isSuccessful ( )

Returns TRUE if this task has been successfully executed. Only call this method if the task has been processed at all.

Returns
‪bool
Exceptions

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

Definition at line 221 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\$successful.

◆ isValidConfiguration()

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

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 in TYPO3\CMS\Core\Resource\Processing\ImagePreviewTask, and TYPO3\CMS\Core\Resource\Processing\ImageCropScaleMaskTask.

◆ setExecuted()

TYPO3\CMS\Core\Resource\Processing\AbstractTask::setExecuted (   $successful)

Set this task executed. This is used by the Processors in order to transfer the state of this task to the file processing service.

Parameters
bool$successful‪Set this to FALSE if executing the task failed

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

Definition at line 209 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\$successful.

◆ setSourceFile()

TYPO3\CMS\Core\Resource\Processing\AbstractTask::setSourceFile ( File  $sourceFile)
Parameters
Resource\File$sourceFile

Definition at line 171 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\$sourceFile.

◆ setTargetFile()

TYPO3\CMS\Core\Resource\Processing\AbstractTask::setTargetFile ( ProcessedFile  $targetFile)
Parameters
Resource\ProcessedFile$targetFile

Definition at line 155 of file AbstractTask.php.

References TYPO3\CMS\Core\Resource\Processing\AbstractTask\$targetFile.

Member Data Documentation

◆ $checksumData

array TYPO3\CMS\Core\Resource\Processing\AbstractTask::$checksumData = array( )
protected

Definition at line 34 of file AbstractTask.php.

◆ $configuration

array TYPO3\CMS\Core\Resource\Processing\AbstractTask::$configuration
protected

Definition at line 46 of file AbstractTask.php.

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractTask\__construct(), and TYPO3\CMS\Core\Resource\Processing\AbstractTask\getConfiguration().

◆ $executed

bool TYPO3\CMS\Core\Resource\Processing\AbstractTask::$executed = false
protected

Definition at line 58 of file AbstractTask.php.

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractTask\isExecuted().

◆ $name

string TYPO3\CMS\Core\Resource\Processing\AbstractTask::$name
protected

Definition at line 54 of file AbstractTask.php.

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractTask\getName().

◆ $sourceFile

Resource File TYPO3\CMS\Core\Resource\Processing\AbstractTask::$sourceFile
protected

Definition at line 42 of file AbstractTask.php.

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractTask\getSourceFile(), and TYPO3\CMS\Core\Resource\Processing\AbstractTask\setSourceFile().

◆ $successful

bool TYPO3\CMS\Core\Resource\Processing\AbstractTask::$successful
protected

Definition at line 62 of file AbstractTask.php.

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractTask\isSuccessful(), and TYPO3\CMS\Core\Resource\Processing\AbstractTask\setExecuted().

◆ $targetFile

Resource ProcessedFile TYPO3\CMS\Core\Resource\Processing\AbstractTask::$targetFile
protected

Definition at line 38 of file AbstractTask.php.

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractTask\__construct(), TYPO3\CMS\Core\Resource\Processing\AbstractTask\getTargetFile(), and TYPO3\CMS\Core\Resource\Processing\AbstractTask\setTargetFile().

◆ $type

string TYPO3\CMS\Core\Resource\Processing\AbstractTask::$type
protected

Definition at line 50 of file AbstractTask.php.

Referenced by TYPO3\CMS\Core\Resource\Processing\AbstractTask\getType().