Référence de la classe JsonApiView

Graphe d'héritage de JsonApiView:

Fonctions membres publiques
	__construct ($config=[])
Fonctions membres publiques hérités de JsonView
	__construct ($config=array())
	display ($tpl=null)
Fonctions membres publiques hérités de AbstractView
	__construct ($config=array())
	display ($tpl=null)
	get ($property, $default=null)
	getModel ($name=null)
	setModel ($model, $default=false)
	getName ()
Fonctions membres publiques hérités de CMSObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

Champs de données
	$document
Champs de données hérités de AbstractView
	$document

Fonctions membres protégées
	prepareItem ($item)
	queryEncode ($query)
Fonctions membres protégées hérités de AbstractView
	dispatchEvent (EventInterface $event)

Attributs protégés
	$type
	$relationship = []
	$serializer
	$fieldsToRenderItem = []
	$fieldsToRenderList = []
Attributs protégés hérités de JsonView
	$_basePath = null
	$_charset = 'UTF-8'
	$_output = array()
Attributs protégés hérités de AbstractView
	$option = null
	$_name = null
	$_models = array()
	$_defaultModel = null
Attributs protégés hérités de CMSObject
	$_errors = array()

Description détaillée

Base class for a Joomla Json List View

Class holding methods for displaying presentation data.

Depuis

4.0.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = []

)

Constructor.

Paramètres

array

$config

A named configuration array for object construction. contentType: the name (optional) of the content type to use for the serialization

Depuis

4.0.0

Références $config, Symfony\Contracts\Service\__construct(), et null.

Documentation des fonctions membres

prepareItem()

prepareItem (   $item )

protected

Prepare item before render.

Paramètres

object

$item

The model item

Renvoie

object

Depuis

4.0.0

Références $item.

queryEncode()

queryEncode (   $query )

protected

Encode square brackets in the URI query, according to JSON API specification.

Paramètres

string

$query

The URI query

Renvoie

string

Depuis

4.0.0

Références $query.

Documentation des champs

$document

$document

$fieldsToRenderItem

$fieldsToRenderItem = []

protected

$fieldsToRenderList

$fieldsToRenderList = []

protected

$relationship

$relationship = []

protected

$serializer

$serializer

protected

$type

$type

protected

---

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

• JsonApiView.php