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 TagsModelTag
+ Graphe d'héritage de TagsModelTag:

Fonctions membres publiques

 getTable ($type='Tag', $prefix='TagsTable', $config=array())
 
 getItem ($pk=null)
 
 getForm ($data=array(), $loadData=true)
 
 save ($data)
 
 rebuild ()
 
 saveorder ($idArray=null, $lft_array=null)
 
 __construct ($config=array())
 
 getItems ()
 
 getItem ($pk=null)
 
 hit ($pk=0)
 

Champs de données

 $typeAlias = 'com_tags.tag'
 

Fonctions membres protégées

 canDelete ($record)
 
 canEditState ($record)
 
 populateState ()
 
 loadFormData ()
 
 generateNewTitle ($parent_id, $alias, $title)
 
 getListQuery ()
 
 populateState ($ordering='c.core_title', $direction='ASC')
 

Attributs protégés

 $text_prefix = 'COM_TAGS'
 
 $batch_commands
 
 $tag = null
 
 $items = null
 

Description détaillée

Tags Component Tag Model

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.1

Références $config.

Documentation des fonctions membres

◆ canDelete()

canDelete (   $record)
protected

Method to test whether a record can be deleted.

Paramètres
object$recordA record object.
Renvoie
boolean True if allowed to delete the record. Defaults to the permission set in the component.
Depuis
3.1

◆ canEditState()

canEditState (   $record)
protected

Method to test whether a record can have its state changed.

Paramètres
object$recordA record object.
Renvoie
boolean True if allowed to change the state of the record. Defaults to the permission set in the component.
Depuis
3.1

◆ generateNewTitle()

generateNewTitle (   $parent_id,
  $alias,
  $title 
)
protected

Method to change the title & alias.

Paramètres
integer$parent_idThe id of the parent.
string$aliasThe alias.
string$titleThe title.
Renvoie
array Contains the modified title and alias.
Depuis
3.1

Références $parent_id, et $title.

◆ getForm()

getForm (   $data = array(),
  $loadData = true 
)

Method to get the row form.

Paramètres
array$dataData for the form.
boolean$loadDataTrue if the form is to load its own data (default case), false if not.
Renvoie
mixed A JForm object on success, false on failure
Depuis
3.1

Références $form, $jinput, et $user.

◆ getItem() [1/2]

getItem (   $pk = null)

Method to get a tag.

Paramètres
integer$pkAn optional id of the object to get, otherwise the id from the model state is used.
Renvoie
mixed Tag data object on success, false on failure.
Depuis
3.1

Références $date, et null.

◆ getItem() [2/2]

getItem (   $pk = null)

Method to get tag data for the current tag or tags

Paramètres
integer$pkAn optional ID
Renvoie
object
Depuis
3.1

Références $id, $item, $published, item, JError\raiseError(), et ArrayHelper\toObject().

◆ getItems()

getItems ( )

Method to get a list of items for a list of tags.

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

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

◆ getListQuery()

getListQuery ( )
protected

Method to build an SQL query to load the list data of all items with a given tag.

Renvoie
string An SQL query
Depuis
3.1

Références $language, et $query.

◆ 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.

◆ hit()

hit (   $pk = 0)

Increment the hit counter.

Paramètres
integer$pkOptional primary key of the article to increment.
Renvoie
boolean True if successful; false otherwise and internal error set.
Depuis
3.2

Références $input, et JError\raiseError().

◆ loadFormData()

loadFormData ( )
protected

Method to get the data that should be injected in the form.

Renvoie
mixed The data for the form.
Depuis
3.1

Références $data.

◆ populateState() [1/2]

populateState ( )
protected

Auto-populate the model state.

Note
Calling getState in this method will result in recursion.
Renvoie
void
Depuis
3.1

Références $app, et $params.

◆ populateState() [2/2]

populateState (   $ordering = 'c.core_title',
  $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 $app, $format, $itemid, $language, $limit, $listOrder, $offset, $params, et ArrayHelper\toInteger().

◆ rebuild()

rebuild ( )

Method rebuild the entire nested set tree.

Renvoie
boolean False on failure or error, true otherwise.
Depuis
3.1

◆ save()

save (   $data)

Method to save the form data.

Paramètres
array$dataThe form data.
Renvoie
boolean True on success.
Depuis
3.1

Références $context, $data, $dispatcher, $input, $name, $title, JEventDispatcher\getInstance(), et option.

◆ saveorder()

saveorder (   $idArray = null,
  $lft_array = null 
)

Method to save the reordered nested set tree. First we save the new order values in the lft values of the changed ids. Then we invoke the table rebuild to implement the new ordering.

Paramètres
array$idArrayAn array of primary key ids.
integer$lft_arrayThe lft value
Renvoie
boolean False on failure or error, True otherwise
Depuis
3.1

Documentation des champs

◆ $batch_commands

$batch_commands
protected
Valeur initiale :
= array(
'assetgroup_id' => 'batchAccess',
'language_id' => 'batchLanguage',
)

◆ $items

$items = null
protected

◆ $tag

$tag = null
protected

◆ $text_prefix

$text_prefix = 'COM_TAGS'
protected

◆ $typeAlias

$typeAlias = 'com_tags.tag'

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