Référence de la classe UsersModelUser

Graphe d'héritage de UsersModelUser:

Graphe de collaboration de UsersModelUser:

Liste de tous les membres

Fonctions membres publiques
	getTable ($type= 'User', $prefix= 'JTable', $config=array())
	getItem ($pk=null)
	getForm ($data=array(), $loadData=true)
	save ($data)
	delete (&$pks)
	block (&$pks, $value=1)
	activate (&$pks)
	batch ($commands, $pks, $contexts)
	batchUser ($group_id, $user_ids, $action)
	getGroups ()
	getAssignedGroups ($userId=null)
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 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
	loadFormData ()
	preprocessForm (JForm $form, $data, $group= 'user')
Fonctions membres protégées inherited from JModelAdmin
	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)
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)

Additional Inherited Members
Attributs protégés inherited from JModelAdmin
	$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 fonctions membres

UsersModelUser::activate

(

&

$pks

)

Method to activate user records.

Paramètres:

array

&$pks

The ids of the items to activate.

Renvoie:

boolean True on success.

Depuis:

1.6

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

Voici le graphe d'appel pour cette fonction :

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

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

Paramètres:

array	$commands	An array of commands to perform.
array	$pks	An array of item ids.
array	$contexts	An array of item contexts.

Renvoie:

boolean Returns true on success, false on failure.

Depuis:

2.5

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

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

Voici le graphe d'appel pour cette fonction :

UsersModelUser::batchUser	(		$group_id,
			$user_ids,
			$action
	)

Perform batch operations

Paramètres:

integer	$group_id	The group ID which assignments are being edited
array	$user_ids	An array of user IDs on which to operate
string	$action	The action to perform

Renvoie:

boolean True on success, false on failure

Depuis:

1.6

Références $db, $id, $query, $users, JText\_(), JAccess\checkGroup(), JFactory\getUser(), et JArrayHelper\toInteger().

Voici le graphe d'appel pour cette fonction :

UsersModelUser::block	(	&	$pks,
			$value = 1
	)

Method to block user records.

Paramètres:

array	&$pks	The ids of the items to publish.
integer	$value	The value of the published state

Renvoie:

boolean True on success.

Depuis:

1.6

Références $app, $dispatcher, $i, $options, $user, JText\_(), JAccess\check(), elseif, JFactory\getApplication(), JDispatcher\getInstance(), JFactory\getUser(), JPluginHelper\importPlugin(), null, et JError\raiseWarning().

Voici le graphe d'appel pour cette fonction :

UsersModelUser::delete

(

&

$pks

)

Method to delete rows.

Paramètres:

array

&$pks

An 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 $dispatcher, $i, $user, JText\_(), JAccess\check(), JDispatcher\getInstance(), JFactory\getUser(), JPluginHelper\importPlugin(), et JError\raiseWarning().

Voici le graphe d'appel pour cette fonction :

UsersModelUser::getAssignedGroups

(

$userId = null

)

Gets the groups this object is assigned to

Paramètres:

integer

$userId

The user ID to retrieve the groups for

Renvoie:

array An array of assigned groups

Depuis:

1.6

Références $config, $userId, JComponentHelper\getParams(), et JUserHelper\getUserGroups().

Voici le graphe d'appel pour cette fonction :

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

Method to get the record form.

Paramètres:

array	$data	An optional array of data for the form to interogate.
boolean	$loadData	True 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éimplémentée dans AdminModelProfile.

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

Voici le graphe d'appel pour cette fonction :

UsersModelUser::getGroups

(

)

Gets the available groups.

Renvoie:

array An array of groups

Depuis:

1.6

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

Voici le graphe d'appel pour cette fonction :

UsersModelUser::getItem

(

$pk = null

)

Method to get a single record.

Paramètres:

integer

$pk

The id of the primary key.

Renvoie:

mixed Object on success, false on failure.

Depuis:

1.6

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

Réimplémentée dans AdminModelProfile.

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

Voici le graphe d'appel pour cette fonction :

UsersModelUser::getTable	(		$type = 'User',
			$prefix = 'JTable',
			$config = array()
	)

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

Paramètres:

string	$type	The table type to instantiate
string	$prefix	A prefix for the table class name. Optional.
array	$config	Configuration 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 :

UsersModelUser::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éimplémentée dans AdminModelProfile.

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

Voici le graphe d'appel pour cette fonction :

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

protected

Override JModelAdmin::preprocessForm to ensure the correct plugin group is loaded.

Paramètres:

JForm	$form	A JForm object.
mixed	$data	The data expected for the form.
string	$group	The name of the plugin group to import (defaults to "content").

Renvoie:

void

Depuis:

1.6

Exceptions:

Exception

if there is an error in the form event.

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

Références $data.

UsersModelUser::save

(

$data

)

Method to save the form data.

Paramètres:

array

$data

The form data.

Renvoie:

boolean True on success.

Depuis:

1.6

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

Réimplémentée dans AdminModelProfile.

Références $data, $user, JText\_(), JAccess\checkGroup(), JUser\getInstance(), et JFactory\getUser().

Voici le graphe d'appel pour cette fonction :

---

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

• administrator/components/com_users/models/user.php