Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de l'espace de nommage Joomla\CMS\Categories

Structures de données

class  Categories
 
class  CategoryFactory
 
interface  CategoryFactoryInterface
 
interface  CategoryInterface
 
class  CategoryNode
 
interface  CategoryServiceInterface
 
class  SectionNotFoundException
 

Fonctions

 getCategory (array $options=[], $section='')
 
 setCategoryFactory (CategoryFactoryInterface $categoryFactory)
 
 countItems (array $items, string $section)
 
 prepareForm (Form $form, $data)
 
 getTableNameForSection (string $section=null)
 
 getStateColumnForSection (string $section=null)
 

Variables

trait CategoryServiceTrait
 

Description détaillée

Joomla! Content Management System

Joomla! Content Management System

Joomla! Content Management System

Documentation des fonctions

◆ countItems()

Joomla\CMS\Categories\countItems ( array  $items,
string  $section 
)

◆ getCategory()

Joomla\CMS\Categories\getCategory ( array  $options = [],
  $section = '' 
)

Returns the category service.

Paramètres
array$optionsThe options
string$sectionThe section
Renvoie
CategoryInterface
Depuis
4.0.0
Exceptions
SectionNotFoundException

Références $options, et $section.

Référencé par CategoryModel\getChildren(), CategoryModel\getItems(), CategoryModel\getLeftSibling(), CategoryModel\getParent(), et CategoryModel\getRightSibling().

◆ getStateColumnForSection()

Joomla\CMS\Categories\getStateColumnForSection ( string  $section = null)
protected

Returns the state column for the count items functions for the given section.

Paramètres
string$sectionThe section
Renvoie
string|null
Depuis
4.0.0

Référencé par Joomla\CMS\Categories\countItems().

◆ getTableNameForSection()

Joomla\CMS\Categories\getTableNameForSection ( string  $section = null)
protected

Returns the table for the count items functions for the given section.

Paramètres
string$sectionThe section
Renvoie
string|null
Depuis
4.0.0

Références null.

Référencé par Joomla\CMS\Categories\countItems().

◆ prepareForm()

Joomla\CMS\Categories\prepareForm ( Form  $form,
  $data 
)

Prepares the category form

Paramètres
Form$formThe form to change
array | object$dataThe form data
Renvoie
void

Référencé par PlgSystemFields\onContentPrepareForm().

◆ setCategoryFactory()

Joomla\CMS\Categories\setCategoryFactory ( CategoryFactoryInterface  $categoryFactory)

Sets the internal category factory.

Paramètres
CategoryFactoryInterface$categoryFactoryThe categories factory
Renvoie
void
Depuis
4.0.0

Documentation des variables

◆ CategoryServiceTrait

trait CategoryServiceTrait
Valeur initiale :
{
private $categoryFactory

Trait for component categories service.

Depuis
4.0.0