1. class
  2. Rokka
  3. \
  4. Client
  5. \
  6. Core
  7. \
  8. SourceImage

SourceImage

class SourceImage (View source)

Represents the metadata of an image.

Properties

string $organization
string $binaryHash
string $shortHash
string $hash
string $name
string $format
int $size
int $width
int $height
array $userMetadata
DynamicMetadataInterface[] $dynamicMetadata
array $staticMetadata
DateTime $created
$link

Methods

__construct(string $organization, string $binaryHash, string $hash, string $name, string $format, int $size, int $width, int $height, array $userMetadata, array $dynamicMetadata, array $staticMetadata, DateTime $created, string $link, string $shortHash = null)

Constructor.

static SourceImage
createFromJsonResponse(string|array $data, bool $isArray = false)

Create a source image from the JSON data.

Details

at line 101
__construct(string $organization, string $binaryHash, string $hash, string $name, string $format, int $size, int $width, int $height, array $userMetadata, array $dynamicMetadata, array $staticMetadata, DateTime $created, string $link, string $shortHash = null)

Constructor.

Parameters

string $organization Organization
string $binaryHash

Binary hash
string $hash Hash
string $name

Original name
string $format Format
int $size

File size in bytes
int $width

Width in pixels
int $height

Height in pixels
array $userMetadata

User metadata
array $dynamicMetadata

Dynamic metadata
array $staticMetadata
DateTime $created

Created at date
string $link

Link to the image
string $shortHash

The short hash

at line 144
static SourceImage createFromJsonResponse(string|array $data, bool $isArray = false)

Create a source image from the JSON data.

Parameters

string|array $data

JSON data
bool $isArray

If the data provided is already an array

Return Value

SourceImage