CategoryRichSnippets
extends ElementRichSnippets
in package
Uses
ElementTrait
This is the category rich snippets class.
The category rich snippets will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $aggregateRating | : AggregateRating|null | |
|---|---|---|
| $context | : string | |
| $description | : string | |
| $error | : Error|null | |
| $images | : array<string|int, mixed> | |
| $name | : string | |
| $type | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAggregateRating() | Returns the aggregate rating rich snippet. | : AggregateRating|null |
| getContext() | Returns the rich snippet context. | : string |
| getDescription() | Returns the element description on the website current language. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getImages() | Returns the images rich snippet. | : array<string|int, string> |
| getName() | Returns the element name on the website current language. | : string |
| getOffers() | Returns the category offers rich snippet. | : AggregateOffer|null |
| getType() | Returns the rich snippet type. | : string |
| getUrl() | Returns the category url rich snippet. | : 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 | |
| setAggregateRating() | : void | |
| setArrayField() | Convert an API array of objects to a PHP array of objects. | : array<string|int, mixed> |
| setError() | : void |
Properties
$aggregateRating
protected
AggregateRating|null
$aggregateRating
= null
$context
protected
string
$context
= ''
$description
protected
string
$description
= ''
$error
protected
Error|null
$error
= null
$images
protected
array<string|int, mixed>
$images
= []
$name
protected
string
$name
= ''
$type
protected
string
$type
= ''
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 —getAggregateRating()
Returns the aggregate rating rich snippet.
public
getAggregateRating() : AggregateRating|null
Return values
AggregateRating|null —getContext()
Returns the rich snippet context.
public
getContext() : 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 —getImages()
Returns the images rich snippet.
public
getImages() : array<string|int, string>
Return values
array<string|int, string> —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getOffers()
Returns the category offers rich snippet.
public
getOffers() : AggregateOffer|null
Return values
AggregateOffer|null —getType()
Returns the rich snippet type.
public
getType() : string
Return values
string —getUrl()
Returns the category url rich snippet.
public
getUrl() : 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 —setAggregateRating()
protected
setAggregateRating(array<string|int, mixed> $aggregateRating) : void
Parameters
- $aggregateRating : array<string|int, mixed>
Return values
void —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