ItemSeoSettings
extends Element
in package
implements
SEOElementInterface
Uses
ElementTrait, ElementLanguageTrait
This is the item SEO settings class.
The item SEO settings will be stored in that class and will remain immutable (only get methods are available)
Tags
Interfaces, Classes and Traits
- SEOElementInterface
- This is the SEOElement interface
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $keywords | : string | |
| $metaDescription | : string | |
| $particularTitle | : string | |
| $title | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getKeywords() | Returns the element keywords on the website current language. | : string |
| getMetaDescription() | Returns the element meta-description on the website current language. | : string |
| getParticularTitle() | Returns the element particular title on the website current language. | : string |
| getTitle() | Returns the element title on the website current language. | : 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
$keywords
protected
string
$keywords
= ''
$metaDescription
protected
string
$metaDescription
= ''
$particularTitle
protected
string
$particularTitle
= ''
$title
protected
string
$title
= ''
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 —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getKeywords()
Returns the element keywords on the website current language.
public
getKeywords() : string
Return values
string —getMetaDescription()
Returns the element meta-description on the website current language.
public
getMetaDescription() : string
Return values
string —getParticularTitle()
Returns the element particular title on the website current language.
public
getParticularTitle() : string
Return values
string —getTitle()
Returns the element title on the website current language.
public
getTitle() : 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