PHP Class Tobscure\JsonApi\Document

Inheritance: implements JsonSerializabl\JsonSerializable, use trait LinksTrait, use trait MetaTrait
Show file Open project: tobscure/json-api Class Usage Examples

Protected Properties

Property Type Description
$data Tobscure\JsonApi\ElementInterface The data object.
$errors array The errors array.
$included array The included array.
$jsonapi array The jsonapi array.

Public Methods

Method Description
__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.

Protected Methods

Method Description
getIncluded ( Tobscure\JsonApi\ElementInterface $element, boolean $includeParent = false ) : Resource[] Get included resources.
mergeResource ( array $resources, Resource $newResource ) : Resource[]

Method Details

__construct() public method

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

__toString() public method

Map to string.
public __toString ( ) : string
return string

getIncluded() protected method

Get included resources.
protected getIncluded ( Tobscure\JsonApi\ElementInterface $element, boolean $includeParent = false ) : Resource[]
$element Tobscure\JsonApi\ElementInterface
$includeParent boolean
return Resource[]

jsonSerialize() public method

Serialize for JSON usage.
public jsonSerialize ( ) : array
return array

mergeResource() protected method

protected mergeResource ( array $resources, Resource $newResource ) : Resource[]
$resources array
$newResource Resource
return Resource[]

setData() public method

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

setErrors() public method

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

setJsonapi() public method

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

toArray() public method

Map everything to arrays.
public toArray ( ) : array
return array

Property Details

$data protected property

The data object.
protected ElementInterface,Tobscure\JsonApi $data
return Tobscure\JsonApi\ElementInterface

$errors protected property

The errors array.
protected array $errors
return array

$included protected property

The included array.
protected array $included
return array

$jsonapi protected property

The jsonapi array.
protected array $jsonapi
return array