Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe TagsModelTags
+ Graphe d'héritage de TagsModelTags:

Fonctions membres publiques

 __construct ($config=array())
 
 checkin ($pks=array())
 
 getTable ($type='Tag', $prefix='TagsTable', $config=array())
 
 getItems ()
 
 countItems (&$items, $extension)
 
 getItems ()
 

Champs de données

 $_context = 'com_tags.tags'
 

Fonctions membres protégées

 populateState ($ordering='a.lft', $direction='asc')
 
 getStoreId ($id='')
 
 getListQuery ()
 
 populateState ($ordering=null, $direction=null)
 
 getListQuery ()
 

Description détaillée

Tags Component Tags Model

Depuis
3.1

This models supports retrieving a list of tags.

Depuis
3.1

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array())

Constructor.

Paramètres
array$configAn optional associative array of configuration settings.
Voir également
JController
Depuis
3.0.3

Références $config.

Documentation des fonctions membres

◆ checkin()

checkin (   $pks = array())

Method override to check-in a record or an array of record

Paramètres
mixed$pksThe ID of the primary key or an array of IDs
Renvoie
mixed Boolean false if there is an error, otherwise the count of records checked in.
Depuis
12.2

Références $count, et $user.

◆ countItems()

countItems ( $items,
  $extension 
)

Method to load the countItems method from the extensions

Paramètres
stdClass[]&$items The category items
string$extensionThe category extension
Renvoie
void
Depuis
3.5

Références $component, $extension, $file, $items, $parts, $prefix, $section, JPath\clean(), JPATH_ADMINISTRATOR, null, et JLoader\register().

◆ getItems() [1/2]

getItems ( )

Redefine the function and add some properties to make the styling more easy

Renvoie
mixed An array of data items on success, false on failure.
Depuis
3.1

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

◆ getItems() [2/2]

getItems ( )

Method to get an array of data items.

Renvoie
mixed An array of data items on success, false on failure.
Depuis
12.2

Références $extension, et $items.

◆ getListQuery() [1/2]

getListQuery ( )
protected

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

Renvoie
string An SQL query
Depuis
1.6

Références $app, $db, $format, $groups, $language, $limit, $offset, $published, $query, et $user.

◆ getListQuery() [2/2]

getListQuery ( )
protected

Method to create a query for a list of items.

Renvoie
string
Depuis
3.1

Références $db, $groups, $language, $listDirn, $published, $query, $user, et elseif.

◆ getStoreId()

getStoreId (   $id = '')
protected

Method to get a store id based on model configuration state.

This is necessary because the model is used by the component and different modules that might need different sets of data or different ordering requirements.

Paramètres
string$idA prefix for the store id.
Renvoie
string A store id.
Depuis
3.1

Références $id.

◆ getTable()

getTable (   $type = 'Tag',
  $prefix = 'TagsTable',
  $config = array() 
)

Method to get a table object, load it if necessary.

Paramètres
string$typeThe table name. Optional.
string$prefixThe class prefix. Optional.
array$configConfiguration array for model. Optional.
Renvoie
JTable A JTable object
Depuis
3.1

Références $config, $prefix, et $type.

◆ populateState() [1/2]

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

Method to auto-populate the model state.

Paramètres
string$orderingAn optional ordering field.
string$directionAn optional direction (asc|desc).
Renvoie
void
Note
Calling getState in this method will result in recursion.
Depuis
3.1

Références $app, $itemid, $language, $offset, $params, et $user.

◆ populateState() [2/2]

populateState (   $ordering = 'a.lft',
  $direction = 'asc' 
)
protected

Method to auto-populate the model state.

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

Paramètres
string$orderingAn optional ordering field.
string$directionAn optional direction (asc|desc).
Renvoie
void
Depuis
3.1

Références $direction, $extension, $language, $ordering, $params, $parts, $published, et null.

Documentation des champs

◆ $_context

$_context = 'com_tags.tags'

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