CategoryProperties
in package
Uses
ElementTrait
This is the Category Properties class.
The language information of API categories will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| __construct() | Elements constructor. | : mixed |
|---|---|---|
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getDefinitionId() | Returns the identifier of the category properties definition. | : int |
| getFareId() | Returns the identifier of the category properties fare. | : int |
| getPercentPrice() | Returns the category properties percent price. | : float |
| getPercentPriceOverrideCustomPrices() | Sets if the category properties percent price has to override the custom prices or not. | : bool |
| getShowBasePrice() | Sets if the category is supposed to show the base prices or not. | : bool |
| getUseRetailPrice() | Sets if the category properties will use the retail prices or not. | : bool |
| 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> |
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 —getDefinitionId()
Returns the identifier of the category properties definition.
public
getDefinitionId() : int
Return values
int —getFareId()
Returns the identifier of the category properties fare.
public
getFareId() : int
Return values
int —getPercentPrice()
Returns the category properties percent price.
public
getPercentPrice() : float
Return values
float —getPercentPriceOverrideCustomPrices()
Sets if the category properties percent price has to override the custom prices or not.
public
getPercentPriceOverrideCustomPrices() : bool
Return values
bool —getShowBasePrice()
Sets if the category is supposed to show the base prices or not.
public
getShowBasePrice() : bool
Return values
bool —getUseRetailPrice()
Sets if the category properties will use the retail prices or not.
public
getUseRetailPrice() : bool
Return values
bool —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