PHP Класс Tobscure\JsonApi\Document

Наследование: implements JsonSerializabl\JsonSerializable, use trait LinksTrait, use trait MetaTrait
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$data Tobscure\JsonApi\ElementInterface The data object.
$errors array The errors array.
$included array The included array.
$jsonapi array The jsonapi array.

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

Метод Описание
__construct ( Tobscure\JsonApi\ElementInterface $data = null )
__toString ( ) : string Map to string.
jsonSerialize ( ) : array Serialize for JSON usage.
setData ( Tobscure\JsonApi\ElementInterface $element ) Set the data object.
setErrors ( array $errors ) Set the errors array.
setJsonapi ( array $jsonapi ) Set the jsonapi array.
toArray ( ) : array Map everything to arrays.

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

Метод Описание
getIncluded ( Tobscure\JsonApi\ElementInterface $element, boolean $includeParent = false ) : Resource[] Get included resources.
mergeResource ( array $resources, Resource $newResource ) : Resource[]

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

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

public __construct ( Tobscure\JsonApi\ElementInterface $data = null )
$data Tobscure\JsonApi\ElementInterface

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

Map to string.
public __toString ( ) : string
Результат string

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

Get included resources.
protected getIncluded ( Tobscure\JsonApi\ElementInterface $element, boolean $includeParent = false ) : Resource[]
$element Tobscure\JsonApi\ElementInterface
$includeParent boolean
Результат Resource[]

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

Serialize for JSON usage.
public jsonSerialize ( ) : array
Результат array

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

protected mergeResource ( array $resources, Resource $newResource ) : Resource[]
$resources array
$newResource Resource
Результат Resource[]

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

Set the data object.
public setData ( Tobscure\JsonApi\ElementInterface $element )
$element Tobscure\JsonApi\ElementInterface

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

Set the errors array.
public setErrors ( array $errors )
$errors array

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

Set the jsonapi array.
public setJsonapi ( array $jsonapi )
$jsonapi array

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

Map everything to arrays.
public toArray ( ) : array
Результат array

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

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

The data object.
protected ElementInterface,Tobscure\JsonApi $data
Результат Tobscure\JsonApi\ElementInterface

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

The errors array.
protected array $errors
Результат array

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

The included array.
protected array $included
Результат array

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

The jsonapi array.
protected array $jsonapi
Результат array