Asset extends Element
in package
Uses ElementTrait, EnumResolverTrait

This is the Asset class.

The scripts of the API Assets will be stored in that class and will remain immutable (only get methods are available)

Tags
see
Asset::getCode()
see
Asset::getAmbience()
see
Asset::getPosition()
see
Asset::getType()
see
Element
see
ElementTrait
see
EnumResolverTrait

Table of Contents

$error  : Error|null
__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getAmbience() Returns the tracker script ambience.  : string
getError() Returns the current element error (if there is error).  : Error|null
getPath() Returns the tracker script path.  : string
getPosition() Returns the tracker script position.  : string
getType() Returns the tracker script type.  : string
jsonSerialize() Allow elements to be serialized.  : array<string|int, mixed>
toArray() Used to allow elements to be serialized.  : array<string|int, mixed>
getFieldItem()  : object|null
getFormattedData()  : mixed
setArrayField() Convert an API array of objects to a PHP array of objects.  : array<string|int, mixed>
setError()  : void

Properties

Methods

__construct()

Elements constructor.

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []

Array that contains all the values to the object to initialize

Return values
mixed —

__toString()

Uses "json_encode" function to return the JSON format of the element.

public __toString() : string

Auto-invoked using echo or concatenations.

Return values
string —

getAmbience()

Returns the tracker script ambience.

public getAmbience() : string
Return values
string —

getError()

Returns the current element error (if there is error).

public getError() : Error|null
Return values
Error|null —

getPath()

Returns the tracker script path.

public getPath() : string
Return values
string —

getPosition()

Returns the tracker script position.

public getPosition() : string
Return values
string —

getType()

Returns the tracker script type.

public getType() : string
Return values
string —

jsonSerialize()

Allow elements to be serialized.

public jsonSerialize() : array<string|int, mixed>

Auto-invoked using "json_encode" function.

Return values
array<string|int, mixed> —

toArray()

Used to allow elements to be serialized.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getFieldItem()

protected getFieldItem(array<string|int, mixed> $item, string $class) : object|null
Parameters
$item : array<string|int, mixed>
$class : string
Return values
object|null —

getFormattedData()

protected getFormattedData(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

setArrayField()

Convert an API array of objects to a PHP array of objects.

protected setArrayField(array<string|int, mixed> $data, string $class) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Array that contains all the values to the objects to initialize

$class : string

The PHP class we want the objects to be

Return values
array<string|int, mixed> —

setError()

protected setError(mixed $error) : void
Parameters
$error : mixed
Return values
void —

Search results