Joomla! Platform 11.4

Download

Demo

Class JView

Description
Description | Variables (details) | Methods (details)

Base class for a Joomla View

Class holding methods for displaying presentation data.

  • since: 11.1

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

Class JObject   (Subpackage Base)

Class JView   (Subpackage Application)
Variable Summary
Description | Variables (details) | Methods (details)
Variable string $basePath
Variable string $charset
Variable string $defaultModel
Variable string $escape
Variable string $layout
Variable string $layoutExt
Variable string $layoutTemplate
Variable array $models
Variable array $name
Variable string $output
Variable array $path
Variable string $template
Variable string $_basePath
Variable string $_charset
Variable string $_defaultModel
Variable string $_escape
Variable string $_layout
Variable string $_layoutExt
Variable string $_layoutTemplate
Variable array $_models
Variable array $_name
Variable string $_output
Variable array $_path
Variable string $_template
Method Summary
Description | Variables (details) | Methods (details)
Constructor JView __construct ([array $config = array()])
Method void addHelperPath (mixed $path)
Method void addTemplatePath (mixed $path)
Method boolean assign ()
Method boolean assignRef (string $key, mixed &$val)
Method mixed display ([string $tpl = null])
Method mixed escape (mixed $var)
Method mixed get (string $property, [string $default = null])
Method string getLayout ()
Method string getLayoutTemplate ()
Method mixed getModel ([string $name = null])
Method string getName ()
Method void loadHelper ([string $hlp = null])
Method string loadTemplate ([string $tpl = null])
Method void setEscape (mixed $spec)
Method string setLayout (string $layout)
Method string setLayoutExt (string $value)
Method object The setModel (object &$model, [boolean $default = false])
Method void _addPath (string $type, mixed $path)
Method string _createFileName (string $type, [array $parts = array()])
Method void _setPath (string $type, mixed $path)
Variables
Description | Variables (details) | Methods (details)
string $basePath = null (line 58)

The base path of the view

  • access: protected
string $charset = 'UTF-8' (line 193)

Charset to use in escaping mechanisms; defaults to urf8 (UTF-8)

  • access: protected
string $defaultModel = null (line 73)

The default model

  • access: protected
string $escape = 'htmlspecialchars' (line 178)

Callback for escaping.

  • access: protected
string $layout = 'default' (line 88)

Layout name

  • access: protected
string $layoutExt = 'php' (line 103)

Layout extension

  • access: protected
string $layoutTemplate = '_' (line 118)

Layout template

  • access: protected
array $models = array() (line 43)

Registered models

  • access: protected
array $name = null (line 28)

The name of the view

  • access: protected
string $output = null (line 163)

The output of the template script.

  • access: protected
array $path = array('template' => array(),'helper'=>array()) (line 133)

The set of search directories for resources (templates)

  • access: protected
string $template = null (line 148)

The name of the default template source file.

  • access: protected
string $_basePath = null (line 66)

The base path of the view

  • deprecated: use $basePath declare as private
  • access: protected
string $_charset = 'UTF-8' (line 201)

Charset to use in escaping mechanisms; defaults to urf8 (UTF-8)

  • deprecated: use $charset declare as private
  • access: protected
string $_defaultModel = null (line 81)

The default model

  • deprecated: use $defaultModel declare as private
  • access: protected
string $_escape = 'htmlspecialchars' (line 186)

Callback for escaping.

  • deprecated: use $escape declare as private
  • access: protected
string $_layout = 'default' (line 96)

Layout name

  • deprecated: use $layout declare as private
  • access: protected
string $_layoutExt = 'php' (line 111)

Layout extension

  • deprecated: use $layoutExt declare as private
  • access: protected
string $_layoutTemplate = '_' (line 126)

Layout template

  • deprecated: use $layoutTemplate declare as private
  • access: protected
array $_models = array() (line 51)

Registered models

  • deprecated: use $models declare as private
  • access: protected
array $_name = null (line 36)

The name of the view

  • deprecated: use $name declare as private
  • access: protected
string $_output = null (line 171)

The output of the template script.

  • deprecated: use $output declare as private
  • access: protected
array $_path = array('template' => array(),'helper'=>array()) (line 141)

The set of search directories for resources (templates)

  • deprecated: use $path declare as private
  • access: protected
string $_template = null (line 156)

The name of the default template source file.

  • deprecated: use $template declare as private
  • access: protected

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
Description | Variables (details) Methods (details)
Constructor __construct (line 217)

Constructor

  • since: 11.1
  • access: public
JView __construct ([array $config = array()])
  • array $config: A 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
Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.
addHelperPath (line 672)

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

  • since: 11.1
  • access: public
void addHelperPath (mixed $path)
  • mixed $path: A directory path or an array of paths.
addTemplatePath (line 658)

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

  • since: 11.1
  • access: public
void addTemplatePath (mixed $path)
  • mixed $path: A directory path or an array of paths.
assign (line 345)

Assigns variables to the view script via differing strategies.

This method is overloaded; you can assign all the properties of an object, an associative array, or a single value by name.

You are not allowed to set variables that begin with an underscore; these are either private properties for JView or private variables within the template script itself.

  1.  $view = new JView;
  2.  
  3.  // Assign directly
  4.  $view->var1 = 'something';
  5.  $view->var2 = 'else';
  6.  
  7.  // Assign by name and value
  8.  $view->assign('var1', 'something');
  9.  $view->assign('var2', 'else');
  10.  
  11.  // Assign by assoc-array
  12.  $ary = array('var1' => 'something', 'var2' => 'else');
  13.  $view->assign($obj);
  14.  
  15.  // Assign by object
  16.  $obj = new stdClass;
  17.  $obj->var1 = 'something';
  18.  $obj->var2 = 'else';
  19.  $view->assign($obj);

  • return: True on success, false on failure.
  • access: public
boolean assign ()
assignRef (line 416)

Assign variable for the view (by reference).

You are not allowed to set variables that begin with an underscore; these are either private properties for JView or private variables within the template script itself.

  1.  $view = new JView;
  2.  
  3.  // Assign by name and value
  4.  $view->assignRef('var1', $ref);
  5.  
  6.  // Assign directly
  7.  $view->ref = &$var1;

  • return: True on success, false on failure.
  • since: 11.1
  • access: public
boolean assignRef (string $key, mixed &$val)
  • string $key: The name for the reference in the view.
  • mixed &$val: The referenced variable.
display (line 299)

Execute and display a template script.

  • return: A string if successful, otherwise a JError object.
  • see: fetch()
  • since: 11.1
  • access: public
mixed display ([string $tpl = null])
  • string $tpl: The name of the template file to parse; automatically searches through the template paths.
escape (line 439)

Escapes a value for output in a view script.

If escaping mechanism is either htmlspecialchars or htmlentities, uses $_encoding setting.

  • return: The escaped value.
  • since: 11.1
  • access: public
mixed escape (mixed $var)
  • mixed $var: The output to escape.
get (line 459)

Method to get data from a registered model or a property of the view

  • return: The return value of the method
  • since: 11.1
  • access: public
mixed get (string $property, [string $default = null])
  • string $property: The name of the method to call on the model or the property to get
  • string $default: The name of the model to reference or the default value [optional]
Redefinition of:
JObject::get()
Returns a property of the object or the default value if the property is not set.
getLayout (line 517)

Get the layout.

  • return: The layout name
  • access: public
string getLayout ()
getLayoutTemplate (line 527)

Get the layout template.

  • return: The layout template name
  • access: public
string getLayoutTemplate ()
getModel (line 503)

Method to get the model object

  • return: JModel object
  • since: 11.1
  • access: public
mixed getModel ([string $name = null])
  • string $name: The name of the model (optional)
getName (line 542)

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: 11.1
  • access: public
string getName ()
loadHelper (line 766)

Load a helper file

  • since: 11.1
  • access: public
void loadHelper ([string $hlp = null])
  • string $hlp: The name of the helper source file automatically searches the helper paths and compiles as needed.
loadTemplate (line 686)

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

  • return: The output of the the template script.
  • since: 11.1
  • 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.
setEscape (line 644)

Sets the _escape() callback.

  • since: 11.1
  • access: public
void setEscape (mixed $spec)
  • mixed $spec: The callback for _escape() to use.
setLayout (line 596)

Sets the layout name to use

  • return: Previous value.
  • since: 11.1
  • access: public
string setLayout (string $layout)
  • string $layout: The layout name or a string in format <template>:<layout file>
setLayoutExt (line 624)

Allows a different extension for the layout files to be used

  • return: Previous value
  • since: 11.1
  • access: public
string setLayoutExt (string $value)
  • string $value: The extension.
setModel (line 575)

Method to add a model to the view. We support a multiple model single

view system by which models are referenced by classname. A caveat to the classname referencing is that any classname prepended by JModel will be referenced by the name without JModel, eg. JModelCategory is just Category.

  • return: added model.
  • since: 11.1
  • access: public
object The setModel (object &$model, [boolean $default = false])
  • object &$model: The model to add to the view.
  • boolean $default: Is this the default model?
_addPath (line 828)

Adds to the search path for templates and resources.

  • since: 11.1
  • access: protected
void _addPath (string $type, mixed $path)
  • string $type: The type of path to add.
  • mixed $path: The directory or stream, or an array of either, to search.
_createFileName (line 861)

Create the filename for a resource

  • return: The filename
  • since: 11.1
  • 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
_setPath (line 792)

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

  • since: 11.1
  • access: protected
void _setPath (string $type, mixed $path)
  • string $type: The type of path to set, typically 'template'.
  • mixed $path: The new search path, or an array of search paths. If null or false, resets to the current directory only.

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()
Support Joomla!
/html>