Référence de la classe Collection

Graphe d'héritage de Collection:

Fonctions membres publiques
	__construct ($data, SerializerInterface $serializer)
	getResources ()
	setResources ($resources)
	with ($relationships)
	fields ($fields)
	toArray ()
	toIdentifier ()

Fonctions membres protégées
	buildResources ($data, SerializerInterface $serializer)

Attributs protégés
	$resources = []

Documentation des constructeurs et destructeur

__construct()

__construct	(		$data,
		SerializerInterface	$serializer
	)

Create a new collection instance.

Paramètres

mixed	$data
\Tobscure\JsonApi\SerializerInterface	$serializer

Références $data, et Collection\buildResources().

Documentation des fonctions membres

buildResources()

buildResources (   $data, SerializerInterface  $serializer  )

protected

Convert an array of raw data to Resource objects.

Paramètres

mixed	$data
SerializerInterface	$serializer

Renvoie

[]

Références $data, et Collection\$resources.

Référencé par Collection\__construct().

fields()

fields

(

$fields

)

Request a restricted set of fields.

Paramètres

array | null

$fields

Renvoie

$this

Implémente ElementInterface.

Références $fields, et $this.

getResources()

getResources

(

)

{Get the resources array.

Renvoie

array

}

Implémente ElementInterface.

Références Collection\$resources.

setResources()

setResources

(

$resources

)

Set the resources array.

Paramètres

array

$resources

Renvoie

void

Références Collection\$resources.

toArray()

toArray

(

)

{Map to a "resource object" array.

Renvoie

array

}

Implémente ElementInterface.

Références Collection\$resources, et Resource\toArray().

toIdentifier()

toIdentifier

(

)

{Map to a "resource object identifier" array.

Renvoie

array

}

Implémente ElementInterface.

Références Collection\$resources, et Resource\toIdentifier().

with()

with

(

$relationships

)

Request a relationship to be included for all resources.

Paramètres

string | array

$relationships

Renvoie

$this

Implémente ElementInterface.

Références $this.

Documentation des champs

$resources

$resources = []

protected

Référencé par Collection\buildResources(), Collection\getResources(), Collection\setResources(), Collection\toArray(), et Collection\toIdentifier().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• tobscure/json-api/src/Collection.php