Docs for class JView

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

JView

Description

Base class for a Joomla View

Class holding methods for displaying presentation data.

since: 1.5
author: Johan Janssens <[email protected]>
author: Louis Landry <[email protected]>
author: Andrew Eddie
abstract:

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

 JObject   (Subpackage Base)

 JView   (Subpackage Application)

Variable Summary

string $_defaultModel

string $_layout

array $_models

array $_name

array $_path

Method Summary

JView __construct ([ $config = array()])

void addEscape ()

void addTemplatePath (string|array $path)

bool assign ()

bool assignRef (string $key, mixed &$val)

void display ([string $tpl = null])

mixed escape (mixed $value)

mixed &get (string $method, [string $model = null])

string getLayout ()

mixed &getModel ([string $name = null])

string loadTemplate ([ $tpl = null], string $_tpl)

void setEscape ()

void setLayout ( $layout, string $template)

object The &setModel ( &$model, [boolean $default = false], object $model)

void _addPath ( $type, string|array $path)

void _setPath (string $type, string|array $path)

Variables

string $_defaultModel = null (line 55)

The default model

access: protected

string $_layout = 'default' (line 63)

Layout name

access: protected

array $_models = array() (line 47)

Registered models

access: protected

array $_name = null (line 39)

The name of the view

access: protected

array $_path = array(
'template' => array()) (line 71)

The set of search directories for resources (templates)

access: protected

Methods

Constructor __construct (line 104)

Constructor

access: protected

JView __construct ([ $config = array()])

$config

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

addEscape (line 501)

Adds to the callbacks used when calling JView::escape().

Each parameter passed to this function is treated as a separate callback. For example:

$savant->addEscape(
'stripslashes',
'htmlspecialchars',
array('StaticClass', 'method'),
array($object, $method)
);

access: public

void addEscape ()

addTemplatePath (line 453)

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

void addTemplatePath (string|array $path)

string|array $path: The directory (-ies) to add.

assign (line 191)

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.

$view =& new JView();
// assign directly
$view->var1 = 'something';
$view->var2 = 'else';
// assign by name and value
$view->assign('var1', 'something');
$view->assign('var2', 'else');
// assign by assoc-array
$ary = array('var1' => 'something', 'var2' => 'else');
$view->assign($obj);
// assign by object
$obj = new stdClass;
$obj->var1 = 'something';
$obj->var2 = 'else';
$view->assign($obj);

return: True on success, false on failure.
access: public

bool assign ()

assignRef (line 262)

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.

$view = new JView();
// assign by name and value
$view->assignRef('var1', $ref);
// assign directly
$view->ref =& $var1;

return: True on success, false on failure.
access: public

bool assignRef (string $key, mixed &$val)

string $key: The name for the reference in the view.
mixed &$val: The referenced variable.

display (line 145)

Execute and display a template script.

see: fetch()
throws: object An JError object.

void display ([string $tpl = null])

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

escape (line 297)

Applies escaping to a value.

You can override the predefined escaping callbacks by passing added parameters as replacement callbacks.

// use predefined callbacks
$result = $view->escape($value);
// use replacement callbacks
$result = $view->escape(
$value,
'stripslashes',
'htmlspecialchars',
array('StaticClass', 'method'),
array($object, $method)
);

access: public

mixed escape (mixed $value)

mixed $value: The value to be escaped.

get (line 346)

Method to get data from a registered model

return: The return value of the method
access: public

mixed &get (string $method, [string $model = null])

string $method: The name of the method to call on the model
string $model: The name of the model to reference [optional]

Redefinition of:

JObject::get(): Returns a property of the object or the default value if the property is not set.

getLayout (line 442)

Get the layout.

return: The layout name
access: public

string getLayout ()

getModel (line 415)

Method to get the model object

return: JModel object
access: public

mixed &getModel ([string $name = null])

string $name: The name of the model (optional)

loadTemplate (line 515)

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

return: The output of the the template script.
access: protected

string loadTemplate ([ $tpl = null], string $_tpl)

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

setEscape (line 475)

Clears then sets the callbacks to use when calling JView::escape().

Each parameter passed to this function is treated as a separate callback. For example:

$view->setEscape(
'stripslashes',
'htmlspecialchars',
array('StaticClass', 'method'),
array($object, $method)
);

access: public

void setEscape ()

setLayout (line 430)

Sets the layout name to use

access: public

void setLayout ( $layout, string $template)

string $template: The template name.
$layout

setModel (line 397)

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
access: public

object The &setModel ( &$model, [boolean $default = false], object $model)

object $model: The model to add to the view.
boolean $default: Is this the default model?
&$model

_addPath (line 605)

Adds to the search path for templates and resources.

access: protected

void _addPath ( $type, string|array $path)

string|array $path: The directory or stream to search.
$type

_setPath (line 573)

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

access: protected

void _setPath (string $type, string|array $path)

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

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()

Documentation generated on Mon, 05 Mar 2007 21:31:28 +0000 by phpDocumentor 1.3.1