RichDocumentItemOption extends Element
in package
Uses ElementTrait, EnumResolverTrait

This is the rich document item option class.

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

Tags
see

RichDocumentItemOption::getValues();

see

RichDocumentItemOption::getSku();

see

RichDocumentItemOption::getName();

see

RichDocumentItemOption::getPrompt();

see

RichDocumentItemOption::getValue();

see

RichDocumentItemOption::getPrice();

see

RichDocumentItemOption::getPriceWithTaxes();

see

RichDocumentItemOption::getWeight();

see

RichDocumentItemOption::getUniquePricese();

see

RichDocumentItemOption::getValueType();

see

RichDocumentItemOption::getPreviousPrice();

see

RichDocumentItemOption::getPreviousPriceWithTaxes();

see

RichDocumentItemOption::getOptionPId();

see

RichDocumentItemOption::getCombinable();

see
Element
see
ElementTrait
see
EnumResolverTrait

Table of Contents

$combinable  : bool
$error  : Error|null
$name  : string
$optionPId  : string
$previousPrice  : string
$previousPriceWithTaxes  : string
$price  : string
$priceWithTaxes  : string
$prompt  : string
$sku  : string
$uniquePrice  : bool
$value  : string
$values  : array<string|int, mixed>
$valueType  : string
$weight  : float
__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getCombinable() Returns the rich document item option combinable.  : bool
getError() Returns the current element error (if there is error).  : Error|null
getName() Returns the rich document item option name.  : string
getOptionPId() Returns the rich document item option optionPId.  : string
getPreviousPrice() Returns the rich document item option previousPrice.  : string
getPreviousPriceWithTaxes() Returns the rich document item option previousPriceWithTaxes.  : string
getPrice() Returns the rich document item option price.  : string
getPriceWithTaxes() Returns the rich document item option priceWithTaxes.  : string
getPrompt() Returns the rich document item option prompt.  : string
getSku() Returns the rich document item option sku.  : string
getUniquePrice() Returns the rich document item option uniquePrice.  : bool
getValue() Returns the rich document item option value.  : string
getValues() Returns the rich document item option values.  : array<string|int, RichDocumentItemOptionValue>
getValueType() Returns the rich document item option valueType.  : string
getWeight() Returns the rich document item option 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
setValues()  : 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 —

getCombinable()

Returns the rich document item option combinable.

public getCombinable() : bool
Return values
bool —

getError()

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

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

getName()

Returns the rich document item option name.

public getName() : string
Return values
string —

getOptionPId()

Returns the rich document item option optionPId.

public getOptionPId() : string
Return values
string —

getPreviousPrice()

Returns the rich document item option previousPrice.

public getPreviousPrice() : string
Return values
string —

getPreviousPriceWithTaxes()

Returns the rich document item option previousPriceWithTaxes.

public getPreviousPriceWithTaxes() : string
Return values
string —

getPrice()

Returns the rich document item option price.

public getPrice() : string
Return values
string —

getPriceWithTaxes()

Returns the rich document item option priceWithTaxes.

public getPriceWithTaxes() : string
Return values
string —

getPrompt()

Returns the rich document item option prompt.

public getPrompt() : string
Return values
string —

getSku()

Returns the rich document item option sku.

public getSku() : string
Return values
string —

getUniquePrice()

Returns the rich document item option uniquePrice.

public getUniquePrice() : bool
Return values
bool —

getValue()

Returns the rich document item option value.

public getValue() : string
Return values
string —

getValueType()

Returns the rich document item option valueType.

public getValueType() : string
Return values
string —

getWeight()

Returns the rich document item option weight.

public getWeight() : float
Return values
float —

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 —

setValues()

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

Search results