Référence de la classe JsonapiDocument

Graphe d'héritage de JsonapiDocument:

Fonctions membres publiques
	__construct ($options=array())
	setData (ElementInterface $element)
	setErrors ($errors)
	setJsonapi ($jsonapi)
	toArray ()
	__toString ()
	render ($cache=false, $params=array())
	jsonSerialize ()
	addLink ($key, $value)
	addMeta ($key, $value)
Fonctions membres publiques hérités de JsonDocument
	__construct ($options=array())
	getName ()
	setName ($name='joomla')
Fonctions membres publiques hérités de Document
	__construct ($options=array())
	setFactory (FactoryInterface $factory)
	setType ($type)
	getType ()
	getBuffer ()
	setBuffer ($content, $options=array())
	getMetaData ($name, $attribute='name')
	setMetaData ($name, $content, $attribute='name')
	addScript ($url, $options=array(), $attribs=array())
	addScriptDeclaration ($content, $type='text/javascript')
	addScriptOptions ($key, $options, $merge=true)
	getScriptOptions ($key=null)
	addStyleSheet ($url, $options=array(), $attribs=array())
	addStyleDeclaration ($content, $type='text/css')
	setCharset ($type='utf-8')
	getCharset ()
	setLanguage ($lang='en-gb')
	getLanguage ()
	setDirection ($dir='ltr')
	getDirection ()
	setTitle ($title)
	getTitle ()
	setMediaVersion ($mediaVersion)
	getMediaVersion ()
	setPreloadManager (PreloadManagerInterface $preloadManager)
	getPreloadManager ()
	setWebAssetManager (WebAssetManager $webAsset)
	getWebAssetManager ()
	setBase ($base)
	getBase ()
	setDescription ($description)
	getDescription ()
	setLink ($url)
	getLink ()
	setGenerator ($generator)
	getGenerator ()
	setModifiedDate ($date)
	getModifiedDate ()
	setMimeEncoding ($type='text/html', $sync=true)
	getMimeEncoding ()
	setLineEnd ($style)
	_getLineEnd ()
	setTab ($string)
	_getTab ()
	loadRenderer ($type)
	parse ($params=array())
	render ($cache=false, $params=array())

Attributs protégés
	$document
Attributs protégés hérités de JsonDocument
	$_name = 'joomla'
Attributs protégés hérités de Document
	$scriptOptions = array()
	$mediaVersion = null
	$factory
	$preloadManager = null
	$preloadTypes = ['preload', 'dns-prefetch', 'preconnect', 'prefetch', 'prerender']
	$webAssetManager = null

Membres hérités additionnels
Fonctions membres publiques statiques hérités de Document
static	getInstance ($type='html', $attributes=array())
Champs de données hérités de Document
	$title = ''
	$description = ''
	$link = ''
	$base = ''
	$language = 'en-gb'
	$direction = 'ltr'
	$_generator = 'Joomla! - Open Source Content Management'
	$_mdate = ''
	$_tab = "\11"
	$_lineEnd = "\12"
	$_charset = 'utf-8'
	$_mime = ''
	$_namespace = ''
	$_profile = ''
	$_scripts = array()
	$_script = array()
	$_styleSheets = array()
	$_style = array()
	$_metaTags = array()
	$_engine = null
	$_type = null
Attributs publics statiques hérités de Document
static	$_buffer = null
Fonctions membres protégées hérités de Document
	preloadAssets ()
Attributs protégés statiques hérités de Document
static	$instances = array()

Description détaillée

JsonapiDocument class, provides an easy interface to parse output in JSON-API format.

4.0.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

$options = array()

)

Class constructor.

Paramètres

array

$options

Associative array of options

Depuis

4.0.0

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

Documentation des fonctions membres

__toString()

__toString

(

)

Map to string.

Renvoie

string

Depuis

4.0.0

addLink()

addLink	(		$key,
			$value
	)

Add a link to the output.

Paramètres

string	$key	The name of the link
string	$value	The link

Renvoie

$this

Depuis

4.0.0

Références $key, $this, et $value.

addMeta()

addMeta	(		$key,
			$value
	)

Add a link to the output.

Paramètres

string	$key	The name of the metadata key
string	$value	The value

Renvoie

$this

Depuis

4.0.0

Références $key, $this, et $value.

jsonSerialize()

jsonSerialize

(

)

Serialize for JSON usage.

Renvoie

array

Depuis

4.0.0

render()

render	(		$cache = false,
			$params = array()
	)

Outputs the document.

Paramètres

boolean	$cache	If true, cache the output.
array	$params	Associative array of attributes.

Renvoie

string The rendered data.

Depuis

4.0.0

Références Document\$_charset, Document\$_mime, $app, Factory\getApplication(), et Document\getModifiedDate().

setData()

setData

(

ElementInterface

$element

)

Set the data object.

Paramètres

ElementInterface

$element

Element interface.

Renvoie

$this

Depuis

4.0.0

Références $this.

setErrors()

setErrors

(

$errors

)

Set the errors array.

Paramètres

array

$errors

Error array.

Renvoie

$this

Depuis

4.0.0

Références $this.

setJsonapi()

setJsonapi

(

$jsonapi

)

Set the JSON-API array.

Paramètres

array

$jsonapi

JSON-API array.

Renvoie

$this

Depuis

4.0.0

Références $this.

toArray()

toArray

(

)

Map everything to arrays.

Renvoie

array

Depuis

4.0.0

Documentation des champs

$document

$document

protected

---

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

• JsonapiDocument.php