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

Liste de tous les membres

Fonctions membres publiques

 __construct ($config=array())
 batch ($commands, $pks, $contexts)
 checkin ($pks=array())
 checkout ($pk=null)
 delete (&$pks)
 getItem ($pk=null)
 publish (&$pks, $value=1)
 reorder ($pks, $delta=0)
 save ($data)
 saveorder ($pks=null, $order=null)
- Fonctions membres publiques inherited from JModelForm
 getForm ($data=array(), $loadData=true)
 validate ($form, $data, $group=null)
- Fonctions membres publiques inherited from JModel
 getDbo ()
 getName ()
 getState ($property=null, $default=null)
 getTable ($name= '', $prefix= 'Table', $options=array())
 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

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

Attributs protégés

 $text_prefix = null
 $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 constructeurs et destructeur

JModelAdmin::__construct (   $config = array())

Constructor.

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

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

Références $config, et elseif.


Documentation des fonctions membres

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

Method to perform batch operations on an item or a set of items.

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:
11.1

Réimplémentée dans UsersModelUser, MenusModelItem, ModulesModelModule, BannersModelBanner, et ContactModelContact.

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

+ Voici le graphe d'appel pour cette fonction :

JModelAdmin::batchAccess (   $value,
  $pks,
  $contexts 
)
protected

Batch access level changes for a group of rows.

Paramètres:
integer$valueThe new value matching an Asset Group ID.
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éférences $user, JText\_(), et JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

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

Batch copy items to a new category or current.

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:
11.1

Réimplémentée dans CategoriesModelCategory, MenusModelItem, BannersModelBanner, ModulesModelModule, ContactModelContact, ContentModelArticle, et NewsfeedsModelNewsfeed.

Références $data, $extension, $i, $user, JText\_(), JFactory\getApplication(), JTable\getInstance(), JFactory\getUser(), et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

JModelAdmin::batchLanguage (   $value,
  $pks,
  $contexts 
)
protected

Batch language changes for a group of rows.

Paramètres:
string$valueThe new value matching a language.
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.3

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

+ Voici le graphe d'appel pour cette fonction :

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

Batch move items 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 if successful, false otherwise and internal error is set.
Depuis:
11.1

Réimplémentée dans CategoriesModelCategory, MenusModelItem, et ModulesModelModule.

Références $extension, $user, JText\_(), JFactory\getApplication(), JTable\getInstance(), JFactory\getUser(), et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

JModelAdmin::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 for the component.
Depuis:
11.1

Réimplémentée dans ContactModelContact, BannersModelBanner, ContentModelArticle, NewsfeedsModelNewsfeed, MenusModelItem, CategoriesModelCategory, RedirectModelLink, UsersModelLevel, WeblinksModelWeblink, et BannersModelClient.

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

+ Voici le graphe d'appel pour cette fonction :

JModelAdmin::canEditState (   $record)
protected

Method to test whether a record can be deleted.

Paramètres:
object$recordA record object.
Renvoie:
boolean True if allowed to change the state of the record. Defaults to the permission for the component.
Depuis:
11.1

Réimplémentée dans BannersModelBanner, ContactModelContact, ContentModelArticle, NewsfeedsModelNewsfeed, MenusModelItem, CategoriesModelCategory, WeblinksModelWeblink, RedirectModelLink, et BannersModelClient.

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

+ Voici le graphe d'appel pour cette fonction :

JModelAdmin::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:
11.1

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

Références $count.

JModelAdmin::checkout (   $pk = null)

Method override to check-out a record.

Paramètres:
integer$pkThe ID of the primary key.
Renvoie:
boolean True if successful, false if an error occurs.
Depuis:
11.1

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

JModelAdmin::delete ( $pks)

Method to delete one or more records.

Paramètres:
array&$pksAn array of record primary keys.
Renvoie:
boolean True if successful, false if an error occurs.
Depuis:
11.1

Réimplémentée dans ModulesModelModule, UsersModelUser, UsersModelGroup, TemplatesModelStyle, et MessagesModelMessage.

Références $dispatcher, $i, $name, JText\_(), JDispatcher\getInstance(), JPluginHelper\importPlugin(), et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :

JModelAdmin::generateNewTitle (   $category_id,
  $alias,
  $title 
)
protected

Method to change the title & alias.

Paramètres:
integer$category_idThe id of the category.
string$aliasThe alias.
string$titleThe title.
Renvoie:
array Contains the modified title and alias.
Depuis:
11.1

Réimplémentée dans MenusModelItem, CategoriesModelCategory, ModulesModelModule, et TemplatesModelStyle.

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

+ Voici le graphe d'appel pour cette fonction :

JModelAdmin::getItem (   $pk = null)
JModelAdmin::getReorderConditions (   $table)
protected

A protected method to get a set of ordering conditions.

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

Réimplémentée dans ModulesModelModule, MenusModelItem, ContentModelArticle, BannersModelBanner, ContactModelContact, NewsfeedsModelNewsfeed, PluginsModelPlugin, CategoriesModelCategory, WeblinksModelWeblink, et ContentModelFeature.

JModelAdmin::populateState ( )
protected

Stock method to auto-populate the model state.

Renvoie:
void
Depuis:
11.1

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

Réimplémentée dans MenusModelItem, LanguagesModelOverride, PluginsModelPlugin, UsersModelNote, CategoriesModelCategory, ModulesModelModule, TemplatesModelStyle, ContactModelContact, WeblinksModelForm, LanguagesModelLanguage, ContentModelArticle, NewsfeedsModelNewsfeed, WeblinksModelWeblink, MessagesModelMessage, et ContentModelForm.

Références $key, JRequest\getInt(), et JComponentHelper\getParams().

+ Voici le graphe d'appel pour cette fonction :

JModelAdmin::prepareTable ( $table)
protected

Prepare and sanitise the table data prior to saving.

Paramètres:
JTable&$tableA reference to a JTable object.
Renvoie:
void
Depuis:
11.1

Réimplémentée dans ModulesModelModule, ContactModelContact, NewsfeedsModelNewsfeed, ContentModelArticle, WeblinksModelWeblink, et BannersModelClient.

JModelAdmin::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:
11.1

Réimplémentée dans MenusModelItem, CategoriesModelCategory, NewsfeedsModelNewsfeed, et MessagesModelMessage.

Références $dispatcher, $i, $name, $user, JText\_(), JDispatcher\getInstance(), JFactory\getUser(), JPluginHelper\importPlugin(), et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :

JModelAdmin::reorder (   $pks,
  $delta = 0 
)

Method to adjust the ordering of a row.

Returns NULL if the user did not have edit privileges for any of the selected primary keys.

Paramètres:
integer$pksThe ID of the primary key to move.
integer$deltaIncrement, usually +1 or -1
Renvoie:
mixed False on failure or error, true on success, null if the $pk is empty (no items selected).
Depuis:
11.1

Références $i, JText\_(), null, et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :

JModelAdmin::save (   $data)

Method to save the form data.

Paramètres:
array$dataThe form data.
Renvoie:
boolean True on success, False on error.
Depuis:
11.1

Réimplémentée dans MenusModelItem, ModulesModelModule, ContentModelArticle, TemplatesModelStyle, CategoriesModelCategory, PluginsModelPlugin, MessagesModelMessage, UsersModelLevel, UsersModelUser, LanguagesModelLanguage, AdminModelProfile, et UsersModelGroup.

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

+ Voici le graphe d'appel pour cette fonction :

JModelAdmin::saveorder (   $pks = null,
  $order = null 
)

Saves the manually set order of records.

Paramètres:
array$pksAn array of primary key ids.
integer$order+1 or -1
Renvoie:
mixed
Depuis:
11.1

Réimplémentée dans MenusModelItem, et CategoriesModelCategory.

Références $i, $key, JText\_(), elseif, et JError\raiseWarning().

+ Voici le graphe d'appel pour cette fonction :


Documentation des données membres

JModelAdmin::$event_after_delete = null
protected
JModelAdmin::$event_after_save = null
protected

Réimplémentée dans PluginsModelPlugin, et UsersModelGroup.

JModelAdmin::$event_before_delete = null
protected
JModelAdmin::$event_before_save = null
protected

Réimplémentée dans PluginsModelPlugin, et UsersModelGroup.

JModelAdmin::$event_change_state = null
protected

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