Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe FOFViewJson
+ Graphe d'héritage de FOFViewJson:

Fonctions membres publiques

 __construct ($config=array())
 
- Fonctions membres publiques hérités de FOFViewHtml
 __construct ($config=array())
 
 setPageTitle ()
 
- Fonctions membres publiques hérités de FOFViewRaw
 __construct ($config=array())
 
 display ($tpl=null)
 
 hasAjaxOrderingSupport ()
 
 getLists ()
 
 getPerms ()
 
- Fonctions membres publiques hérités de FOFView
 __construct ($config=array())
 
 loadAnyTemplate ($path='', $forceParams=array())
 
 display ($tpl=null)
 
 assign ()
 
 assignRef ($key, &$val)
 
 escape ($var)
 
 get ($property, $default=null)
 
 getModel ($name=null)
 
 getLayout ()
 
 getLayoutTemplate ()
 
 getName ()
 
 setModel ($model, $default=false, $name=null)
 
 setLayout ($layout)
 
 setLayoutExt ($value)
 
 setEscape ($spec)
 
 addTemplatePath ($path)
 
 addHelperPath ($path)
 
 loadTemplate ($tpl=null, $strict=false)
 
getRenderer ()
 
 setRenderer (FOFRenderAbstract &$renderer)
 
 setPreRender ($value)
 
 setPostRender ($value)
 
 loadHelper ($hlp=null)
 
 getViewOptionAndName ()
 
- Fonctions membres publiques hérités de FOFUtilsObject
 __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)
 

Champs de données

 $useHypermedia = false
 
- Champs de données hérités de FOFViewHtml
 $setFrontendPageTitle = false
 
 $defaultPageTitle = null
 

Fonctions membres protégées

 onDisplay ($tpl=null)
 
 onRead ($tpl=null)
 
 _createDocumentWithHypermedia ($data, $model=null)
 
 _removeURIBase ($uri)
 
 _getPrototypeURIForPagination ()
 
- Fonctions membres protégées hérités de FOFViewHtml
 preRender ()
 
 postRender ()
 
- Fonctions membres protégées hérités de FOFViewRaw
 preRender ()
 
 postRender ()
 
 onBrowse ($tpl=null)
 
 onDisplay ($tpl=null)
 
 onAdd ($tpl=null)
 
 onEdit ($tpl=null)
 
 onRead ($tpl=null)
 
- Fonctions membres protégées hérités de FOFView
 findRenderer ()
 
 _setPath ($type, $path)
 
 _addPath ($type, $path)
 
 _createFileName ($type, $parts=array())
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de FOFView
static registerRenderer (FOFRenderAbstract &$renderer)
 
- Attributs publics statiques hérités de FOFView
static $renderers = array()
 
- Attributs protégés hérités de FOFViewRaw
 $lists = null
 
 $perms = null
 
- Attributs protégés hérités de FOFView
 $_name = null
 
 $_models = array()
 
 $_basePath = null
 
 $_defaultModel = null
 
 $_layout = 'default'
 
 $_layoutExt = 'php'
 
 $_layoutTemplate = '_'
 
 $_path = array('template' => array(), 'helper' => array())
 
 $_template = null
 
 $_output = null
 
 $_escape = 'htmlspecialchars'
 
 $_charset = 'UTF-8'
 
 $config = array()
 
 $input = null
 
 $rendererObject = null
 
 $doPreRender = true
 
 $doPostRender = true
 
- Attributs protégés hérités de FOFUtilsObject
 $_errors = array()
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array())

Public constructor

Paramètres
array$configThe component's configuration array

Références $config.

Documentation des fonctions membres

◆ _createDocumentWithHypermedia()

_createDocumentWithHypermedia (   $data,
  $model = null 
)
protected

Creates a FOFHalDocument using the provided data

Paramètres
array$dataThe data to put in the document
FOFModel$modelThe model of this view
Renvoie
FOFHalDocument A HAL-enabled document

Références $count, $data, $document, $uri, et null.

◆ _getPrototypeURIForPagination()

_getPrototypeURIForPagination ( )
protected

Returns a JUri instance with a prototype URI used as the base for the other URIs created by the JSON renderer

Renvoie
JUri The prototype JUri instance

◆ _removeURIBase()

_removeURIBase (   $uri)
protected

Convert an absolute URI to a relative one

Paramètres
string$uriThe URI to convert
Renvoie
string The relative URL

Références $root, $uri, FOFPlatform\getInstance(), et null.

◆ onDisplay()

onDisplay (   $tpl = null)
protected

The event which runs when we are displaying the record list JSON view

Paramètres
string$tplThe view sub-template to use
Renvoie
boolean True to allow display of the view

Références $document, $items, FOFPlatform\getInstance(), items, json_encode, et null.

◆ onRead()

onRead (   $tpl = null)
protected

The event which runs when we are displaying a single item JSON view

Paramètres
string$tplThe view sub-template to use
Renvoie
boolean True to allow display of the view

Références $document, $item, FOFPlatform\getInstance(), item, json_encode, et null.

Documentation des champs

◆ $useHypermedia

$useHypermedia = false

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