ReviewJsonSerializer
extends AbstractJsonSerializer
in package
Class ReviewJsonSerializer
This class will serialize and deserialize a Review entity. It can be used into many places where PHP interacts with external requests such as AJAX or API communications.
Tags
Table of Contents
- $languageProvider : LanguageProviderInterface
- Used for the resources that require multiple languages.
- $reviewWriteService : ReviewWriteServiceInterface
- Reviews write service.
- __construct() : mixed
- ReviewJsonSerializer constructor.
- deserialize() : ReviewInterface
- Deserialize a Product JSON String.
- jsonEncode() : string
- JSON Encode Wrapper
- serialize() : string|array<string|int, mixed>
- Serialize a Review object to a JSON string.
- serializeReviewCollection() : string|array<string|int, mixed>
- Serializes review collections.
- _deserializeAddonValues() : array<string|int, mixed>
- Deserialize Addon Values
- _deserializeLanguageSpecificProperty() : mixed
- Deserialize Language Specific Property
- _deserializeReviewCustomer() : ReviewCustomerInterface
- Deserialize review customer entities.
- _serializeAddonValues() : array<string|int, mixed>
- Serialize Addon Values
- _serializeLanguageSpecificProperty() : array<string|int, mixed>
- Serialize Language Specific Property
- _serializeReviewCustomer() : array<string|int, mixed>
- Serializes review customer entities.
Properties
$languageProvider
Used for the resources that require multiple languages.
protected
LanguageProviderInterface
$languageProvider
$reviewWriteService
Reviews write service.
protected
ReviewWriteServiceInterface
$reviewWriteService
Methods
__construct()
ReviewJsonSerializer constructor.
public
__construct(ReviewWriteServiceInterface $reviewWriteService) : mixed
Parameters
- $reviewWriteService : ReviewWriteServiceInterface
Return values
mixed —deserialize()
Deserialize a Product JSON String.
public
deserialize(string $string[, ReviewInterface $baseObject = null ]) : ReviewInterface
Parameters
- $string : string
-
JSON string that contains the data of the slider.
- $baseObject : ReviewInterface = null
-
(optional) If provided, this will be the base object to be updated and no new instance will be created.
Tags
Return values
ReviewInterface —jsonEncode()
JSON Encode Wrapper
public
jsonEncode(array<string|int, mixed> $data) : string
This function provides PHP v5.3 compatibility and it should be used when serialized objects need to be encoded directly from the serializer instance.
Parameters
- $data : array<string|int, mixed>
-
Contains the data to be JSON encoded.
Return values
string —Returns the encoded JSON string that represents the data.
serialize()
Serialize a Review object to a JSON string.
public
serialize(ReviewInterface $object[, bool $encode = true ]) : string|array<string|int, mixed>
Parameters
- $object : ReviewInterface
-
Object instance to be serialized.
- $encode : bool = true
-
(optional) Whether to json_encode the result of the method (default true).
Tags
Return values
string|array<string|int, mixed> —Returns the json encoded review (string) or an array that can be easily encoded into a JSON string.
serializeReviewCollection()
Serializes review collections.
public
serializeReviewCollection(ReviewCollection $reviewCollection[, bool $encode = true ]) : string|array<string|int, mixed>
Parameters
- $reviewCollection : ReviewCollection
-
Review collection to be serialized.
- $encode : bool = true
-
(optional) Whether to json_encode the result of the method (default true).
Return values
string|array<string|int, mixed> —Returns the json encoded review collection(string) or an array that can be easily encoded into a JSON string.
_deserializeAddonValues()
Deserialize Addon Values
protected
_deserializeAddonValues( $json) : array<string|int, mixed>
Common method for deserializing addon values in various resource serializer classes.
Parameters
Return values
array<string|int, mixed> —_deserializeLanguageSpecificProperty()
Deserialize Language Specific Property
protected
_deserializeLanguageSpecificProperty(mixed $object, stdobject $json, string $property[, mixed $type = 'StringType' ]) : mixed
This method will deserialize the value of a JSON property and set the value to the object by using the corresponding setter method.
Parameters
- $object : mixed
-
The object being deserialized.
- $json : stdobject
-
The JSON object containing the property value.
- $property : string
-
The property name to be deserialized.
- $type : mixed = 'StringType'
Tags
Return values
mixed —_deserializeReviewCustomer()
Deserialize review customer entities.
protected
_deserializeReviewCustomer(stdClass $reviewCustomerData) : ReviewCustomerInterface
Parameters
- $reviewCustomerData : stdClass
-
review customer entity.
Return values
ReviewCustomerInterface —Deserialize review customer entity.
_serializeAddonValues()
Serialize Addon Values
protected
_serializeAddonValues(KeyValueCollection $addonValues) : array<string|int, mixed>
Common method for serializing addon values in various resource serializer classes.
Parameters
- $addonValues : KeyValueCollection
Return values
array<string|int, mixed> —_serializeLanguageSpecificProperty()
Serialize Language Specific Property
protected
_serializeLanguageSpecificProperty(mixed $object, string $property) : array<string|int, mixed>
In order for this method to work there has to be a proper getter method in the object instance. Otherwise a RuntimeException will be thrown.
Parameters
- $object : mixed
-
The object instance containing the property.
- $property : string
-
The property name to be serialized.
Tags
Return values
array<string|int, mixed> —_serializeReviewCustomer()
Serializes review customer entities.
protected
_serializeReviewCustomer(ReviewCustomerInterface $reviewCustomer) : array<string|int, mixed>
Parameters
- $reviewCustomer : ReviewCustomerInterface
-
review customer entity to be serialized.
Return values
array<string|int, mixed> —Serialized review customer array.