OptionValue
in package
Uses ElementTrait, IdentifiableElementTrait, IntegrableElementTrait

This is the Option Value class.

The options values information of API products will be stored in that class and will remain immutable (only get methods are available)

Tags
see
OptionValue::getImages()
see
OptionValue::getLanguage()
see
OptionValue::getPrices()
see
OptionValue::getPricesWithTaxes()
see
OptionValue::getPriority()
see
OptionValue::getWeight()
see
OptionValue::getNoReturn()
see
ElementTrait
see
IdentifiableElementTrait
see
IntegrableElementTrait

Table of Contents

$id Autonumeric element id.  : int
$pId Public and readable element id.  : string
__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getId() Returns the element id.  : int
getImages() Returns the product option value images.  : Media|null
getLanguage() Returns the option value language object.  : OptionValueLanguage|null
getNoReturn() Sets if the option value has to be refundable/returnable or not.  : bool
getPId() Returns the element public id (pId).  : string
getPrices() Returns the product option value prices.  : ItemPrices|null
getPricesWithTaxes() Returns the product option value prices (taxes included).  : ItemPrices|null
getPriority() Returns the option value priority.  : int
getShowPrices() Returns the product prices in function of the given setting.  : array<string|int, ItemPrices>
getWeight() Returns the 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>

Properties

$id

Autonumeric element id.

protected int $id = 0

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

$pId

Public and readable element id.

protected string $pId = ''

Setted by the user on LogiCommerce. All the integrable elements by the LogiCommerce API will send it. Useful for integrations and other 3rd party softwares that need to connect to LogiCommerce software.

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 —

getImages()

Returns the product option value images.

public getImages() : Media|null
Tags
see
Media
Return values
Media|null —

getNoReturn()

Sets if the option value has to be refundable/returnable or not.

public getNoReturn() : bool
Return values
bool —

getPriority()

Returns the option value priority.

public getPriority() : int
Return values
int —

getShowPrices()

Returns the product prices in function of the given setting.

public getShowPrices(bool $showTaxincluded) : array<string|int, ItemPrices>
Parameters
$showTaxincluded : bool
Tags
see
ItemPrices
Return values
array<string|int, ItemPrices> —

getWeight()

Returns the option value 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> —

Search results