Since: 1.3.0

class StringContent extends AbstractLocalImage (View source)

Creates a LocalImage object with the content of an image as input.

For images on a accessible file system, better use \Rokka\Client\LocalImage\FileInfo

Example:

$image = new StringContent($content, $identifier, $context);

Properties

protected mixed|null $context

Can be anything and accessed in callbacks and such.

from  AbstractLocalImage
protected string|null $rokkaHash

The rokka hash from the rokka API.

from  AbstractLocalImage
protected string|null $identifier

A unique identifier for this image, can be any string.

from  AbstractLocalImage

Methods

__construct(string|null $image, 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.

string|null
getIdentifier()

Returns the unique custom identifier.

void
setIdentifier(string|null $identifier)

Sets the unique custom identifier.

mixed|null
getContext()

Returns the custom context.

void
setContext(mixed|null $context)

Sets the custom context.

string|null
getRokkaHash()

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

Details

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

No description

Parameters

string|null $image
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

string|null getContent()

Returns the actual content of an image.

Return Value

string|null

string|null getIdentifier()

Returns the unique custom identifier.

Return Value

string|null

void setIdentifier(string|null $identifier)

Since: 1.3.0

Sets the unique custom identifier.

Parameters

string|null $identifier

Return Value

void

mixed|null getContext()

Since: 1.3.0

Returns the custom context.

Return Value

mixed|null

void setContext(mixed|null $context)

Since: 1.3.0

Sets the custom context.

Parameters

mixed|null $context

Return Value

void

string|null 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

string|null