PHP Class Tobscure\JsonApi\Collection

Inheritance: implements Tobscure\JsonApi\ElementInterface

Protected Properties

Property	Type	Description
$resources	array

Method	Description
__construct ( mixed $data, Tobscure\JsonApi\SerializerInterface $serializer )	Create a new collection instance.
fields ( array \| null $fields )	Request a restricted set of fields.
getResources ( )
identify ( string \| array $relationships )	Request a relationship to be identified for all resources.
setResources ( array $resources ) : void	Set the resources array.
toArray ( )
toIdentifier ( )
with ( string \| array $relationships )	Request a relationship to be included for all resources.

Method	Description
buildResources ( mixed $data, Tobscure\JsonApi\SerializerInterface $serializer ) : Resource[]	Convert an array of raw data to Resource objects.

Create a new collection instance.

public __construct ( mixed $data, Tobscure\JsonApi\SerializerInterface $serializer )
$data	mixed
$serializer	Tobscure\JsonApi\SerializerInterface

Convert an array of raw data to Resource objects.

protected buildResources ( mixed $data, Tobscure\JsonApi\SerializerInterface $serializer ) : Resource[]
$data	mixed
$serializer	Tobscure\JsonApi\SerializerInterface
return	Resource[]

Request a restricted set of fields.

public fields ( array \| null $fields )
$fields	array \| null

public getResources ( )

Request a relationship to be identified for all resources.

public identify ( string \| array $relationships )
$relationships	string \| array

Set the resources array.

public setResources ( array $resources ) : void
$resources	array
return	void

public toArray ( )

public toIdentifier ( )

Request a relationship to be included for all resources.

public with ( string \| array $relationships )
$relationships	string \| array

protected array $resources
return	array