License extends Element
in package
Uses ElementTrait, ElementNameTrait, EnumResolverTrait

This is the license class.

The license will be stored in that class and will remain immutable (only get methods are available)

Tags
see
Licenses::getPId()
see
Licenses::getType()
see
Licenses::getUnits()
see
Licenses::getPType()
see
Licenses::getParameters()
see
ElementTrait
see
ElementNameTrait
see
EnumResolverTrait
uses
ElementTrait
uses
ElementNameTrait
uses
EnumResolverTrait

Table of Contents

$error  : Error|null
$name  : string
$parameters  : array<string|int, mixed>
$pId  : string
$pType  : string
$type  : string
$units  : int
__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getError() Returns the current element error (if there is error).  : Error|null
getName() Returns the element name on the website current language.  : string
getParameters() Returns the license parameters.  : array<string|int, mixed>
getPId() Returns the license pId.  : string
getPType() Returns the license pPype.  : string
getType() Returns the license type.  : string
getUnits() Returns the license units.  : int
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
setParameters()  : void

Properties

$parameters

protected array<string|int, mixed> $parameters = []

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 —

getError()

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

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

getName()

Returns the element name on the website current language.

public getName() : string
Return values
string —

getParameters()

Returns the license parameters.

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

getPId()

Returns the license pId.

public getPId() : string
Return values
string —

getPType()

Returns the license pPype.

public getPType() : string
Return values
string —

getType()

Returns the license type.

public getType() : string
Return values
string —

getUnits()

Returns the license units.

public getUnits() : int
Return values
int —

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 —

setParameters()

protected setParameters(array<string|int, mixed> $parameters) : void
Parameters
$parameters : array<string|int, mixed>
Return values
void —

Search results