GeneralSettings
extends Element
in package
Uses
ElementTrait, ElementNameTrait, ElementDescriptionTrait
This is the general settings class.
The general settings will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $description | : string | |
|---|---|---|
| $error | : Error|null | |
| $name | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getActive() | Returns the general settings active. | : bool |
| getCdnAssets() | Returns the general settings assets CDN. | : string |
| getCdnImages() | Returns the general settings images CDN. | : string |
| getDefaultCountry() | Returns the general settings default country (ISO code). | : string |
| getDefaultCurrency() | Returns the general settings default currency. | : string |
| getDefaultLanguage() | Returns the general settings default language. | : string |
| getDescription() | Returns the element description on the website current language. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getlanguages() | Returns the general settings by language. | : array<string|int, SettingsLanguages> |
| getLogo() | Returns the general settings logo. | : string |
| getMerchantEmail() | Returns the general settings merchant email. | : string |
| getMerchantInformation() | Returns the general settings merchant information. | : string |
| getName() | Returns the element name on the website current language. | : string |
| getPhone() | Returns the general settings phone. | : string |
| getStoreURL() | Returns the general settings store URL. | : string |
| getTimeZone() | Returns the general settings time zone. | : string |
| getWeightUnits() | Returns the general settings weight units. | : string |
| 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 | |
| setlanguages() | : void |
Properties
$description
protected
string
$description
= ''
$error
protected
Error|null
$error
= null
$name
protected
string
$name
= ''
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 —getActive()
Returns the general settings active.
public
getActive() : bool
Return values
bool —getCdnAssets()
Returns the general settings assets CDN.
public
getCdnAssets() : string
Return values
string —getCdnImages()
Returns the general settings images CDN.
public
getCdnImages() : string
Return values
string —getDefaultCountry()
Returns the general settings default country (ISO code).
public
getDefaultCountry() : string
Return values
string —getDefaultCurrency()
Returns the general settings default currency.
public
getDefaultCurrency() : string
Return values
string —getDefaultLanguage()
Returns the general settings default language.
public
getDefaultLanguage() : string
Return values
string —getDescription()
Returns the element description on the website current language.
public
getDescription() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getlanguages()
Returns the general settings by language.
public
getlanguages() : array<string|int, SettingsLanguages>
Return values
array<string|int, SettingsLanguages> —getLogo()
Returns the general settings logo.
public
getLogo() : string
Return values
string —getMerchantEmail()
Returns the general settings merchant email.
public
getMerchantEmail() : string
Return values
string —getMerchantInformation()
Returns the general settings merchant information.
public
getMerchantInformation() : string
Return values
string —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getPhone()
Returns the general settings phone.
public
getPhone() : string
Return values
string —getStoreURL()
Returns the general settings store URL.
public
getStoreURL() : string
Return values
string —getTimeZone()
Returns the general settings time zone.
public
getTimeZone() : string
Return values
string —getWeightUnits()
Returns the general settings weight units.
public
getWeightUnits() : string
Return values
string —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
Return values
void —setlanguages()
protected
setlanguages(array<string|int, mixed> $languages) : void
Parameters
- $languages : array<string|int, mixed>