AbstractLocalImage
abstract class AbstractLocalImage (View source)
The abstract class for representing local images.
Inherit from this, if your local images are not stored on the local file system or have other special needs.
See some implementation of the abstract class for examples.
Properties
| protected mixed|null | $context | Can be anything and accessed in callbacks and such. |
|
| protected string|null | $rokkaHash | The rokka hash from the rokka API. |
|
| protected string|null | $identifier | A unique identifier for this image, can be any string. |
Methods
No description
Returns the realPath of an image, if there is one.
Returns the filename of an image.
Returns the actual content of an image.
Returns the unique custom identifier.
Sets the unique custom identifier.
Returns the custom context.
Sets the custom context.
Returns the rokkaHash, in case the object knows it already.
Details
__construct(string|null $identifier = null, mixed|null $context = null)
No description
string|bool
getRealpath()
Returns the realPath of an image, if there is one.
If the file isn't on the local file system (or a stream, php understands), return false.
string|null
getFilename()
Returns the filename of an image.
abstract string|null
getContent()
Returns the actual content of an image.
null|string
getIdentifier()
Returns the unique custom identifier.
setIdentifier(string|null $identifier)
Sets the unique custom identifier.
mixed|null
getContext()
Returns the custom context.
setContext(mixed|null $context)
Sets the custom context.
null|string
getRokkaHash()
Returns the rokkaHash, in case the object knows it already.
Happens especially with the RokkaHash LocalImage class, but others may use it too