AggregateRating
extends Rating
in package
Uses
ElementTrait
This is the rich snippets aggregate rating section class.
The rich snippets aggregate rating section will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $bestRating | : int | |
|---|---|---|
| $context | : string | |
| $error | : Error|null | |
| $ratingValue | : int | |
| $type | : string | |
| $worstRating | : int | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getBestRating() | Returns the rating rich snippet best rating. | : int |
| getContext() | Returns the rich snippet context. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getRatingCount() | Returns the rating count of the rich snippet aggregate section. | : int |
| getRatingValue() | Returns the rating rich snippet rating value. | : int |
| getReviewCount() | Returns the review count of the rich snippet aggregate section. | : int |
| getType() | Returns the rich snippet type. | : string |
| getWorstRating() | Returns the rating rich snippet worst rating. | : int |
| 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
$bestRating
protected
int
$bestRating
= 0
$context
protected
string
$context
= ''
$error
protected
Error|null
$error
= null
$ratingValue
protected
int
$ratingValue
= 0
$type
protected
string
$type
= ''
$worstRating
protected
int
$worstRating
= 0
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 —getBestRating()
Returns the rating rich snippet best rating.
public
getBestRating() : int
Return values
int —getContext()
Returns the rich snippet context.
public
getContext() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getRatingCount()
Returns the rating count of the rich snippet aggregate section.
public
getRatingCount() : int
Return values
int —getRatingValue()
Returns the rating rich snippet rating value.
public
getRatingValue() : int
Return values
int —getReviewCount()
Returns the review count of the rich snippet aggregate section.
public
getReviewCount() : int
Return values
int —getType()
Returns the rich snippet type.
public
getType() : string
Return values
string —getWorstRating()
Returns the rating rich snippet worst rating.
public
getWorstRating() : int
Return values
int —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