Class JView

The base path of the view

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

The default model

Callback for escaping.

Layout name

Layout extension

Layout template

Registered models

The name of the view

The output of the template script.

The set of search directories for resources (templates)

The name of the default template source file.

Constructor

Parameters:

properties - Either and associative array or another object to set the initial properties of the object.

Since:

11.1

Execute and display a template script.

Parameters:

The - name of the template file to parse; automatically searches through the template paths.

Throws:

object - An JError object.

See Also:

fetch()

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);

Returns:

True on success, false on failure.

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;

Parameters:

key - The name for the reference in the view.

&$val - The referenced variable.

Returns:

True on success, false on failure.

Escapes a value for output in a view script.

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

Parameters:

The - output to escape.

Returns:

The escaped value.

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

Parameters:

The - name of the method to call on the model or the property to get

The - name of the model to reference or the default value [optional]

Returns:

The return value of the method

Since:

11.1

See Also:

getProperties()

Method to get the model object

Parameters:

The - name of the model (optional)

Returns:

JModel object

Get the layout.

Returns:

The layout name

Get the layout template.

Returns:

The layout template name

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

Returns:

The name of the model

Since:

11.1

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.

Parameters:

model - The model to add to the view.

default - Is this the default model?

Returns:

The added model

Sets the layout name to use

Parameters:

The - layout name or a string in format