Référence de la classe ContactModelCategory

Graphe d'héritage de ContactModelCategory:

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

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

Attributs protégés
	$_item = null
	$_articles = null
	$_siblings = null
	$_children = null
	$_parent = null
	$_category = null
	$_categories = null

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

getCategory()

getCategory

(

)

Method to get category data for the current category

Renvoie

object The category object

Depuis

1.5

Références $active, $app, $menu, $options, et $params.

getChildren()

& getChildren

(

)

Get the child categories.

Renvoie

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

getItems()

getItems

(

)

Method to get a list of items.

Renvoie

mixed An array of objects on success, false on failure.

Références $i, $item, $items, et $n.

getLeftSibling()

& getLeftSibling

(

)

Get the sibling (adjacent) categories.

Renvoie

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

getListQuery()

getListQuery ( )

protected

Method to build an SQL query to load the list data.

Renvoie

string An SQL query

Depuis

1.6

TODO: we actually should be doing it but it's wrong this way . ' CASE WHEN CHAR_LENGTH(a.alias) THEN CONCAT_WS(\':\', a.id, a.alias) ELSE a.id END as slug, ' . ' CASE WHEN CHAR_LENGTH(c.alias) THEN CONCAT_WS(\':\', c.id, c.alias) ELSE c.id END AS catslug ');

Références $db, $groups, $query, $state, et $user.

getParent()

getParent

(

)

Get the parent category.

Renvoie

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

getRightSibling()

& getRightSibling

(

)

Get the sibling (adjacent) categories.

Renvoie

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

hit()

hit

(

$pk = 0

)

Increment the hit counter for the category.

Paramètres

integer

$pk

Optional primary key of the category to increment.

Renvoie

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

Depuis

3.2

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	An optional ordering field.
string	$direction	An optional direction (asc|desc).

Renvoie

void

Depuis

1.6

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

Documentation des champs

$_articles

$_articles = null

protected

$_categories

$_categories = null

protected

$_category

$_category = null

protected

$_children

$_children = null

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_contact/models/category.php