RichDocumentItemOptionValue extends Element
in package
Uses ElementTrait

This is the rich document item option value class.

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

Tags
see

RichDocumentItemOptionValue::getWeight();

see

RichDocumentItemOptionValue::getPrice();

see

RichDocumentItemOptionValue::getPriceWithTaxes();

see

RichDocumentItemOptionValue::getPreviousPrice();

see

RichDocumentItemOptionValue::getPreviousPriceWithTaxes();

see

RichDocumentItemOptionValue::getValue();

see

RichDocumentItemOptionValue::getOptionValuePId();

see

RichDocumentItemOptionValue::getNoReturn();

see
Element
see
ElementTrait

Table of Contents

$error  : Error|null
$noReturn  : bool
$optionValuePId  : string
$previousPrice  : string
$previousPriceWithTaxes  : string
$price  : string
$priceWithTaxes  : string
$value  : string
$weight  : float
__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
getNoReturn() Returns the rich document item option value noReturn.  : bool
getOptionValuePId() Returns the rich document item option value optionValuePId.  : string
getPreviousPrice() Returns the rich document item option value previousPrice.  : string
getPreviousPriceWithTaxes() Returns the rich document item option value previousPrice.  : string
getPrice() Returns the rich document item option value price.  : string
getPriceWithTaxes() Returns the rich document item option value priceWithTaxes.  : string
getValue() Returns the rich document item option value previousPrice.  : string
getWeight() Returns the rich document item option value weight.  : float
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 —

getError()

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

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

getNoReturn()

Returns the rich document item option value noReturn.

public getNoReturn() : bool
Return values
bool —

getOptionValuePId()

Returns the rich document item option value optionValuePId.

public getOptionValuePId() : string
Return values
string —

getPreviousPrice()

Returns the rich document item option value previousPrice.

public getPreviousPrice() : string
Return values
string —

getPreviousPriceWithTaxes()

Returns the rich document item option value previousPrice.

public getPreviousPriceWithTaxes() : string
Return values
string —

getPriceWithTaxes()

Returns the rich document item option value priceWithTaxes.

public getPriceWithTaxes() : string
Return values
string —

getValue()

Returns the rich document item option value previousPrice.

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