PHP Класс RESTfulAPI_EmberDataSerializer

. JSON serialization and de-serialization

Автор: Thierry Francois @colymba [email protected]

Наследование: extends RESTfulAPI_BasicSerializer

Защищенные свойства (Protected)

Свойство	Тип	Описание
$sideloadedRecords	array	Stores the current $sideloaded_records config

Открытые методы

Метод	Описание
__construct ( )	Construct and set current config
formatName ( string $name ) : string	Format a SilverStripe ClassName or Field name to be used by the client API
serialize ( DataObject \| DataList $data ) : string	Convert raw data (DataObject or DataList) to JSON ready to be consumed by the client API

Защищенные методы

Метод	Описание
getSideloadData ( DataObject \| DataList $dataSource ) : array	Fetches and return all the data that need to be sideloaded for a specific source DataObject or DataList.
hasSideloadedRecords ( string $classname ) : boolean	Check if a specific class requires data to be sideloaded.
insertSideloadData ( stdClass $root, DataObject \| DataList $dataSource ) : stdClass	Take a root object ready to be converted into JSON and an original data source (DataObject OR DataList) and insorts into the root object all relation records that should be sideloaded.
serializeColumnName ( string $name ) : string	Format a DB Column name or Field name to be used by the client API

Описание методов

__construct() публичный Метод

Construct and set current config

public __construct ( )

formatName() публичный Метод

Format a SilverStripe ClassName or Field name to be used by the client API

public formatName ( string $name ) : string
$name	string	ClassName of DBField name
Результат	string	Formatted name

getSideloadData() защищенный Метод

Fetches and return all the data that need to be sideloaded for a specific source DataObject or DataList.

protected getSideloadData ( DataObject \| DataList $dataSource ) : array
$dataSource	DataObject \| DataList	The source data to fetch sideloaded records for
Результат	array	A map of relation names with their data

hasSideloadedRecords() защищенный Метод

Check if a specific class requires data to be sideloaded.

protected hasSideloadedRecords ( string $classname ) : boolean
$classname	string	Requested data classname
Результат	boolean	True if some relations should be sideloaded

insertSideloadData() защищенный Метод

Take a root object ready to be converted into JSON and an original data source (DataObject OR DataList) and insorts into the root object all relation records that should be sideloaded.

protected insertSideloadData ( stdClass $root, DataObject \| DataList $dataSource ) : stdClass
$root	stdClass	Root object ready to become JSON
$dataSource	DataObject \| DataList	The original data set from the root object
Результат	stdClass	The updated root object sith the sideloaded data attached

serialize() публичный Метод

Convert raw data (DataObject or DataList) to JSON ready to be consumed by the client API

public serialize ( DataObject \| DataList $data ) : string
$data	DataObject \| DataList	Data to serialize
Результат	string	JSON representation of data

serializeColumnName() защищенный Метод

Format a DB Column name or Field name to be used by the client API

protected serializeColumnName ( string $name ) : string
$name	string	Field name
Результат	string	Formatted name

Описание свойств

$sideloadedRecords защищенное свойство

Stores the current $sideloaded_records config

protected array $sideloadedRecords
Результат	array