[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/MVC/View/ -> HtmlView.php (summary)

Joomla! Content Management System

Copyright: (C) 2006 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 595 lines (18 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

HtmlView:: (16 methods):
  __construct()
  display()
  escape()
  getLayout()
  getLayoutTemplate()
  setLayout()
  setLayoutExt()
  addTemplatePath()
  addHelperPath()
  loadTemplate()
  loadHelper()
  _setPath()
  _addPath()
  _createFileName()
  getForm()
  setDocumentTitle()


Class: HtmlView  - X-Ref

Base class for a Joomla Html View

Class holding methods for displaying presentation data.

__construct($config = array()   X-Ref
Constructor

param: array  $config  A named configuration array for object construction.

display($tpl = null)   X-Ref
Execute and display a template script.

param: string  $tpl  The name of the template file to parse; automatically searches through the template paths.
return: void

escape($var)   X-Ref
Escapes a value for output in a view script.

If escaping mechanism is htmlspecialchars, use
{@link $_charset} setting.

param: mixed  $var  The output to escape.
return: mixed  The escaped value.

getLayout()   X-Ref
Get the layout.

return: string  The layout name

getLayoutTemplate()   X-Ref
Get the layout template.

return: string  The layout template name

setLayout($layout)   X-Ref
Sets the layout name to use

param: string  $layout  The layout name or a string in format <template>:<layout file>
return: string  Previous value.

setLayoutExt($value)   X-Ref
Allows a different extension for the layout files to be used

param: string  $value  The extension.
return: string  Previous value

addTemplatePath($path)   X-Ref
Adds to the stack of view script paths in LIFO order.

param: mixed  $path  A directory path or an array of paths.
return: void

addHelperPath($path)   X-Ref
Adds to the stack of helper script paths in LIFO order.

param: mixed  $path  A directory path or an array of paths.
return: void

loadTemplate($tpl = null)   X-Ref
Load a template file -- first look in the templates folder for an override

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

loadHelper($hlp = null)   X-Ref
Load a helper file

param: string  $hlp  The name of the helper source file automatically searches the helper paths and compiles as needed.
return: void

_setPath($type, $path)   X-Ref
Sets an entire array of search paths for templates or resources.

param: string  $type  The type of path to set, typically 'template'.
param: mixed   $path  The new search path, or an array of search paths.  If null or false, resets to the current directory only.
return: void

_addPath($type, $path)   X-Ref
Adds to the search path for templates and resources.

param: string  $type  The type of path to add.
param: mixed   $path  The directory or stream, or an array of either, to search.
return: void

_createFileName($type, $parts = array()   X-Ref
Create the filename for a resource

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

getForm()   X-Ref
Returns the form object

return: mixed  A \JForm object on success, false on failure

setDocumentTitle($title)   X-Ref
Sets the document title according to Global Configuration options

param: string  $title  The page title
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer