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.
category |
System |
---|---|
package |
Extensions |
subpackage |
Serializers |
__construct()
If you override this constructor do not forget to call it from the child class.
_deserializeAddonValues( $json) : array
Common method for deserializing addon values in various resource serializer classes.
array
_deserializeLanguageSpecificProperty(mixed $object, \stdobject $json, string $property, $type = 'StringType')
This method will deserialize the value of a JSON property and set the value to the object by using the corresponding setter method.
Throws |
|
---|
mixed
The object being deserialized.
\stdobject
The JSON object containing the property value.
string
The property name to be deserialized.
_deserializeReviewCustomer(\stdClass $reviewCustomerData) : \ReviewCustomerInterface
\stdClass
review customer entity.
\ReviewCustomerInterface
Deserialize review customer entity.
_serializeAddonValues(\KeyValueCollection $addonValues) : array
Common method for serializing addon values in various resource serializer classes.
\KeyValueCollection
array
_serializeLanguageSpecificProperty(mixed $object, string $property) : array
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.
Throws |
|
---|
mixed
The object instance containing the property.
string
The property name to be serialized.
array
_serializeReviewCustomer(\ReviewCustomerInterface $reviewCustomer) : array
array
Serialized review customer array.
deserialize( $string, $baseObject = null)
jsonEncode(array $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.
array
Contains the data to be JSON encoded.
string
Returns the encoded JSON string that represents the data.
serialize( $object, $encode = true)
serializeReviewCollection(\ReviewCollection $reviewCollection, boolean $encode = true) : string|array
boolean
(optional) Whether to json_encode the result of the method (default true).
string|array
Returns the json encoded review collection(string) or an array that can be easily encoded into a JSON string.
reviewWriteService : \ReviewWriteServiceInterface
languageProvider : \LanguageProviderInterface