QueryMotive extends Element
in package
Uses ElementTrait, IdentifiableElementTrait, ElementNameTrait, ElementDescriptionTrait

This is the query motive class.

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

Tags
see
Element
see
ElementTrait
see
IdentifiableElementTrait
see
ElementNameTrait
see
ElementDescriptionTrait

Table of Contents

$description  : string
$error  : Error|null
$id Autonumeric element id.  : int
$name  : string
__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getDescription() Returns the element description on the website current language.  : string
getError() Returns the current element error (if there is error).  : Error|null
getId() Returns the element id.  : int
getName() Returns the element name on the website current language.  : 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

$id

Autonumeric element id.

protected int $id = 0

All the given elements by the LogiCommerce API will send it.

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

getDescription()

Returns the element description on the website current language.

public getDescription() : string
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

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