Docs For Class ConfigViewCmsHtml

Description

Prototype admin view.

abstract:
since: 3.2

Located in /components/com_config/view/cms/html.php (line 19)

JViewBase
   |
   --JViewHtml
      |
      --ConfigViewCmsHtml

Direct descendents

Class	Description
ConfigViewApplicationHtml	View for the global configuration
ConfigViewComponentHtml	View for the component configuration
ConfigViewCmsJson	Prototype admin view.
ConfigViewConfigHtml	View for the global configuration
ConfigViewTemplatesHtml	View to edit a template style.

Variable Summary

string $_layoutExt

string $_output

array $_path

string $_template

Method Summary

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

string getName ()

string loadTemplate ([string $tpl = null])

string _createFileName (string $type, [array $parts = array()])

Variables

string $_layoutExt = 'php' (line 51)

Layout extension

since: 3.2
access: protected

string $_output = null (line 27)

The output of the template script.

since: 3.2
access: protected

array $_path = array('template' => array(),'helper'=>array()) (line 43)

The set of search directories for resources (templates)

since: 3.2
access: protected

string $_template = null (line 35)

The name of the default template source file.

since: 3.2
access: protected

Inherited Variables

Inherited from JViewHtml

JViewHtml::$layout
JViewHtml::$paths

Inherited from JViewBase

JViewBase::$model

Methods

Constructor __construct (line 61)

Method to instantiate the view.

since: 3.2
access: public

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

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

Redefinition of:

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

getName (line 205)

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

return: The name of the model
since: 3.2
throws: Exception
access: public

string getName ()

loadTemplate (line 85)

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

return: The output of the the template script.
since: 3.2
throws: Exception
access: public

string loadTemplate ([string $tpl = null])

string $tpl: The name of the template source file; automatically searches the template paths and compiles as needed.

_createFileName (line 176)

Create the filename for a resource

return: The filename
since: 3.2
access: protected

string _createFileName (string $type, [array $parts = array()])

string $type: The resource type to create the filename for
array $parts: An associative array of filename information

Inherited Methods

Inherited From JViewHtml

JViewHtml::__construct()
JViewHtml::escape()
JViewHtml::getLayout()
JViewHtml::getPath()
JViewHtml::getPaths()
JViewHtml::loadPaths()
JViewHtml::render()
JViewHtml::setLayout()
JViewHtml::setPaths()
JViewHtml::__toString()

Inherited From JViewBase

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