Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe AbstractView
+ Graphe d'héritage de AbstractView:

Fonctions membres publiques

 __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
 

Fonctions membres protégées

 dispatchEvent (EventInterface $event)
 

Attributs protégés

 $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 View

Class holding methods for displaying presentation data.

Depuis
2.5.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array())

Constructor

Paramètres
array$configA named configuration array for object construction. name: the name (optional) of the view (defaults to the view class name suffix). charset: the character set to use for display escape: the name (optional) of the function to use for escaping strings base_path: the parent path (optional) of the views directory (defaults to the component folder) template_plath: the path (optional) of the layout directory (defaults to base_path + /views/ + view name helper_path: the path (optional) of the helper files (defaults to base_path + /helpers/) layout: the layout (optional) to use to display the view
Depuis
3.0

Références $config.

Documentation des fonctions membres

◆ dispatchEvent()

dispatchEvent ( EventInterface  $event)
protected

Dispatches the given event on the internal dispatcher, does a fallback to the global one.

Paramètres
EventInterface$eventThe event
Renvoie
void
Depuis
4.1.0

Références class, Factory\getContainer(), Joomla\CMS\Application\getDispatcher(), et EventInterface\getName().

◆ display()

display (   $tpl = null)
abstract

Execute and display a template script.

Paramètres
string$tplThe name of the template file to parse; automatically searches through the template paths.
Renvoie
void
Depuis
3.0

Implémente ViewInterface.

◆ get()

get (   $property,
  $default = null 
)

Method to get data from a registered model or a property of the view

Paramètres
string$propertyThe name of the method to call on the model or the property to get
string$defaultThe name of the model to reference or the default value [optional]
Renvoie
mixed The return value of the method
Depuis
3.0

Références $default, $method, $model, Symfony\Contracts\Service\get(), et null.

◆ getModel()

getModel (   $name = null)

Method to get the model object

Paramètres
string$nameThe name of the model (optional)
Renvoie
BaseDatabaseModel The model object
Depuis
3.0

Implémente ViewInterface.

Références $name, et null.

◆ getName()

getName ( )

Method to get the view name

The model name by default parsed using the classname, or it can be set by passing a $config['name'] in the class constructor

Renvoie
string The name of the model
Depuis
3.0
Exceptions

Références $className, $this, et Text\sprintf().

◆ setModel()

setModel (   $model,
  $default = false 
)

Method to add a model to the view. We support a multiple model single view system by which models are referenced by classname. A caveat to the classname referencing is that any classname prepended by will be referenced by the name without , eg. is just Category.

Paramètres
BaseDatabaseModel$modelThe model to add to the view.
boolean$defaultIs this the default model?
Renvoie
BaseDatabaseModel The added model.
Depuis
3.0

Références $default, $model, et $name.

Documentation des champs

◆ $_defaultModel

$_defaultModel = null
protected

◆ $_models

$_models = array()
protected

◆ $_name

$_name = null
protected

◆ $document

$document

◆ $option

$option = null
protected

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