Référence de la classe Resource

Graphe d'héritage de Resource:

Fonctions membres publiques
	__construct ($data, SerializerInterface $serializer)
	getResources ()
	toArray ()
	isIdentifier ()
	toIdentifier ()
	getType ()
	getId ()
	getAttributes ()
	getRelationships ()
	getUnfilteredRelationships ()
	getRelationshipsAsArray ()
	merge (Resource $resource)
	with ($relationships)
	fields ($fields)
	getData ()
	setData ($data)
	getSerializer ()
	setSerializer (SerializerInterface $serializer)

Fonctions membres protégées
	getOwnFields ()
	filterFields (array $fields)
	mergeAttributes (array $attributes)
	buildRelationships ()
	mergeRelationships (array $relationships)
	convertRelationshipsToArray (array $relationships)

Attributs protégés
	$data
	$serializer
	$includes = []
	$fields
	$merged = []

Attributs privés
	$relationships

Documentation des constructeurs et destructeur

__construct()

__construct	(		$data,
		SerializerInterface	$serializer
	)

Paramètres

mixed	$data
\Tobscure\JsonApi\SerializerInterface	$serializer

Références Resource\$data, et Resource\$serializer.

Documentation des fonctions membres

buildRelationships()

buildRelationships ( )

protected

Get an array of built relationships.

Renvoie

[]

Références $name, Resource\$relationships, Resource\fields(), et Util\parseRelationshipPaths().

Référencé par Resource\getRelationships(), et Resource\getUnfilteredRelationships().

convertRelationshipsToArray()

convertRelationshipsToArray ( array  $relationships )

protected

Convert the given array of Relationship objects into an array.

Paramètres

Références Resource\$relationships, et Relationship\toArray().

Référencé par Resource\getRelationshipsAsArray().

fields()

fields

(

$fields

)

{Request a restricted set of fields.

Paramètres

array | null

$fields

Renvoie

$this

}

Implémente ElementInterface.

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

Référencé par Resource\buildRelationships(), et Resource\getOwnFields().

filterFields()

filterFields ( array  $fields )

protected

Filter the given fields array (attributes or relationships) according to the requested fieldset.

Paramètres

array

$fields

Renvoie

array

Références Resource\$fields, et Resource\getOwnFields().

Référencé par Resource\getAttributes(), et Resource\getRelationships().

getAttributes()

getAttributes

(

)

Get the resource attributes.

Renvoie

array

Références $attributes, $this, Resource\filterFields(), et Resource\mergeAttributes().

Référencé par Resource\toArray().

getData()

getData

(

)

Renvoie

mixed

Références Resource\$data.

getId()

getId

(

)

Get the resource ID.

Renvoie

string

Références Resource\$data.

Référencé par Document\mergeResource(), et Resource\toIdentifier().

getOwnFields()

getOwnFields ( )

protected

Get the requested fields for this resource type.

Renvoie

array|null

Références $type, Resource\fields(), et Resource\getType().

Référencé par Resource\filterFields().

getRelationships()

getRelationships

(

)

Get the resource relationships.

Renvoie

[]

Références Resource\$relationships, Resource\buildRelationships(), et Resource\filterFields().

Référencé par Resource\getRelationshipsAsArray().

getRelationshipsAsArray()

getRelationshipsAsArray

(

)

Get the resource relationships as an array.

Renvoie

array

Références Resource\$relationships, Resource\convertRelationshipsToArray(), Resource\getRelationships(), et Resource\mergeRelationships().

Référencé par Resource\toArray().

getResources()

getResources

(

)

{Get the resources array.

Renvoie

array

}

Implémente ElementInterface.

Références $this.

getSerializer()

getSerializer

(

)

Renvoie

Références Resource\$serializer.

getType()

getType

(

)

Get the resource type.

Renvoie

string

Référencé par Resource\getOwnFields(), Document\mergeResource(), et Resource\toIdentifier().

getUnfilteredRelationships()

getUnfilteredRelationships

(

)

Get the resource relationships without considering requested ones.

Renvoie

[]

Références Resource\buildRelationships().

isIdentifier()

isIdentifier

(

)

Check whether or not this resource is an identifier (i.e. does it have any data attached?).

Renvoie

bool

Référencé par Resource\toArray().

merge()

merge

(

Resource

$resource

)

Merge a resource into this one.

Paramètres

\Tobscure\JsonApi\Resource

$resource

Renvoie

void

mergeAttributes()

mergeAttributes ( array  $attributes )

protected

Merge the attributes of merged resources into an array of attributes.

Paramètres

array

$attributes

Renvoie

array

Références $attributes.

Référencé par Resource\getAttributes().

mergeRelationships()

mergeRelationships ( array  $relationships )

protected

Merge the relationships of merged resources into an array of relationships.

Paramètres

array

$relationships

Renvoie

array

Références Resource\$relationships.

Référencé par Resource\getRelationshipsAsArray().

setData()

setData

(

$data

)

Paramètres

mixed

$data

Renvoie

void

Références Resource\$data.

setSerializer()

setSerializer

(

SerializerInterface

$serializer

)

Paramètres

\Tobscure\JsonApi\SerializerInterface

$serializer

Renvoie

void

Références Resource\$serializer.

toArray()

toArray

(

)

{Map to a "resource object" array.

Renvoie

array

}

Implémente ElementInterface.

Références $attributes, Resource\$relationships, Resource\getAttributes(), Resource\getRelationshipsAsArray(), Resource\isIdentifier(), et Resource\toIdentifier().

Référencé par Collection\toArray(), et Document\toArray().

toIdentifier()

toIdentifier

(

)

{Map to a "resource object identifier" array.

Renvoie

array

}

Implémente ElementInterface.

Références Resource\getId(), et Resource\getType().

Référencé par Resource\toArray(), et Collection\toIdentifier().

with()

with

(

$relationships

)

{Request a relationship to be included.

Paramètres

string | array

$relationships

Renvoie

$this

}

Implémente ElementInterface.

Références Resource\$relationships, $this, et null.

Documentation des champs

$data

$data

protected

Référencé par Resource\__construct(), Resource\getData(), Resource\getId(), et Resource\setData().

$fields

$fields

protected

Référencé par Resource\fields(), et Resource\filterFields().

$includes

$includes = []

protected

$merged

$merged = []

protected

$relationships

$relationships

private

Référencé par Resource\buildRelationships(), Resource\convertRelationshipsToArray(), Resource\getRelationships(), Resource\getRelationshipsAsArray(), Resource\mergeRelationships(), Resource\toArray(), et Resource\with().

$serializer

$serializer

protected

Référencé par Resource\__construct(), Resource\getSerializer(), et Resource\setSerializer().

---

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

• Resource.php