Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JViewHtml
+ Graphe d'héritage de JViewHtml:
+ Graphe de collaboration de JViewHtml:

Liste de tous les membres

Fonctions membres publiques

 __construct (JModel $model, SplPriorityQueue $paths=null)
 __toString ()
 escape ($output)
 getLayout ()
 getPath ($layout)
 getPaths ()
 render ()
 setLayout ($layout)
 setPaths (SplPriorityQueue $paths)
- Fonctions membres publiques inherited from JViewBase
 __construct (JModel $model)

Fonctions membres protégées

 loadPaths ()

Attributs protégés

 $layout = 'default'
 $paths
- Attributs protégés inherited from JViewBase
 $model

Description détaillée

Définition à la ligne 21 du fichier html.php.


Documentation des constructeurs et destructeur

JViewHtml::__construct ( JModel  $model,
SplPriorityQueue  $paths = null 
)

Method to instantiate the view.

Paramètres:
JModel$modelThe model object.
SplPriorityQueue$pathsThe paths queue.
Depuis:
12.1

Définition à la ligne 47 du fichier html.php.

{
// Setup dependencies.
$this->paths = isset($paths) ? $paths : $this->loadPaths();
}

Documentation des fonctions membres

JViewHtml::__toString ( )

Magic toString method that is a proxy for the render method.

Renvoie:
string
Depuis:
12.1

Définition à la ligne 62 du fichier html.php.

{
return $this->render();
}
JViewHtml::escape (   $output)

Method to escape output.

Paramètres:
string$outputThe output to escape.
Renvoie:
string The escaped output.
Voir également:
JView::escape()
Depuis:
12.1

Réimplémentée à partir de JViewBase.

Définition à la ligne 77 du fichier html.php.

{
// Escape the output.
return htmlspecialchars($output, ENT_COMPAT, 'UTF-8');
}
JViewHtml::getLayout ( )

Method to get the view layout.

Renvoie:
string The layout name.
Depuis:
12.1

Définition à la ligne 90 du fichier html.php.

{
return $this->layout;
}
JViewHtml::getPath (   $layout)

Method to get the layout path.

Paramètres:
string$layoutThe layout name.
Renvoie:
mixed The layout file name if found, false otherwise.
Depuis:
12.1

Définition à la ligne 104 du fichier html.php.

Références JPath\clean(), et JPath\find().

{
// Get the layout file name.
$file = JPath::clean($layout . '.php');
// Find the layout file path.
$path = JPath::find(clone($this->paths), $file);
return $path;
}

+ Voici le graphe d'appel pour cette fonction :

JViewHtml::getPaths ( )

Method to get the view paths.

Renvoie:
SplPriorityQueue The paths queue.
Depuis:
12.1

Définition à la ligne 122 du fichier html.php.

{
return $this->paths;
}
JViewHtml::loadPaths ( )
protected

Method to load the paths queue.

Renvoie:
SplPriorityQueue The paths queue.
Depuis:
12.1

Définition à la ligne 197 du fichier html.php.

{
return new SplPriorityQueue;
}
JViewHtml::render ( )

Method to render the view.

Renvoie:
string The rendered view.
Depuis:
12.1
Exceptions:
RuntimeException

Implémente JView.

Définition à la ligne 135 du fichier html.php.

{
// Get the layout path.
$path = $this->getPath($this->getLayout());
// Check if the layout path was found.
if (!$path)
{
throw new RuntimeException('Layout Path Not Found');
}
// Start an output buffer.
ob_start();
// Load the layout.
include $path;
// Get the layout contents.
$output = ob_get_clean();
return $output;
}
JViewHtml::setLayout (   $layout)

Method to set the view layout.

Paramètres:
string$layoutThe layout name.
Renvoie:
JViewHtml Method supports chaining.
Depuis:
12.1

Définition à la ligne 167 du fichier html.php.

{
$this->layout = $layout;
return $this;
}
JViewHtml::setPaths ( SplPriorityQueue  $paths)

Method to set the view paths.

Paramètres:
SplPriorityQueue$pathsThe paths queue.
Renvoie:
JViewHtml Method supports chaining.
Depuis:
12.1

Définition à la ligne 183 du fichier html.php.

{
$this->paths = $paths;
return $this;
}

Documentation des données membres

JViewHtml::$layout = 'default'
protected

Définition à la ligne 29 du fichier html.php.

JViewHtml::$paths
protected

Définition à la ligne 37 du fichier html.php.


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