ElementRichSnippets
extends RichSnippets
in package
Uses
ElementNameTrait, ElementDescriptionTrait
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 | |
| 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 |
| getType() | Returns the rich snippet type. | : string |
| setAggregateRating() | : void | |
| 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
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 —getType()
Returns the rich snippet type.
public
getType() : string
Return values
string —setAggregateRating()
protected
setAggregateRating(array<string|int, mixed> $aggregateRating) : void
Parameters
- $aggregateRating : array<string|int, mixed>
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed