Class JViewCategory

Description

Base HTML View class for the a Category list

  • since: 3.2

Located in /libraries/legacy/view/category.php (line 19)

JObject
   |
   --JViewLegacy
      |
      --JViewCategory
Direct descendents
Class Description
 class ContactViewCategory HTML View class for the Contacts component
 class ContentViewCategory HTML View class for the Content component
 class NewsfeedsViewCategory HTML View class for the Newsfeeds component
 class WeblinksViewCategory HTML View class for the WebLinks component
Variable Summary
Method Summary
 void addFeed ()
 mixed display ([string $tpl = null])
 void prepareDocument ()
Variables
array $categories (line 51)

The list of other categories for this extension.

  • since: 3.2
  • access: protected
JModelCategory $category (line 43)

The category model object for this category

  • since: 3.2
  • access: protected
array $children (line 67)

Child objects

  • since: 3.2
  • access: protected
string $defaultPageTitle (line 91)

Default title to use for page title

  • since: 3.2
  • access: protected

Redefined in descendants as:
string $extension (line 75)

The name of the extension for the category

  • since: 3.2
  • access: protected

Redefined in descendants as:
array $items (line 35)

Category items data

  • since: 3.2
  • access: protected
JPagination $pagination (line 59)

Pagination object

  • since: 3.2
  • access: protected
JRegistry $state (line 27)

State data

  • since: 3.2
  • access: protected
string $viewName (line 83)

The name of the view to link individual items to

  • since: 3.2
  • access: protected

Redefined in descendants as:

Inherited Variables

Inherited from JViewLegacy

JViewLegacy::$_basePath
JViewLegacy::$_charset
JViewLegacy::$_defaultModel
JViewLegacy::$_escape
JViewLegacy::$_layout
JViewLegacy::$_layoutExt
JViewLegacy::$_layoutTemplate
JViewLegacy::$_models
JViewLegacy::$_name
JViewLegacy::$_output
JViewLegacy::$_path
JViewLegacy::$_template

Inherited from JObject

JObject::$_errors
Methods
addFeed (line 264)

Method to add an alternative feed link to a category layout.

  • since: 3.2
  • access: protected
void addFeed ()
commonCategoryDisplay (line 100)

Method with common display elements used in category list displays

  • since: 3.2
  • access: public
void commonCategoryDisplay ()
display (line 191)

Execute and display a template script.

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

Redefinition of:
JViewLegacy::display()
Execute and display a template script.

Redefined in descendants as:
prepareDocument (line 205)

Method to prepares the document

  • since: 3.2
  • access: protected
void prepareDocument ()

Redefined in descendants as:

Inherited Methods

Inherited From JViewLegacy

 JViewLegacy::__construct()
 JViewLegacy::addHelperPath()
 JViewLegacy::addTemplatePath()
 JViewLegacy::assign()
 JViewLegacy::assignRef()
 JViewLegacy::display()
 JViewLegacy::escape()
 JViewLegacy::get()
 JViewLegacy::getForm()
 JViewLegacy::getLayout()
 JViewLegacy::getLayoutTemplate()
 JViewLegacy::getModel()
 JViewLegacy::getName()
 JViewLegacy::loadHelper()
 JViewLegacy::loadTemplate()
 JViewLegacy::setEscape()
 JViewLegacy::setLayout()
 JViewLegacy::setLayoutExt()
 JViewLegacy::setModel()
 JViewLegacy::_addPath()
 JViewLegacy::_createFileName()
 JViewLegacy::_setPath()

Inherited From JObject

 JObject::__construct()
 JObject::def()
 JObject::get()
 JObject::getError()
 JObject::getErrors()
 JObject::getProperties()
 JObject::set()
 JObject::setError()
 JObject::setProperties()
 JObject::__toString()

Documentation generated on Tue, 19 Nov 2013 14:55:22 +0100 by phpDocumentor 1.4.3