Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe CategoriesModelCategory
+ Graphe d'héritage de CategoriesModelCategory:
+ Graphe de collaboration de CategoriesModelCategory:

Liste de tous les membres

Fonctions membres publiques

 getTable ($type= 'Category', $prefix= 'CategoriesTable', $config=array())
 getItem ($pk=null)
 getForm ($data=array(), $loadData=true)
 save ($data)
 publish (&$pks, $value=1)
 rebuild ()
 saveorder ($idArray=null, $lft_array=null)
- Fonctions membres publiques inherited from JModelAdmin
 __construct ($config=array())
 batch ($commands, $pks, $contexts)
 checkin ($pks=array())
 checkout ($pk=null)
 delete (&$pks)
 reorder ($pks, $delta=0)
- Fonctions membres publiques inherited from JModelForm
 validate ($form, $data, $group=null)
- Fonctions membres publiques inherited from JModel
 getDbo ()
 getName ()
 getState ($property=null, $default=null)
 setDbo (&$db)
 setState ($property, $value=null)
- Fonctions membres publiques inherited from JObject
 __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)
 toString ()

Fonctions membres protégées

 canDelete ($record)
 canEditState ($record)
 populateState ()
 getReorderConditions ($table)
 loadFormData ()
 preprocessForm (JForm $form, $data, $group= 'content')
 batchCopy ($value, $pks, $contexts)
 batchMove ($value, $pks, $contexts)
 cleanCache ($group=null, $client_id=0)
 generateNewTitle ($parent_id, $alias, $title)
- Fonctions membres protégées inherited from JModelAdmin
 batchAccess ($value, $pks, $contexts)
 batchLanguage ($value, $pks, $contexts)
 prepareTable (&$table)
- Fonctions membres protégées inherited from JModelForm
 loadForm ($name, $source=null, $options=array(), $clear=false, $xpath=false)
- Fonctions membres protégées inherited from JModel
 _getList ($query, $limitstart=0, $limit=0)
 _getListCount ($query)
 _createTable ($name, $prefix= 'Table', $config=array())

Attributs protégés

 $text_prefix = 'COM_CATEGORIES'
- Attributs protégés inherited from JModelAdmin
 $event_after_delete = null
 $event_after_save = null
 $event_before_delete = null
 $event_before_save = null
 $event_change_state = null
- Attributs protégés inherited from JModelForm
 $_forms = array()
- Attributs protégés inherited from JModel
 $__state_set = null
 $_db
 $name
 $option = null
 $state
 $event_clean_cache = null
- Attributs protégés inherited from JObject
 $_errors = array()

Documentation des fonctions membres

CategoriesModelCategory::batchCopy (   $value,
  $pks,
  $contexts 
)
protected

Batch copy categories to a new category.

Paramètres:
integer$valueThe new category.
array$pksAn array of row IDs.
array$contextsAn array of item contexts.
Renvoie:
mixed An array of new IDs on success, boolean false on failure.
Depuis:
1.6

Réimplémentée à partir de JModelAdmin.

Références $canCreate, $count, $db, $extension, $i, $parts, $query, $title, $user, JText\_(), elseif, JFactory\getApplication(), JFactory\getUser(), JArrayHelper\getValue(), null, et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::batchMove (   $value,
  $pks,
  $contexts 
)
protected

Batch move categories to a new category.

Paramètres:
integer$valueThe new category ID.
array$pksAn array of row IDs.
array$contextsAn array of item contexts.
Renvoie:
boolean True on success.
Depuis:
1.6

Réimplémentée à partir de JModelAdmin.

Références $canCreate, $db, $extension, $query, $user, JText\_(), JFactory\getApplication(), JFactory\getUser(), JText\sprintf(), et JArrayHelper\toInteger().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::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:
1.6

Réimplémentée à partir de JModelAdmin.

Références $user, et JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::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:
1.6

Réimplémentée à partir de JModelAdmin.

Références $user, elseif, et JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::cleanCache (   $group = null,
  $client_id = 0 
)
protected

Custom clean the cache of com_content and content modules

Depuis:
1.6

Réimplémentée à partir de JModel.

Références $extension, et JRequest\getCmd().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::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:
1.7

Réimplémentée à partir de JModelAdmin.

Références $parent_id, $title, et JString\increment().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::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:
1.6

Réimplémentée à partir de JModelForm.

Références $data, $extension, $parts, $user, JFactory\getApplication(), et JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::getItem (   $pk = null)

Method to get a category.

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

Réimplémentée à partir de JModelAdmin.

Références $date, JFactory\getApplication(), jimport(), et null.

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::getReorderConditions (   $table)
protected

A protected method to get the where clause for the reorder This ensures that the row will be moved relative to a row with the same extension

Paramètres:
JCategoryTable$tableCurrent table instance
Renvoie:
array An array of conditions to add to add to ordering queries.
Depuis:
1.6

Réimplémentée à partir de JModelAdmin.

CategoriesModelCategory::getTable (   $type = 'Category',
  $prefix = 'CategoriesTable',
  $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:
1.6

Réimplémentée à partir de JModel.

Références $config, $type, et JTable\getInstance().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::loadFormData ( )
protected

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

Renvoie:
mixed The data for the form.
Depuis:
1.6

Réimplémentée à partir de JModelForm.

Références $data, et JFactory\getApplication().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::populateState ( )
protected

Auto-populate the model state.

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

Renvoie:
void
Depuis:
1.6

Réimplémentée à partir de JModelAdmin.

Références $app, $extension, $params, $parts, JFactory\getApplication(), JRequest\getCmd(), JRequest\getInt(), JComponentHelper\getParams(), et null.

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::preprocessForm ( JForm  $form,
  $data,
  $group = 'content' 
)
protected

Method to preprocess the form.

Paramètres:
JForm$formA JForm object.
mixed$dataThe data expected for the form.
string$groupsThe name of the plugin group to import.
Renvoie:
void
Voir également:
JFormField
Depuis:
1.6
Exceptions:
Exceptionif there is an error in the form event.

Réimplémentée à partir de JModelForm.

Références $data, $extension, $lang, $name, $path, JText\_(), JPath\clean(), JFactory\getLanguage(), jimport(), JPATH_ADMINISTRATOR, JPATH_BASE, JForm\loadFile(), null, et JForm\setFieldAttribute().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::publish ( $pks,
  $value = 1 
)

Method to change the published state of one or more records.

Paramètres:
array$pksA list of the primary keys to change.
integer$valueThe value of the published state.
Renvoie:
boolean True on success.
Depuis:
2.5

Réimplémentée à partir de JModelAdmin.

Références $dispatcher, $extension, JRequest\getCmd(), JDispatcher\getInstance(), et JPluginHelper\importPlugin().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::rebuild ( )

Method rebuild the entire nested set tree.

Renvoie:
boolean False on failure or error, true otherwise.
Depuis:
1.6
CategoriesModelCategory::save (   $data)

Method to save the form data.

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

Réimplémentée à partir de JModelAdmin.

Références $data, $dispatcher, $title, JDispatcher\getInstance(), JRequest\getVar(), et JPluginHelper\importPlugin().

+ Voici le graphe d'appel pour cette fonction :

CategoriesModelCategory::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:
1.6

Réimplémentée à partir de JModelAdmin.


Documentation des données membres

CategoriesModelCategory::$text_prefix = 'COM_CATEGORIES'
protected

Réimplémentée à partir de JModelAdmin.


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