Since: 1.3.0

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

__construct(string|null $identifier = null, mixed|null $context = null)

No description

string|bool
getRealpath()

Returns the realPath of an image, if there is one.

string|null
getFilename()

Returns the filename of an image.

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.

Details

__construct(string|null $identifier = null, mixed|null $context = null)

Since: 1.3.0

No description

Parameters

string|null $identifier

A unique custom identifier for this image

mixed|null $context

Can be anything and accessed in callbacks and such

string|bool getRealpath()

Since: 1.3.0

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.

Return Value

string|bool

string|null getFilename()

Since: 1.3.0 This is used for nicer looking generated URLs, but optional

Returns the filename of an image.

Return Value

string|null

abstract string|null getContent()

Since: 1.3.0

Returns the actual content of an image.

Return Value

string|null

null|string getIdentifier()

Since: 1.3.0

Returns the unique custom identifier.

Return Value

null|string

setIdentifier(string|null $identifier)

Since: 1.3.0

Sets the unique custom identifier.

Parameters

string|null $identifier

mixed|null getContext()

Since: 1.3.0

Returns the custom context.

Return Value

mixed|null

setContext(mixed|null $context)

Since: 1.3.0

Sets the custom context.

Parameters

mixed|null $context

null|string getRokkaHash()

Since: 1.3.0

Returns the rokkaHash, in case the object knows it already.

Happens especially with the RokkaHash LocalImage class, but others may use it too

Return Value

null|string