\JViewCategory

Synopsis

class JViewCategory extends JViewLegacy {

}

$_basePath — string
The base path of the view
$_charset — string
Charset to use in escaping mechanisms; defaults to urf8 (UTF-8)
$_defaultModel — string
The default model
$_errors — array
An array of error messages or Exception objects.
$_escape — string
Callback for escaping.
$_layout — string
Layout name
$_layoutExt — string
Layout extension
$_layoutTemplate — string
Layout template
$_models — array
Registered models
$_name — array
The name of the view
$_output — string
The output of the template script.
$_path — array
The set of search directories for resources (templates)
$_template — string
The name of the default template source file.
$categories — array
The list of other categories for this extension.
$category — JModelCategory
The category model object for this category
$children — array
Child objects
$defaultPageTitle — string
Default title to use for page title
$extension — string
The name of the extension for the category
$items — array
Category items data
$pagination — JPagination
Pagination object
$state — JRegistry
State data
$viewName — string
The name of the view to link individual items to

commonCategoryDisplay() — Method with common display elements used in category list displays
display() — Execute and display a template script.

addHelperPath() — Adds to the stack of helper script paths in LIFO order.
addTemplatePath() — Adds to the stack of view script paths in LIFO order.
assign() — Assigns variables to the view script via differing strategies.
assignRef() — Assign variable for the view (by reference).
display() — Execute and display a template script.
escape() — Escapes a value for output in a view script.
get() — Method to get data from a registered model or a property of the view
getForm() — Returns the form object
getLayout() — Get the layout.
getLayoutTemplate() — Get the layout template.
getModel() — Method to get the model object
getName() — Method to get the view name
loadHelper() — Load a helper file
loadTemplate() — Load a template file -- first look in the templates folder for an override
setEscape() — Sets the _escape() callback.
setLayout() — Sets the layout name to use
setLayoutExt() — Allows a different extension for the layout files to be used
setModel() — 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.

__toString() — Magic method to convert the object to a string gracefully.
def() — Sets a default value if not alreay assigned
get() — Returns a property of the object or the default value if the property is not set.
getError() — Get the most recent error message.
getErrors() — Return all errors, if any.
getProperties() — Returns an associative array of object properties.
set() — Modifies a property of the object, creating it if it does not already exist.
setError() — Add an error message.
setProperties() — Set the object properties based on a named array/hash.