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

Fonctions membres publiques

 __construct ($config=array())
 
 display ($tpl=null)
 
 escape ($var)
 
 getLayout ()
 
 getLayoutTemplate ()
 
 setLayout ($layout)
 
 setLayoutExt ($value)
 
 addTemplatePath ($path)
 
 addHelperPath ($path)
 
 loadTemplate ($tpl=null)
 
 loadHelper ($hlp=null)
 
 getForm ()
 
 setDocumentTitle ($title)
 
- 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)
 
- Fonctions membres publiques hérités de CurrentUserInterface
 setCurrentUser (User $currentUser)
 

Fonctions membres protégées

 _setPath ($type, $path)
 
 _addPath ($type, $path)
 
 _createFileName ($type, $parts=array())
 
- Fonctions membres protégées hérités de AbstractView
 dispatchEvent (EventInterface $event)
 

Attributs protégés

 $_basePath = null
 
 $_layout = 'default'
 
 $_layoutExt = 'php'
 
 $_layoutTemplate = '_'
 
 $_path = array('template' => array(), 'helper' => array())
 
 $_template = null
 
 $_output = null
 
 $_charset = 'UTF-8'
 
- 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()
 

Membres hérités additionnels

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

Description détaillée

Base class for a Joomla Html 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, Symfony\Contracts\Service\__construct(), Uri\base(), et elseif.

Documentation des fonctions membres

◆ _addPath()

_addPath (   $type,
  $path 
)
protected

Adds to the search path for templates and resources.

Paramètres
string$typeThe type of path to add.
mixed$pathThe directory or stream, or an array of either, to search.
Renvoie
void
Depuis
3.0

Références $dir, $path, $type, et Path\clean().

◆ _createFileName()

_createFileName (   $type,
  $parts = array() 
)
protected

Create the filename for a resource

Paramètres
string$typeThe resource type to create the filename for
array$partsAn associative array of filename information
Renvoie
string The filename
Depuis
3.0

Références $parts, et $type.

◆ _setPath()

_setPath (   $type,
  $path 
)
protected

Sets an entire array of search paths for templates or resources.

Paramètres
string$typeThe type of path to set, typically 'template'.
mixed$pathThe new search path, or an array of search paths. If null or false, resets to the current directory only.
Renvoie
void
Depuis
3.0

Références $app, $component, $name, $option, $path, $template, $type, Factory\getApplication(), ApplicationHelper\getComponentName(), et JPATH_THEMES.

◆ addHelperPath()

addHelperPath (   $path)

Adds to the stack of helper script paths in LIFO order.

Paramètres
mixed$pathA directory path or an array of paths.
Renvoie
void
Depuis
3.0

Références $path.

◆ addTemplatePath()

addTemplatePath (   $path)

Adds to the stack of view script paths in LIFO order.

Paramètres
mixed$pathA directory path or an array of paths.
Renvoie
void
Depuis
3.0

Références $path.

◆ display()

display (   $tpl = null)

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
Exceptions

Implémente ViewInterface.

Références $app, $component, $context, $option, $result, $this, AbstractEvent\create(), Factory\getApplication(), et ApplicationHelper\getComponentName().

◆ escape()

escape (   $var)

Escapes a value for output in a view script.

If escaping mechanism is htmlspecialchars, use $_charset setting.

Paramètres
mixed$varThe output to escape.
Renvoie
mixed The escaped value.
Note
the ENT_COMPAT flag was replaced by ENT_QUOTES in Joomla 4.0 to also escape single quotes
Depuis
3.0

Références ENT_QUOTES, et null.

◆ getForm()

getForm ( )

Returns the form object

Renvoie
mixed A object on success, false on failure
Depuis
3.2

Références $form.

◆ getLayout()

getLayout ( )

Get the layout.

Renvoie
string The layout name
Depuis
3.0

◆ getLayoutTemplate()

getLayoutTemplate ( )

Get the layout template.

Renvoie
string The layout template name
Depuis
3.0

◆ loadHelper()

loadHelper (   $hlp = null)

Load a helper file

Paramètres
string$hlpThe name of the helper source file automatically searches the helper paths and compiles as needed.
Renvoie
void
Depuis
3.0

Références $helper, et Path\find().

◆ loadTemplate()

loadTemplate (   $tpl = null)

Load a template file – first look in the templates folder for an override

Paramètres
string$tplThe name of the template source file; automatically searches the template paths and compiles as needed.
Renvoie
string The output of the the template script.
Depuis
3.0
Exceptions

Références $lang, $layout, $template, $this, Path\find(), Factory\getApplication(), Factory\getLanguage(), JPATH_BASE, JPATH_THEMES, null, et Text\sprintf().

◆ setDocumentTitle()

setDocumentTitle (   $title)

Sets the document title according to Global Configuration options

Paramètres
string$titleThe page title
Renvoie
void
Depuis
3.6

Références $app, $title, elseif, Factory\getApplication(), et Text\sprintf().

◆ setLayout()

setLayout (   $layout)

Sets the layout name to use

Paramètres
string$layoutThe layout name or a string in format <template>:<layout file>="">
Renvoie
string Previous value.
Depuis
3.0

Références $layout, et $temp.

◆ setLayoutExt()

setLayoutExt (   $value)

Allows a different extension for the layout files to be used

Paramètres
string$valueThe extension.
Renvoie
string Previous value
Depuis
3.0

Références $value.

Documentation des champs

◆ $_basePath

$_basePath = null
protected

◆ $_charset

$_charset = 'UTF-8'
protected

◆ $_layout

$_layout = 'default'
protected

◆ $_layoutExt

$_layoutExt = 'php'
protected

◆ $_layoutTemplate

$_layoutTemplate = '_'
protected

◆ $_output

$_output = null
protected

◆ $_path

$_path = array('template' => array(), 'helper' => array())
protected

◆ $_template

$_template = null
protected

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