Class SliderJsonSerializer

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

AbstractJsonSerializer implements SerializerInterface

SliderJsonSerializer

Package: Extensions\Serializers
Category: System
Located at Extensions/Serializers/SliderJsonSerializer.inc.php

Methods summary

`public string\|array`	# `serialize( Slider $object, boolean $encode = true )` Serialize a Slider object to a JSON string. Serialize a Slider object to a JSON string. Parameters `$object` Object instance to be serialized. `$encode` (optional) Whether to json_encode the result of the method (default true). Returns string\|array Returns the json encoded slider (string) or an array that can be easily encoded into a JSON string. Throws InvalidArgumentException If the provided object type is invalid.
`public Slider`	# `deserialize( string $string, object $baseObject = null )` Deserialize method is not used by the api. Deserialize method is not used by the api. Parameters `$string` JSON string that contains the data of the slider. `$baseObject` (optional) If provided, this will be the base object to be updated and no new instance will be created. Returns `Slider` Throws InvalidArgumentException If the argument is not a string or is empty.
`protected array`	# `_serializeSlides( Slider $slider )` Serialize the slides of a slider. Serialize the slides of a slider. Parameters `$slider` Returns array
`protected array`	# `_serializeSlideImages( Slide $slide )` Serialize the slide images of a slide. Serialize the slide images of a slide. Parameters `$slide` Returns array
`public array`	# `_serializeSlideImageAreas( SlideImage $slideImage )` Serialize the slide image areas of a slide image. Serialize the slide image areas of a slide image. Parameters `$slideImage` Returns array
`protected SlideCollection`	# `_deserializeSlides( object $json )` Deserialize slides from slider JSON object. Deserialize slides from slider JSON object. Parameters `$json` Returns `SlideCollection`
`protected SlideImageCollection`	# `_deserializeSlideImages( object $json )` Deserialize slide images from slide JSON object. Deserialize slide images from slide JSON object. Parameters `$json` Returns `SlideImageCollection`
`protected SlideImageAreaCollection`	# `_deserializeSlideImageAreas( object $json )` Deserialize slide image areas from slide image JSON object. Deserialize slide image areas from slide image JSON object. Parameters `$json` Returns `SlideImageAreaCollection`

Methods inherited from AbstractJsonSerializer

__construct(), _deserializeAddonValues(), _deserializeLanguageSpecificProperty(), _serializeAddonValues(), _serializeLanguageSpecificProperty(), jsonEncode()

Properties summary

Properties inherited from AbstractJsonSerializer

$languageProvider

Packages

Classes

Interfaces

Class SliderJsonSerializer

Methods summary

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from AbstractJsonSerializer

Properties summary

Properties inherited from AbstractJsonSerializer