Référence de la classe Document

Graphe d'héritage de Document:

Fonctions membres publiques
	__construct (ElementInterface $data=null)
	setData (ElementInterface $element)
	setErrors ($errors)
	setJsonapi ($jsonapi)
	toArray ()
	__toString ()
	jsonSerialize ()

Champs de données
const	MEDIA_TYPE = 'application/vnd.api+json'

Fonctions membres protégées
	getIncluded (ElementInterface $element, $includeParent=false)
	mergeResource (array $resources, Resource $newResource)

Attributs protégés
	$included = []
	$errors
	$jsonapi
	$data

Documentation des constructeurs et destructeur

__construct()

__construct

(

ElementInterface

$data = null

)

Paramètres

ElementInterface

$data

Références Document\$data.

Documentation des fonctions membres

__toString()

__toString

(

)

Map to string.

Renvoie

string

Références Document\toArray().

getIncluded()

getIncluded ( ElementInterface  $element,   $includeParent = false  )

protected

Get included resources.

Paramètres

\Tobscure\JsonApi\ElementInterface	$element
bool	$includeParent

Renvoie

[]

Références $id, Document\$included, $type, ElementInterface\getResources(), et Document\mergeResource().

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

jsonSerialize()

jsonSerialize

(

)

Serialize for JSON usage.

Renvoie

array

Références Document\toArray().

mergeResource()

mergeResource ( array  $resources, Resource  $newResource  )

protected

Paramètres

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

Référencé par Document\getIncluded().

setData()

setData

(

ElementInterface

$element

)

Set the data object.

Paramètres

\Tobscure\JsonApi\ElementInterface

$element

Renvoie

$this

Références $this.

setErrors()

setErrors

(

$errors

)

Set the errors array.

Paramètres

array

$errors

Renvoie

$this

Références Document\$errors, et $this.

setJsonapi()

setJsonapi

(

$jsonapi

)

Set the jsonapi array.

Paramètres

array

$jsonapi

Renvoie

$this

Références Document\$jsonapi, et $this.

toArray()

toArray

(

)

Map everything to arrays.

Renvoie

array

Références $document, Document\$errors, Document\$jsonapi, Document\getIncluded(), et Resource\toArray().

Référencé par Document\__toString(), et Document\jsonSerialize().

Documentation des champs

$data

$data

protected

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

$errors

$errors

protected

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

$included

$included = []

protected

Référencé par Document\getIncluded().

$jsonapi

$jsonapi

protected

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

MEDIA_TYPE

const MEDIA_TYPE = 'application/vnd.api+json'

---

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

• vendor/tobscure/json-api/src/Document.php