Référence de la classe Categories

Graphe d'héritage de Categories:

Fonctions membres publiques
	__construct ($options)
	get ($id='root', $forceload=false)
	getExtension ()
Fonctions membres publiques hérités de DatabaseAwareInterface
	setDatabase (DatabaseInterface $db)

Fonctions membres publiques statiques
static	getInstance ($extension, $options=array())

Attributs publics statiques
static	$instances = array()

Fonctions membres protégées
	_load ($id)

Attributs protégés
	$_nodes
	$_checkedCategories
	$_extension = null
	$_table = null
	$_field = null
	$_key = null
	$_statefield = null
	$_options = []

Description détaillée

Categories Class.

Depuis

1.6

Documentation des constructeurs et destructeur

__construct()

__construct

(

$options

)

Class constructor

Paramètres

array

$options

Array of options

Depuis

1.6

Références $options, Factory\getLanguage(), et Multilanguage\isEnabled().

Documentation des fonctions membres

_load()

_load (   $id )

protected

Load method

Paramètres

integer

$id

Id of category to load

Renvoie

void

Depuis

1.6

Références $app, $db, $extension, $groups, $id, $query, $result, $results, $this, $user, class, elseif, Factory\getApplication(), Factory\getContainer(), Joomla\Database\getDatabase(), Factory\getLanguage(), Factory\getUser(), ParameterType\INTEGER, Multilanguage\isEnabled(), null, et ParameterType\STRING.

get()

get	(		$id = 'root',
			$forceload = false
	)

Loads a specific category and all its children in a CategoryNode object.

Paramètres

mixed	$id	an optional id integer or equal to 'root'
boolean	$forceload	True to force the _load method to execute

Renvoie

CategoryNode|null CategoryNode object or null if $id is not valid

Depuis

1.6

Implémente CategoryInterface.

Références $id, et null.

getExtension()

getExtension

(

)

Returns the extension of the category.

Renvoie

string The extension

Depuis

3.9.0

getInstance()

static getInstance (   $extension,   $options = array()  )

static

Returns a reference to a Categories object

Paramètres

string	$extension	Name of the categories extension
array	$options	An array of options

Renvoie

Categories|boolean Categories object on success, boolean false if an object does not exist

Depuis

1.6

Obsolète:

5.0 Use the ComponentInterface to get the categories

Références $component, $extension, $hash, $options, $parts, Factory\getApplication(), et null.

Référencé par HtmlView\_prepareDocument(), FeedView\display(), CategoryModel\getCategory(), RouteHelper\getCategoryRoute(), CategoriesModel\getItems(), ArticlesCategoriesHelper\getList(), RouteHelper\getRoute(), PopularHelper\getTitle(), LatestHelper\getTitle(), PlgFinderNewsfeeds\index(), et PlgFinderContacts\index().

Documentation des champs

$_checkedCategories

$_checkedCategories

protected

$_extension

$_extension = null

protected

$_field

$_field = null

protected

$_key

$_key = null

protected

$_nodes

$_nodes

protected

$_options

$_options = []

protected

$_statefield

$_statefield = null

protected

$_table

$_table = null

protected

$instances

$instances = array()

static

---

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

• Categories.php