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

Liste de tous les membres

Fonctions membres publiques

 checkin ($userId=null)
 checkout ($userId=null)
 getData ()
 getForm ($data=array(), $loadData=true)
 save ($data)
- Fonctions membres publiques inherited from JModelForm
 validate ($form, $data, $group=null)
- Fonctions membres publiques inherited from JModel
 __construct ($config=array())
 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

 loadFormData ()
 preprocessForm (JForm $form, $data, $group= 'user')
 populateState ()
- 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())
 cleanCache ($group=null, $client_id=0)

Attributs protégés

 $data
- 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

UsersModelProfile::checkin (   $userId = null)

Method to check in a user.

Paramètres:
integerThe id of the row to check out.
Renvoie:
boolean True on success, false on failure.
Depuis:
1.6

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

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

+ Voici le graphe d'appel pour cette fonction :

UsersModelProfile::checkout (   $userId = null)

Method to check out a user for editing.

Paramètres:
integerThe id of the row to check out.
Renvoie:
boolean True on success, false on failure.
Depuis:
1.6

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

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

+ Voici le graphe d'appel pour cette fonction :

UsersModelProfile::getData ( )

Method to get the profile form data.

The base form data is loaded and then an event is fired for users plugins to extend the data.

Renvoie:
mixed Data object on success, false on failure.
Depuis:
1.6

Références $data, $dispatcher, $userId, JFactory\getApplication(), JDispatcher\getInstance(), JPluginHelper\importPlugin(), et null.

+ Voici le graphe d'appel pour cette fonction :

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

Method to get the profile form.

The base form is loaded from XML and then an event is fired for users plugins to extend the form with extra fields.

Paramètres:
array$dataAn optional array of data for the form to interogate.
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 JComponentHelper\getParams().

+ Voici le graphe d'appel pour cette fonction :

UsersModelProfile::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.

UsersModelProfile::populateState ( )
protected

Method to auto-populate the model state.

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

Depuis:
1.6

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

Références $params, $userId, JFactory\getApplication(), et JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

UsersModelProfile::preprocessForm ( JForm  $form,
  $data,
  $group = 'user' 
)
protected

Override preprocessForm to load the user plugin group instead of content.

Paramètres:
objectA form object.
mixedThe data expected for the form.
Exceptions:
Exceptionif there is an error in the form event.
Depuis:
1.6

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

Références $data, JComponentHelper\getParams(), JFactory\getUser(), et JForm\loadFile().

+ Voici le graphe d'appel pour cette fonction :

UsersModelProfile::save (   $data)

Method to save the form data.

Paramètres:
arrayThe form data.
Renvoie:
mixed The user id on success, false on failure.
Depuis:
1.6

Références $data, $user, $userId, JComponentHelper\getParams(), JPluginHelper\importPlugin(), null, et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :


Documentation des données membres

UsersModelProfile::$data
protected

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