EcommerceSettings
extends Element
in package
Uses
ElementTrait
This is the settings class.
The 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 |
| getCatalogSettings() | Returns the catalog settings. | : CatalogSettings|null |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getGeneralSettings() | Returns the general settings. | : GeneralSettings|null |
| getGeoIPSettings() | Returns the geoIP settings. | : GeoIPSettings|null |
| getLegalSettings() | Returns the legal settings. | : LegalSettings|null |
| getMode() | Returns the ecommerce mode. | : string |
| getOrdersSettings() | Returns the orders settings. | : OrdersSettings|null |
| getSeoSettings() | Returns the seo settings. | : SeoSettings|null |
| getSitemapSettings() | Returns the sitemap settings. | : SitemapSettings|null |
| getStockSettings() | Returns the stock settings. | : StockSettings|null |
| getTaxSettings() | Returns the tax settings. | : TaxSettings|null |
| getUserAccountsSettings() | Returns the userAccounts settings. | : UserAccountsSettings|null |
| 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 —getCatalogSettings()
Returns the catalog settings.
public
getCatalogSettings() : CatalogSettings|null
Return values
CatalogSettings|null —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getGeneralSettings()
Returns the general settings.
public
getGeneralSettings() : GeneralSettings|null
Return values
GeneralSettings|null —getGeoIPSettings()
Returns the geoIP settings.
public
getGeoIPSettings() : GeoIPSettings|null
Return values
GeoIPSettings|null —getLegalSettings()
Returns the legal settings.
public
getLegalSettings() : LegalSettings|null
Return values
LegalSettings|null —getMode()
Returns the ecommerce mode.
public
getMode() : string
Return values
string —getOrdersSettings()
Returns the orders settings.
public
getOrdersSettings() : OrdersSettings|null
Return values
OrdersSettings|null —getSeoSettings()
Returns the seo settings.
public
getSeoSettings() : SeoSettings|null
Return values
SeoSettings|null —getSitemapSettings()
Returns the sitemap settings.
public
getSitemapSettings() : SitemapSettings|null
Return values
SitemapSettings|null —getStockSettings()
Returns the stock settings.
public
getStockSettings() : StockSettings|null
Return values
StockSettings|null —getTaxSettings()
Returns the tax settings.
public
getTaxSettings() : TaxSettings|null
Return values
TaxSettings|null —getUserAccountsSettings()
Returns the userAccounts settings.
public
getUserAccountsSettings() : UserAccountsSettings|null
Return values
UserAccountsSettings|null —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