1. class
  2. Rokka
  3. \
  4. Client
  5. \
  6. Core
  7. \
  8. DynamicMetadata
  9. \
  10. SubjectArea

SubjectArea

class SubjectArea implements DynamicMetadataInterface (View source)

Properties

int $width
int $height
int $x
int $y

Methods

__construct(int $x, int $y, int $width = 1, int $height = 1)

SubjectArea constructor.

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

Create a SubjectArea from the JSON data.

static string
getName()

No description

mixed
getForJson()

Get the data, which should be json-fied later.

Details

at line 39
__construct(int $x, int $y, int $width = 1, int $height = 1)

SubjectArea constructor.

The SubjectArea can also be defined as a point, by setting both "width" and "height" to 1.

Parameters

int $x

X-point of the subject area, 0-based
int $y

Y-point of the subject area, 0-based
int $width

The width of the subject area box, default to 1px
int $height

The height of the subject area box, default to 1px

Exceptions

InvalidArgumentException

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

Create a SubjectArea from the JSON data.

Parameters

string|array $data

JSON data
bool $isArray

If the data provided is already an array

Return Value

DynamicMetadataInterface

at line 83
static string getName()

No description

Return Value

string

The name of the metadata

at line 88
mixed getForJson()

Get the data, which should be json-fied later.

Return Value

mixed