ImageOptionValue
extends OptionValue
in package
Uses
ElementTrait
This is the basket product option image value class.
Tags
Table of Contents
| $basePrice | : float | |
|---|---|---|
| $error | : Error|null | |
| $id | Autonumeric element id. | : int |
| $longDescription | : string | |
| $noReturn | : bool | |
| $pId | Public and readable element id. | : string |
| $previousPrice | : float | |
| $price | : float | |
| $priority | : int | |
| $retailPrice | : float | |
| $shortDescription | : string | |
| $value | : string | |
| $weight | : float | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getBasePrice() | Returns the option value base price. | : float |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getImages() | Returns the option value images. | : Media|null |
| getLongDescription() | Returns the option value long description. | : string |
| getNoReturn() | Sets if the option value has to be refundable/returnable or not. | : bool |
| getPId() | Returns the element public id (pId). | : string |
| getPreviousPrice() | Returns the option value previous price. | : float |
| getPrice() | Returns the option value price. | : float |
| getPriority() | Returns the option value priority. | : int |
| getRetailPrice() | Returns the option value retail price. | : float |
| getShortDescription() | Returns the option value short description. | : string |
| getValue() | Returns the option value final value. | : string |
| 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> |
| setError() | : void |
Properties
$basePrice
protected
float
$basePrice
= 0.0
$error
protected
Error|null
$error
= null
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
$longDescription
protected
string
$longDescription
= ''
$noReturn
protected
bool
$noReturn
= false
$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.
$previousPrice
protected
float
$previousPrice
= 0.0
$price
protected
float
$price
= 0.0
$priority
protected
int
$priority
= 0
$retailPrice
protected
float
$retailPrice
= 0.0
$shortDescription
protected
string
$shortDescription
= ''
$value
protected
string
$value
= ''
$weight
protected
float
$weight
= 0.0
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 —getBasePrice()
Returns the option value base price.
public
getBasePrice() : float
Return values
float —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getId()
Returns the element id.
public
getId() : int
Return values
int —getImages()
Returns the option value images.
public
getImages() : Media|null
Return values
Media|null —getLongDescription()
Returns the option value long description.
public
getLongDescription() : string
Return values
string —getNoReturn()
Sets if the option value has to be refundable/returnable or not.
public
getNoReturn() : bool
Return values
bool —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getPreviousPrice()
Returns the option value previous price.
public
getPreviousPrice() : float
Return values
float —getPrice()
Returns the option value price.
public
getPrice() : float
Return values
float —getPriority()
Returns the option value priority.
public
getPriority() : int
Return values
int —getRetailPrice()
Returns the option value retail price.
public
getRetailPrice() : float
Return values
float —getShortDescription()
Returns the option value short description.
public
getShortDescription() : string
Return values
string —getValue()
Returns the option value final value.
public
getValue() : string
Return values
string —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> —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed