[ Index ]

PHP Cross Reference of Joomla 2.5.4 DE

title

Body

[close]

/components/com_content/models/ -> category.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 418 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ContentModelCategory:: (10 methods):
  __construct()
  populateState()
  getItems()
  _buildContentOrderBy()
  getPagination()
  getCategory()
  getParent()
  getLeftSibling()
  getRightSibling()
  getChildren()


Class: ContentModelCategory  - X-Ref

This models supports retrieving a category, the articles associated with the category,
sibling, child and parent categories.

__construct($config = array()   X-Ref
Constructor.

param: array    An optional associative array of configuration settings.

populateState($ordering = null, $direction = null)   X-Ref
Method to auto-populate the model state.

Note. Calling getState in this method will result in recursion.

return    void

getItems()   X-Ref
Get the articles in the category

return: mixed    An array of articles or false if an error occurs.

_buildContentOrderBy()   X-Ref
Build the orderby for the query

return: string    $orderby portion of query

getPagination()   X-Ref
No description

getCategory()   X-Ref
Method to get category data for the current category

param: int        An optional ID
return: object

getParent()   X-Ref
Get the parent categorie.

param: int        An optional category id. If not supplied, the model state 'category.id' will be used.
return: mixed    An array of categories or false if an error occurs.

getLeftSibling()   X-Ref
Get the left sibling (adjacent) categories.

return: mixed    An array of categories or false if an error occurs.

getRightSibling()   X-Ref
Get the right sibling (adjacent) categories.

return: mixed    An array of categories or false if an error occurs.

getChildren()   X-Ref
Get the child categories.

param: int        An optional category id. If not supplied, the model state 'category.id' will be used.
return: mixed    An array of categories or false if an error occurs.



Generated: Tue Apr 3 11:40:28 2012 Cross-referenced by PHPXref 0.7.1