SitemapSettings
extends Element
in package
Uses
ElementTrait, EnumResolverTrait
This is the sitemap settings class.
The sitemap 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 |
| getActive() | Returns if the sitemap is active or not. | : bool |
| getCompression() | Returns if the sitemap is compressed or not. | : bool |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getIncludeBlog() | Returns if the sitemap will include the blog or not. | : bool |
| getIncludeCategories() | Returns if the sitemap will include subcategories or not. | : bool |
| getIncludeNews() | Returns if the sitemap will include news or not. | : bool |
| getIncludePages() | Returns if the sitemap will include pages or not. | : bool |
| getIncludeProducts() | Returns if the sitemap will include products or not. | : bool |
| getSplitLanguages() | Returns if the sitemap is splitted by languages or not. | : bool |
| getSplitTypes() | Returns if the sitemap is splitted by types or not. | : bool |
| getStockType() | Returns the sitemap stock type. | : string |
| getUpdateInterval() | Returns the sitemap update interval. | : int |
| getUpdateIntervalMultiplier() | Returns the sitemap interval multiplier. | : 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 |
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 —getActive()
Returns if the sitemap is active or not.
public
getActive() : bool
Return values
bool —getCompression()
Returns if the sitemap is compressed or not.
public
getCompression() : bool
Return values
bool —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getIncludeBlog()
Returns if the sitemap will include the blog or not.
public
getIncludeBlog() : bool
Return values
bool —getIncludeCategories()
Returns if the sitemap will include subcategories or not.
public
getIncludeCategories() : bool
Return values
bool —getIncludeNews()
Returns if the sitemap will include news or not.
public
getIncludeNews() : bool
Return values
bool —getIncludePages()
Returns if the sitemap will include pages or not.
public
getIncludePages() : bool
Return values
bool —getIncludeProducts()
Returns if the sitemap will include products or not.
public
getIncludeProducts() : bool
Return values
bool —getSplitLanguages()
Returns if the sitemap is splitted by languages or not.
public
getSplitLanguages() : bool
Return values
bool —getSplitTypes()
Returns if the sitemap is splitted by types or not.
public
getSplitTypes() : bool
Return values
bool —getStockType()
Returns the sitemap stock type.
public
getStockType() : string
Return values
string —getUpdateInterval()
Returns the sitemap update interval.
public
getUpdateInterval() : int
Return values
int —getUpdateIntervalMultiplier()
Returns the sitemap interval multiplier.
public
getUpdateIntervalMultiplier() : 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