SeoSettings
extends Element
in package
Uses
ElementTrait
This is the SEO settings class.
The SEO 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 |
| getBlogBloggers() | Returns the SEO settings for blog bloggers. | : ItemSeoSettings|null |
| getBlogCategories() | Returns the SEO settings for blog categories. | : ItemSeoSettings|null |
| getBlogPosts() | Returns the SEO settings for blog posts. | : ItemSeoSettings|null |
| getCategories() | Returns the SEO settings for categories. | : ItemSeoSettings|null |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getGeneric() | Returns the generic SEO settings. | : ItemSeoSettings|null |
| getLanguageInSubdirectory() | Returns the if the SEO URL will contains the language. | : bool |
| getNews() | Returns the SEO settings for news. | : ItemSeoSettings|null |
| getPages() | Returns the SEO settings for pages. | : ItemSeoSettings|null |
| getProducts() | Returns the SEO settings for products. | : ItemSeoSettings|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 —getBlogBloggers()
Returns the SEO settings for blog bloggers.
public
getBlogBloggers() : ItemSeoSettings|null
Return values
ItemSeoSettings|null —getBlogCategories()
Returns the SEO settings for blog categories.
public
getBlogCategories() : ItemSeoSettings|null
Return values
ItemSeoSettings|null —getBlogPosts()
Returns the SEO settings for blog posts.
public
getBlogPosts() : ItemSeoSettings|null
Return values
ItemSeoSettings|null —getCategories()
Returns the SEO settings for categories.
public
getCategories() : ItemSeoSettings|null
Return values
ItemSeoSettings|null —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getGeneric()
Returns the generic SEO settings.
public
getGeneric() : ItemSeoSettings|null
Return values
ItemSeoSettings|null —getLanguageInSubdirectory()
Returns the if the SEO URL will contains the language.
public
getLanguageInSubdirectory() : bool
Return values
bool —getNews()
Returns the SEO settings for news.
public
getNews() : ItemSeoSettings|null
Return values
ItemSeoSettings|null —getPages()
Returns the SEO settings for pages.
public
getPages() : ItemSeoSettings|null
Return values
ItemSeoSettings|null —getProducts()
Returns the SEO settings for products.
public
getProducts() : ItemSeoSettings|null
Return values
ItemSeoSettings|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