ProcessedResourceInterface
interface \
- 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
boolexists()
public
exists() : bool
Return values
boolgetContents()
public
getContents() : string
Tags
Return values
stringgetExtension()
public
getExtension() : string
Return values
stringgetHash()
public
getHash() : string
Return values
stringgetImageDimension()
public
getImageDimension() : ImageDimension
Tags
Return values
ImageDimensiongetMimeType()
public
getMimeType() : string
Return values
stringgetName()
public
getName() : string
Return values
stringgetNameWithoutExtension()
public
getNameWithoutExtension() : string
Return values
stringgetOriginalResource()
public
getOriginalResource() : SystemResourceInterface
Return values
SystemResourceInterfacegetProcessingConfiguration()
Returns the processing configuration this resource was created for.
public
getProcessingConfiguration() : array
Return values
arraygetProperty()
public
getProperty(string $key) : mixed
Parameters
- $key : string
getPublicUrl()
public
getPublicUrl() : string|null
Return values
string|nullgetResourceIdentifier()
public
getResourceIdentifier() : string
Return values
stringgetSize()
Returns the size of the processed resource in bytes.
public
getSize() : int
Return values
intgetTaskIdentifier()
Returns the task type this resource was created for.
public
getTaskIdentifier() : string
Return values
stringisImage()
public
isImage() : bool
Tags
Return values
boolisNew()
public
isNew() : bool
Return values
boolisProcessed()
public
isProcessed() : bool
Return values
boolneedsReprocessing()
public
needsReprocessing() : bool
Return values
boolsetName()
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