CatalogSettings
extends Element
in package
Uses
ElementTrait
This is the catalog settings class.
The catalog settings will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAvailabilityId() | Returns the catalog settings availabilityId. | : int|null |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getProductComparisonActive() | Returns the catalog settings productComparisonActive. Specifies whether ProductComparison is enabled. | : bool |
| getProductComparisonMax() | Returns the catalog settings productComparisonMax. Specifies the configured maximum quantity of products that can be added to productComparison. | : int |
| getShowOfferPrice() | Returns the catalog settings showOfferPrice. | : bool |
| getShowOptionImages() | Returns the catalog settings showOptionImages. | : bool |
| getShowPrice() | Returns the catalog settings showPrice. | : bool |
| getShowStock() | Returns the catalog settings showStock. | : bool |
| getShowTaxesIncluded() | Returns the catalog settings showTaxesIncluded. | : 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> |
| setError() | : void |
Properties
$error
protected
Error|null
$error
= null
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 —getAvailabilityId()
Returns the catalog settings availabilityId.
public
getAvailabilityId() : int|null
Return values
int|null —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getProductComparisonActive()
Returns the catalog settings productComparisonActive. Specifies whether ProductComparison is enabled.
public
getProductComparisonActive() : bool
Return values
bool —getProductComparisonMax()
Returns the catalog settings productComparisonMax. Specifies the configured maximum quantity of products that can be added to productComparison.
public
getProductComparisonMax() : int
Return values
int —getShowOfferPrice()
Returns the catalog settings showOfferPrice.
public
getShowOfferPrice() : bool
Return values
bool —getShowOptionImages()
Returns the catalog settings showOptionImages.
public
getShowOptionImages() : bool
Return values
bool —getShowPrice()
Returns the catalog settings showPrice.
public
getShowPrice() : bool
Return values
bool —getShowStock()
Returns the catalog settings showStock.
public
getShowStock() : bool
Return values
bool —getShowTaxesIncluded()
Returns the catalog settings showTaxesIncluded.
public
getShowTaxesIncluded() : 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
Return values
array<string|int, mixed> —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed