Référence de la classe CategoryModel

Graphe d'héritage de CategoryModel:

Fonctions membres publiques
	__construct ($config=array())
	getItems ()
	getPagination ()
	getCategory ()
	getParent ()
&	getLeftSibling ()
&	getRightSibling ()
&	getChildren ()
	hit ($pk=0)
Fonctions membres publiques hérités de ListModel
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	getIsEmptyState ()
	getActiveFilters ()
	getItems ()
	getPagination ()
	getTotal ()
	getStart ()
	getFilterForm ($data=array(), $loadData=true)
	getUserStateFromRequest ($key, $request, $default=null, $type='none', $resetPage=true)
Fonctions membres publiques hérités de BaseDatabaseModel
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	getTable ($name='', $prefix='', $options=array())
	isCheckedOut ($item)
	getDbo ()
	setDbo (DatabaseInterface $db=null)
	__get ($name)
Fonctions membres publiques hérités de BaseModel
	__construct ($config=array())
	getName ()
Fonctions membres publiques hérités de CMSObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
Fonctions membres publiques hérités de StatefulModelInterface
	getState ($property=null, $default=null)
	setState ($property, $value=null)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de CurrentUserInterface
	setCurrentUser (User $currentUser)
Fonctions membres publiques hérités de CacheControllerFactoryAwareInterface
	setCacheControllerFactory (CacheControllerFactoryInterface $factory)
Fonctions membres publiques hérités de DatabaseAwareInterface
	setDatabase (DatabaseInterface $db)
Fonctions membres publiques hérités de FormFactoryAwareInterface
	setFormFactory (FormFactoryInterface $factory)

Fonctions membres protégées
	populateState ($ordering=null, $direction=null)
	_buildContentOrderBy ()
Fonctions membres protégées hérités de ListModel
	getEmptyStateQuery ()
	_getListQuery ()
	getListQuery ()
	getStoreId ($id='')
	loadFormData ()
	populateState ($ordering=null, $direction=null)
	refineSearchStringToRegex ($search, $regexDelimiter='/')
Fonctions membres protégées hérités de BaseDatabaseModel
	_getList ($query, $limitstart=0, $limit=0)
	_getListCount ($query)
	_createTable ($name, $prefix='Table', $config=array())
	bootComponent ($component)
	dispatchEvent (EventInterface $event)

Attributs protégés
	$_item = null
	$_articles = null
	$_siblings = null
	$_children = null
	$_parent = null
	$_context = 'com_content.category'
	$_category = null
	$_categories = null
Attributs protégés hérités de ListModel
	$cache = array()
	$context = null
	$filter_fields = array()
	$query = array()
	$lastQueryStoreId = null
	$filterFormName = null
	$htmlFormName = 'adminForm'
	$filterBlacklist = array()
	$filterForbiddenList = array()
	$listBlacklist = array('select')
	$listForbiddenList = array('select')
Attributs protégés hérités de BaseDatabaseModel
	$option = null
	$event_clean_cache = null
Attributs protégés hérités de BaseModel
	$name
Attributs protégés hérités de CMSObject
	$_errors = array()

Membres hérités additionnels
Fonctions membres publiques statiques hérités de BaseModel
static	addIncludePath ($path='', $prefix='')
Attributs protégés statiques hérités de BaseModel
static	$paths

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()

)

Paramètres

array

$config

An optional associative array of configuration settings.

Depuis

1.6

Références $config, et Symfony\Contracts\Service\__construct().

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, Factory\getApplication(), Joomla\Database\getDatabase(), null, QueryHelper\orderbyPrimary(), et QueryHelper\orderbySecondary().

getCategory()

getCategory

(

)

Method to get category data for the current category

Renvoie

object

Depuis

1.5

Références $options, $params, $user, Categories\getInstance(), Joomla\CMS\MVC\Model\getState(), et Factory\getUser().

getChildren()

& getChildren

(

)

Get the child categories.

Renvoie

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

Depuis

1.6

Références Joomla\CMS\Tree\$_children, $params, Joomla\CMS\Categories\getCategory(), Joomla\CMS\MVC\Model\getState(), et ArrayHelper\sortObjects().

getItems()

getItems

(

)

Get the articles in the category

Renvoie

array|bool An array of articles or false if an error occurs.

Depuis

1.5

Implémente ListModelInterface.

Références $category, $limit, $model, Factory\getApplication(), Joomla\CMS\Categories\getCategory(), Joomla\CMS\MVC\Model\getState(), 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

Références Joomla\CMS\Categories\getCategory().

getPagination()

getPagination

(

)

Method to get a JPagination object for the data set.

Renvoie

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

Références Joomla\CMS\Categories\getCategory().

getRightSibling()

& getRightSibling

(

)

Get the right sibling (adjacent) categories.

Renvoie

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

Depuis

1.6

Références Joomla\CMS\Categories\getCategory().

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, Factory\getApplication(), Table\getInstance(), et Joomla\CMS\MVC\Model\getState().

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, $itemid, $limit, $listOrder, $menu, $params, $user, $value, Factory\getApplication(), Factory\getUser(), Multilanguage\isEnabled(), et Joomla\CMS\MVC\Model\setState().

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/src/Model/CategoryModel.php