RichDocumentItemPrices extends Element
in package
Uses ElementTrait

This is the rich document item prices class.

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

Tags
see
RichDocumentItemPrices::getProductPrice()
see
RichDocumentItemPrices::getProductPriceWithTaxes()
see
RichDocumentItemPrices::getOptionsPrice()
see
RichDocumentItemPrices::getOptionsPriceWithTaxes()
see
RichDocumentItemPrices::getPreviousPrice()
see
RichDocumentItemPrices::getPreviousPriceWithTaxes()
see
RichDocumentItemPrices::getPrice()
see
RichDocumentItemPrices::getPriceWithTaxes()
see
RichDocumentItemPrices::getTotalTaxesValue()
see
RichDocumentItemPrices::getTotalDiscountsValue()
see
RichDocumentItemPrices::getTotal()
see
RichDocumentItemPrices::getTotalWithDiscounts()
see
RichDocumentItemPrices::getTotalWithDiscountsWithTaxes()
see
Element
see
ElementTrait

Table of Contents

$error  : Error|null
$optionsPrice  : string
$optionsPriceWithTaxes  : string
$previousPrice  : string
$previousPriceWithTaxes  : string
$price  : string
$priceWithTaxes  : string
$productPrice  : string
$productPriceWithTaxes  : string
$total  : string
$totalDiscountsValue  : string
$totalTaxesValue  : string
$totalWithDiscounts  : string
$totalWithDiscountsWithTaxes  : string
__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
getOptionsPrice() Returns the rich document item prices optionsPrice.  : string
getOptionsPriceWithTaxes() Returns the rich document item prices optionsPriceWithTaxes.  : string
getPreviousPrice() Returns the rich document item prices previousPrice.  : string
getPreviousPriceWithTaxes() Returns the rich document item prices previousPriceWithTaxes.  : string
getPrice() Returns the rich document item prices price.  : string
getPriceWithTaxes() Returns the rich document item prices priceWithTaxes.  : string
getProductPrice() Returns the rich document item prices productPrice.  : string
getProductPriceWithTaxes() Returns the rich document item prices productPriceWithTaxes.  : string
getTotal() Returns the rich document item prices total.  : string
getTotalDiscountsValue() Returns the rich document item prices totalDiscountsValue.  : string
getTotalTaxesValue() Returns the rich document item prices totalTaxesValue.  : string
getTotalWithDiscounts() Returns the rich document item prices totalWithDiscounts.  : string
getTotalWithDiscountsWithTaxes() Returns the rich document item prices totalWithDiscountsWithTaxes.  : 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 —

getError()

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

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

getOptionsPrice()

Returns the rich document item prices optionsPrice.

public getOptionsPrice() : string
Return values
string —

getOptionsPriceWithTaxes()

Returns the rich document item prices optionsPriceWithTaxes.

public getOptionsPriceWithTaxes() : string
Return values
string —

getPreviousPrice()

Returns the rich document item prices previousPrice.

public getPreviousPrice() : string
Return values
string —

getPreviousPriceWithTaxes()

Returns the rich document item prices previousPriceWithTaxes.

public getPreviousPriceWithTaxes() : string
Return values
string —

getPrice()

Returns the rich document item prices price.

public getPrice() : string
Return values
string —

getPriceWithTaxes()

Returns the rich document item prices priceWithTaxes.

public getPriceWithTaxes() : string
Return values
string —

getProductPrice()

Returns the rich document item prices productPrice.

public getProductPrice() : string
Return values
string —

getProductPriceWithTaxes()

Returns the rich document item prices productPriceWithTaxes.

public getProductPriceWithTaxes() : string
Return values
string —

getTotal()

Returns the rich document item prices total.

public getTotal() : string
Return values
string —

getTotalDiscountsValue()

Returns the rich document item prices totalDiscountsValue.

public getTotalDiscountsValue() : string
Return values
string —

getTotalTaxesValue()

Returns the rich document item prices totalTaxesValue.

public getTotalTaxesValue() : string
Return values
string —

getTotalWithDiscounts()

Returns the rich document item prices totalWithDiscounts.

public getTotalWithDiscounts() : string
Return values
string —

getTotalWithDiscountsWithTaxes()

Returns the rich document item prices totalWithDiscountsWithTaxes.

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