Référence de la classe ContentModelCategory

Graphe d'héritage de ContentModelCategory:

Fonctions membres publiques
	__construct ($config=array())
	getItems ()
	getPagination ()
	getCategory ()
	getParent ()
&	getLeftSibling ()
&	getRightSibling ()
&	getChildren ()
	hit ($pk=0)

Fonctions membres protégées
	populateState ($ordering=null, $direction=null)
	_buildContentOrderBy ()

Attributs protégés
	$_item = null
	$_articles = null
	$_siblings = null
	$_children = null
	$_parent = null
	$_context = 'com_content.category'
	$_category = null
	$_categories = null

Description détaillée

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

Depuis

1.5

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = array()

)

Constructor.

Paramètres

array

$config

An optional associative array of configuration settings.

Depuis

1.6

Références $config.

Documentation des fonctions membres

_buildContentOrderBy()

_buildContentOrderBy ( )

protected

Build the orderby for the query

Renvoie

string $orderby portion of query

Depuis

1.5

Références $app, $db, $itemid, $params, null, ContentHelperQuery\orderbyPrimary(), et ContentHelperQuery\orderbySecondary().

getCategory()

getCategory

(

)

Method to get category data for the current category

Renvoie

object

Depuis

1.5

Références $asset, $options, $params, et $user.

getChildren()

& getChildren

(

)

Get the child categories.

Renvoie

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

Depuis

1.6

Références $params.

getItems()

getItems

(

)

Get the articles in the category

Renvoie

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

Depuis

1.5

Références $category, $limit, et null.

getLeftSibling()

& getLeftSibling

(

)

Get the left sibling (adjacent) categories.

Renvoie

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

Depuis

1.6

getPagination()

getPagination

(

)

Method to get a JPagination object for the data set.

Renvoie

JPagination A JPagination object for the data set.

Depuis

3.0.1

Références null.

getParent()

getParent

(

)

Get the parent category.

Renvoie

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

Depuis

1.6

getRightSibling()

& getRightSibling

(

)

Get the right sibling (adjacent) categories.

Renvoie

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

Depuis

1.6

hit()

hit

(

$pk = 0

)

Increment the hit counter for the category.

Paramètres

int

$pk

Optional primary key of the category to increment.

Renvoie

boolean True if successful; false otherwise and internal error set.

Références $input.

populateState()

populateState (   $ordering = null,   $direction = null  )

protected

Method to auto-populate the model state.

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

Paramètres

string	$ordering	The field to order on.
string	$direction	The direction to order on.

Renvoie

void

Depuis

1.6

Références $app, $asset, $itemid, $limit, $listOrder, $menu, $params, $user, $value, et Registry\loadString().

Documentation des champs

$_articles

$_articles = null

protected

$_categories

$_categories = null

protected

$_category

$_category = null

protected

$_children

$_children = null

protected

$_context

$_context = 'com_content.category'

protected

$_item

$_item = null

protected

$_parent

$_parent = null

protected

$_siblings

$_siblings = null

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• components/com_content/models/category.php