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
Fonctions membres publiques | Fonctions membres protégées | Attributs protégés
Référence de la classe ModulesModelModule
+ Graphe d'héritage de ModulesModelModule:
+ Graphe de collaboration de ModulesModelModule:

Liste de tous les membres

Fonctions membres publiques

 batch ($commands, $pks, $contexts)
 delete (&$pks)
 duplicate (&$pks)
& getClient ()
 getForm ($data=array(), $loadData=true)
 getItem ($pk=null)
 getHelp ()
 getTable ($type= 'Module', $prefix= 'JTable', $config=array())
 validate ($form, $data, $group=null)
 save ($data)
- Fonctions membres publiques inherited from JModelAdmin
 __construct ($config=array())
 checkin ($pks=array())
 checkout ($pk=null)
 publish (&$pks, $value=1)
 reorder ($pks, $delta=0)
 saveorder ($pks=null, $order=null)

Fonctions membres protégées

 populateState ()
 batchCopy ($value, $pks, $contexts)
 batchMove ($value, $pks, $contexts)
 generateNewTitle ($category_id, $title, $position)
 loadFormData ()
 prepareTable (&$table)
 preprocessForm (JForm $form, $data, $group= 'content')
 getReorderConditions ($table)
 cleanCache ($group=null, $client_id=0)
- Fonctions membres protégées inherited from JModelAdmin
 batchAccess ($value, $pks, $contexts)
 batchLanguage ($value, $pks, $contexts)
 canDelete ($record)
 canEditState ($record)
- 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_MODULES'
 $helpKey = 'JHELP_EXTENSIONS_MODULE_MANAGER_EDIT'
 $helpURL
- 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

ModulesModelModule::batch (   $commands,
  $pks,
  $contexts 
)

Method to perform batch operations on a set of modules.

Paramètres:
array$commandsAn array of commands to perform.
array$pksAn array of item ids.
array$contextsAn array of item contexts.
Renvoie:
boolean Returns true on success, false on failure.
Depuis:
1.7

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

Références $cmd, JText\_(), elseif, JArrayHelper\getValue(), et JArrayHelper\toInteger().

+ Voici le graphe d'appel pour cette fonction :

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

Batch copy modules to a new position or current.

Paramètres:
integer$valueThe new value matching a module position.
array$pksAn array of row IDs.
array$contextsAn array of item contexts.
Renvoie:
boolean True if successful, false otherwise and internal error is set.
Depuis:
11.1

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

Références $data, $db, $i, $menu, $query, $user, JText\_(), elseif, et JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

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

Batch move modules to a new position or current.

Paramètres:
integer$valueThe new value matching a module position.
array$pksAn array of row IDs.
array$contextsAn array of item contexts.
Renvoie:
boolean True if successful, false otherwise and internal error is set.
Depuis:
11.1

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

Références $data, $i, $user, JText\_(), elseif, et JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

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

Custom clean cache method for different clients

Renvoie:
void
Depuis:
1.6

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

ModulesModelModule::delete ( &  $pks)

Method to delete rows.

Paramètres:
array&$pksAn array of item ids.
Renvoie:
boolean Returns true on success, false on failure.
Depuis:
1.6

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

Références $db, $i, $query, $user, JText\_(), JFactory\getUser(), et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :

ModulesModelModule::duplicate ( &  $pks)

Method to duplicate modules.

Paramètres:
array&$pksAn array of primary key IDs.
Renvoie:
boolean True if successful.
Depuis:
1.6
Exceptions:
Exception

Références $db, $query, $user, JText\_(), JFactory\getUser(), null, et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :

ModulesModelModule::generateNewTitle (   $category_id,
  $title,
  $position 
)
protected

Method to change the title.

Paramètres:
integer$category_idThe id of the category. Not used here.
string$titleThe title.
string$positionThe position.
Renvoie:
array Contains the modified title.
Depuis:
2.5

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

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

+ Voici le graphe d'appel pour cette fonction :

& ModulesModelModule::getClient ( )

Method to get the client object

Renvoie:
void
Depuis:
1.6
ModulesModelModule::getForm (   $data = array(),
  $loadData = true 
)

Method to get the record 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:
JForm A JForm object on success, false on failure
Depuis:
1.6

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

Références $clientId, $data, $item, et JArrayHelper\getValue().

+ Voici le graphe d'appel pour cette fonction :

ModulesModelModule::getHelp ( )

Get the necessary data to load an item help screen.

Renvoie:
object An object with key, url, and local properties for loading the item help screen.
Depuis:
1.6
ModulesModelModule::getItem (   $pk = null)

Method to get a single record.

Paramètres:
integer$pkThe id of the primary key.
Renvoie:
mixed Object on success, false on failure.
Depuis:
1.6

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

Références $app, $client, $db, $extension, $path, $query, $return, JRoute\_(), JPath\clean(), elseif, JFactory\getApplication(), JApplicationHelper\getClientInfo(), JRegistry\loadString(), null, et JArrayHelper\toObject().

+ Voici le graphe d'appel pour cette fonction :

ModulesModelModule::getReorderConditions (   $table)
protected

A protected method to get a set of ordering conditions.

Paramètres:
object$tableA record object.
Renvoie:
array An array of conditions to add to add to ordering queries.
Depuis:
1.6

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

ModulesModelModule::getTable (   $type = 'Module',
  $prefix = 'JTable',
  $config = array() 
)

Returns a reference to the a Table object, always creating it.

Paramètres:
string$typeThe table type to instantiate
string$prefixA prefix for the table class name. Optional.
array$configConfiguration array for model. Optional.
Renvoie:
JTable A database 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 :

ModulesModelModule::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 $app, $data, $params, et JFactory\getApplication().

+ Voici le graphe d'appel pour cette fonction :

ModulesModelModule::populateState ( )
protected

Method to 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, $params, JFactory\getApplication(), JRequest\getInt(), et JComponentHelper\getParams().

+ Voici le graphe d'appel pour cette fonction :

ModulesModelModule::prepareTable ( &  $table)
protected

Prepare and sanitise the table prior to saving.

Paramètres:
JTable&$tableThe database object
Renvoie:
void
Depuis:
1.6

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

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

+ Voici le graphe d'appel pour cette fonction :

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

Method to preprocess the form

Paramètres:
JForm$formA form object.
mixed$dataThe data expected for the form.
string$groupThe name of the plugin group to import (defaults to "content").
Renvoie:
void
Depuis:
1.6
Exceptions:
Exceptionif there is an error loading the form.

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

Références $client, $clientId, $data, $lang, JText\_(), JPath\clean(), JApplicationHelper\getClientInfo(), JFactory\getLanguage(), jimport(), JForm\loadFile(), et null.

+ Voici le graphe d'appel pour cette fonction :

ModulesModelModule::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, $db, $dispatcher, $query, elseif, JDispatcher\getInstance(), JRequest\getVar(), JPluginHelper\importPlugin(), et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :

ModulesModelModule::validate (   $form,
  $data,
  $group = null 
)

Loads ContentHelper for filters before validating data.

Paramètres:
object$formThe form to validate against.
array$dataThe data to validate.
Renvoie:
mixed Array of filtered data if valid, false otherwise.
Depuis:
1.1

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

Références $data, et JPATH_ADMINISTRATOR.

Documentation des données membres

ModulesModelModule::$helpKey = 'JHELP_EXTENSIONS_MODULE_MANAGER_EDIT'
protected
ModulesModelModule::$helpURL
protected
ModulesModelModule::$text_prefix = 'COM_MODULES'
protected

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

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