Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminAccess
    • Collections
    • Deleters
    • Entities
    • Exceptions
    • Factories
    • Interfaces
    • Managers
    • Readers
    • Writers
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • CustomerGroup
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Serializers
    • Services
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Geschaeftskundenversand
    • Helpers
    • Invoices
    • Orders
    • ParcelShopFinder
    • QuickEdit
    • Serializers
    • Templates
  • Geschaeftskundenversand
    • Exceptions
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Manufacturer
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • OrderStatus
    • Collections
    • Entities
    • Exceptions
    • Factories
    • Interfaces
    • Repositories
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • QuantityUnit
    • Entities
    • Factories
    • Repositories
  • QuickEdit
    • Interfaces
    • Repositories
  • Review
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Services
    • ValueObjects
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Smarty
    • plugins
  • StaticSeoUrl
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • StaticSeoUrls
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository
  • VersionInfo
    • Factories
    • Reader
    • ValueObjects
  • VPE
    • Entities
    • Factories
    • Repositories
  • Withdrawal
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Services
    • ValueObjects

Classes

  • AbstractJsonSerializer
  • AddressJsonSerializer
  • CategoryJsonSerializer
  • CategoryListItemJsonSerializer
  • CountryJsonSerializer
  • CustomerJsonSerializer
  • EmailJsonSerializer
  • OrderJsonSerializer
  • OrderListItemJsonSerializer
  • ProductJsonSerializer
  • ProductListItemJsonSerializer
  • ReviewJsonSerializer
  • SliderJsonSerializer
  • WithdrawalJsonSerializer
  • ZoneJsonSerializer

Interfaces

  • SerializerInterface

Class ReviewJsonSerializer

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.

AbstractJsonSerializer implements SerializerInterface
Extended by ReviewJsonSerializer
Package: Extensions\Serializers
Category: System
Located at Extensions/Serializers/ReviewJsonSerializer.inc.php

Methods summary

public
# __construct( ReviewWriteServiceInterface $reviewWriteService )

ReviewJsonSerializer constructor.

ReviewJsonSerializer constructor.

Parameters

$reviewWriteService

Overrides

AbstractJsonSerializer::__construct
public string|array
# serialize( ReviewInterface $object, boolean $encode = true )

Serialize a Review object to a JSON string.

Serialize a Review 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 review (string) or an array that can be easily encoded into a JSON string.

Throws

InvalidArgumentException
If the provided object type is invalid.
public ReviewInterface
# deserialize( string $string, ReviewInterface $baseObject = null )

Deserialize a Product JSON String.

Deserialize a Product JSON String.

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

ReviewInterface

Throws

InvalidArgumentException
If the argument is not a string or is empty.
public string|array
# serializeReviewCollection( ReviewCollection $reviewCollection, boolean $encode = true )

Serializes review collections.

Serializes review collections.

Parameters

$reviewCollection
Review collection to be serialized.
$encode

(optional) Whether to json_encode the result of the method (default true).

Returns

string|array

Returns the json encoded review collection(string) or an array that can be easily encoded into a JSON string.

protected array
# _serializeReviewCustomer( ReviewCustomerInterface $reviewCustomer )

Serializes review customer entities.

Serializes review customer entities.

Parameters

$reviewCustomer
review customer entity to be serialized.

Returns

array
Serialized review customer array.
protected ReviewCustomerInterface
# _deserializeReviewCustomer( stdClass $reviewCustomerData )

Deserialize review customer entities.

Deserialize review customer entities.

Parameters

$reviewCustomerData
review customer entity.

Returns

ReviewCustomerInterface
Deserialize review customer entity.

Methods inherited from AbstractJsonSerializer

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

Properties summary

protected ReviewWriteServiceInterface $reviewWriteService

Reviews write service.

Reviews write service.

#

Properties inherited from AbstractJsonSerializer

$languageProvider

API documentation generated by ApiGen