ProcessedResourceInterface

interface \TYPO3\CMS\Core\Resource\ProcessedResourceInterface

Extends
SystemResourceInterface

A resource that is the result of processing (resizing, cropping, converting, ...) another, original resource - implemented by both the FAL-backed ProcessedFile and, for resources outside the File Abstraction Layer, ProcessedResource.

This interface is public API and can be referenced in third party code, for example by a ResourceAwareProcessorInterface implementation working on a task's target file. Implementations of this interface are internal though.

Table of Contents

Methods

delete()  : bool
exists()  : bool
getContents()  : string
getExtension()  : string
getHash()  : string
getImageDimension()  : ImageDimension
getMimeType()  : string
getName()  : string
getNameWithoutExtension()  : string
getOriginalResource()  : SystemResourceInterface
getProcessingConfiguration()  : array
Returns the processing configuration this resource was created for.
getProperty()  : mixed
getPublicUrl()  : string|null
getResourceIdentifier()  : string
getSize()  : int
Returns the size of the processed resource in bytes.
getTaskIdentifier()  : string
Returns the task type this resource was created for.
isImage()  : bool
isNew()  : bool
isProcessed()  : bool
needsReprocessing()  : bool
setName()  : void
setUsesOriginalFile()  : void
Defines that the original resource should be used as-is, since no processing was needed.
updateProperties()  : void
updateWithLocalFile()  : void
Injects a local file, which is a processing result, into the object.
usesOriginalFile()  : bool

Methods

delete()

public delete() : bool

Return values

bool

exists()

public exists() : bool

Return values

bool

getExtension()

public getExtension() : string

Return values

string

getHash()

public getHash() : string

Return values

string

getMimeType()

public getMimeType() : string

Return values

string

getName()

public getName() : string

Return values

string

getNameWithoutExtension()

public getNameWithoutExtension() : string

Return values

string

getProcessingConfiguration()

Returns the processing configuration this resource was created for.

public getProcessingConfiguration() : array

Return values

array

getProperty()

public getProperty(string $key) : mixed

Parameters

$key : string

getPublicUrl()

public getPublicUrl() : string|null

Return values

string|null

getResourceIdentifier()

public getResourceIdentifier() : string

Return values

string

getSize()

Returns the size of the processed resource in bytes.

public getSize() : int

Return values

int

getTaskIdentifier()

Returns the task type this resource was created for.

public getTaskIdentifier() : string

Return values

string

isNew()

public isNew() : bool

Return values

bool

isProcessed()

public isProcessed() : bool

Return values

bool

needsReprocessing()

public needsReprocessing() : bool

Return values

bool

setName()

public setName(string $name) : void

Parameters

$name : string

setUsesOriginalFile()

Defines that the original resource should be used as-is, since no processing was needed.

public setUsesOriginalFile() : void

updateProperties()

public updateProperties(array $properties) : void

Parameters

$properties : array

updateWithLocalFile()

Injects a local file, which is a processing result, into the object.

public updateWithLocalFile(string $localFilePath) : void

Parameters

$localFilePath : string

usesOriginalFile()

public usesOriginalFile() : bool

Return values

bool
On this page