API Documentation
Back to top  

ProductJsonSerializer

Extends \AbstractJsonSerializer

Class ProductJsonSerializer

This class will serialize and deserialize a Product entity. It can be used into many places where PHP interacts with external requests such as AJAX or API communication.

category

System
package

Extensions
subpackage

Serializers

Methods

AbstractJsonSerializer Constructor

__construct()
inherited

If you override this constructor do not forget to call it from the child class.

Decodes a JSON string and performs some basic validation.

decodeJson(mixed $string) : array

Arguments

$string

mixed

The (potential) JSON string

Response

array

The decoded JSON array

deserialize

deserialize( $string,  $baseObject = null)
inherited abstract

Arguments

$string

$baseObject

JSON Encode Wrapper

jsonEncode(array $data) : string
inherited

This function provides PHP v5.3 compatibility and it should be used when serialized objects need to be encoded directly from the serializer instance.

Arguments

$data

array

Contains the data to be JSON encoded.

Response

string

Returns the encoded JSON string that represents the data.

serialize

serialize( $object,  $encode = true)
inherited abstract

Arguments

$object

$encode

Serializes an array of ProductInterfaces to a JSON string.

serializeProductArray(array $storedProducts, boolean $encode = true) : array|string

Arguments

$storedProducts

array

The array of ProductInterfaces

$encode

boolean

Indicates if the result should be returned JSON encoded.

Response

array|string

Either a JSON string or the serialized array (depends on the $encode parameter)

Properties