Docs For Class JViewHtml

Description

Joomla Platform HTML View Class

abstract:
since: 12.1

Located in /libraries/joomla/view/html.php (line 21)

JViewBase
   |
   --JViewHtml

Direct descendents

Class	Description
ConfigViewCmsHtml	Prototype admin view.
InstallationViewCompleteHtml	The Installation Complete View
InstallationViewDefault	Generic Installation View
InstallationViewDefaultlanguageHtml	The Installation Default Language View
InstallationViewInstallHtml	The Installation Install View
InstallationViewLanguagesHtml	The Installation Languages View
InstallationViewRemoveHtml	The HTML Joomla Core Install Remove View

Variable Summary

string $layout

SplPriorityQueue $paths

Method Summary

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

string escape (string $output)

string getLayout ()

mixed getPath (string $layout)

SplPriorityQueue getPaths ()

SplPriorityQueue loadPaths ()

string render ()

JViewHtml setLayout (string $layout)

JViewHtml setPaths (SplPriorityQueue $paths)

string __toString ()

Variables

string $layout = 'default' (line 29)

The view layout.

since: 12.1
access: protected

SplPriorityQueue $paths (line 37)

The paths queue.

since: 12.1
access: protected

Inherited Variables

Inherited from JViewBase

JViewBase::$model

Methods

Constructor __construct (line 47)

Method to instantiate the view.

since: 12.1
access: public

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

JModel $model: The model object.
SplPriorityQueue $paths: The paths queue.

Redefinition of:

JViewBase::__construct(): Method to instantiate the view.

Redefined in descendants as:

ConfigViewCmsHtml::__construct() : Method to instantiate the view.

escape (line 77)

Method to escape output.

return: The escaped output.
see: JView::escape()
since: 12.1
access: public

string escape (string $output)

string $output: The output to escape.

Redefinition of:

JViewBase::escape(): Method to escape output.

getLayout (line 90)

Method to get the view layout.

return: The layout name.
since: 12.1
access: public

string getLayout ()

getPath (line 104)

Method to get the layout path.

return: The layout file name if found, false otherwise.
since: 12.1
access: public

mixed getPath (string $layout)

string $layout: The layout name.

getPaths (line 122)

Method to get the view paths.

return: The paths queue.
since: 12.1
access: public

SplPriorityQueue getPaths ()

loadPaths (line 197)

Method to load the paths queue.

return: The paths queue.
since: 12.1
access: protected

SplPriorityQueue loadPaths ()

render (line 135)

Method to render the view.

return: The rendered view.
since: 12.1
throws: RuntimeException
access: public

string render ()

Redefined in descendants as:

ConfigViewApplicationHtml::render() : Method to display the view.
ConfigViewComponentHtml::render() : Display the view
ConfigViewCmsJson::render() : Method to render the view.
ConfigViewApplicationJson::render() : Display the view
ConfigViewConfigHtml::render() : Method to render the view.
ConfigViewTemplatesHtml::render() : Method to render the view.
InstallationViewCompleteHtml::render() : Method to render the view.
InstallationViewDefault::render() : Method to render the view.
InstallationViewPreinstallHtml::render() : Method to render the view.
InstallationViewSummaryHtml::render() : Method to render the view.
InstallationViewDefaultlanguageHtml::render() : Method to render the view.
InstallationViewInstallHtml::render() : Method to render the view.
InstallationViewLanguagesHtml::render() : Method to render the view.

setLayout (line 167)

Method to set the view layout.

return: Method supports chaining.
since: 12.1
access: public

JViewHtml setLayout (string $layout)

string $layout: The layout name.

setPaths (line 183)

Method to set the view paths.

return: Method supports chaining.
since: 12.1
access: public

JViewHtml setPaths (SplPriorityQueue $paths)

SplPriorityQueue $paths: The paths queue.

__toString (line 62)

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

since: 12.1
access: public

string __toString ()

Inherited Methods

Inherited From JViewBase

JViewBase::__construct()
JViewBase::escape()