Référence de la classe JTableUser

Graphe d'héritage de JTableUser:

Graphe de collaboration de JTableUser:

Liste de tous les membres

Fonctions membres publiques
	__construct (JDatabaseDriver $db)
	load ($userId=null, $reset=true)
	bind ($array, $ignore= '')
	check ()
	store ($updateNulls=false)
	delete ($userId=null)
	setLastVisit ($timeStamp=null, $userId=null)
Fonctions membres publiques inherited from JTable
	__construct ($table, $key, JDatabaseDriver $db)
	attachObserver (JObserverInterface $observer)
	getObserverOfClass ($observerClass)
	getFields ()
	appendPrimaryKeys ($query, $pk=null)
	getTableName ()
	getKeyName ($multiple=false)
	getDbo ()
	setDBO (JDatabaseDriver $db)
	setRules ($input)
	getRules ()
	reset ()
	save ($src, $orderingFilter= '', $ignore= '')
	checkOut ($userId, $pk=null)
	checkIn ($pk=null)
	hasPrimaryKey ()
	hit ($pk=null)
	isCheckedOut ($with=0, $against=null)
	getNextOrder ($where= '')
	getPrimaryKey (array $keys=array())
	reorder ($where= '')
	move ($delta, $where= '')
	publish ($pks=null, $state=1, $userId=0)
Fonctions membres publiques inherited from JObject
	__construct ($properties=null)
	__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)

Attributs publics
	$groups

Additional Inherited Members
Fonctions membres publiques statiques inherited from JTable
static	getInstance ($type, $prefix= 'JTable', $config=array())
static	addIncludePath ($path=null)
Fonctions membres protégées inherited from JTable
	_getAssetName ()
	_getAssetTitle ()
	_getAssetParentId (JTable $table=null, $id=null)
	_lock ()
	_unlock ()
Attributs protégés inherited from JTable
	$_tbl = ''
	$_tbl_key = ''
	$_tbl_keys = array()
	$_db
	$_trackAssets = false
	$_rules
	$_locked = false
	$_autoincrement = true
	$_observers
Attributs protégés inherited from JObject
	$_errors = array()

---

Description détaillée

Définition à la ligne 19 du fichier user.php.

---

Documentation des constructeurs et destructeur

JTableUser::__construct

(

JDatabaseDriver

$db

)

Constructor

Paramètres:

JDatabaseDriver

$db

Database driver object.

Depuis:

11.1

Définition à la ligne 36 du fichier user.php.

        {
                parent::__construct('#__users', 'id', $db);

                // Initialise.
                $this->id = 0;
                $this->sendEmail = 0;
        }

---

Documentation des fonctions membres

JTableUser::bind	(		$array,
			$ignore = ''
	)

Method to bind the user, user groups, and any other necessary data.

Paramètres:

array	$array	The data to bind.
mixed	$ignore	An array or space separated list of fields to ignore.

Renvoie:

boolean True on success, false on failure.

Depuis:

11.1

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

Définition à la ligne 125 du fichier user.php.

Références JRegistry\loadArray(), et JArrayHelper\toInteger().

        {
                if (array_key_exists('params', $array) && is_array($array['params']))
                {
                        $registry = new JRegistry;
                        $registry->loadArray($array['params']);
                        $array['params'] = (string) $registry;
                }

                // Attempt to bind the data.
                $return = parent::bind($array, $ignore);

                // Load the real group data based on the bound ids.
                if ($return && !empty($this->groups))
                {
                        // Set the group ids.
                        JArrayHelper::toInteger($this->groups);

                        // Get the titles for the user groups.
                        $query = $this->_db->getQuery(true)
                                ->select($this->_db->quoteName('id'))
                                ->select($this->_db->quoteName('title'))
                                ->from($this->_db->quoteName('#__usergroups'))
                                ->where($this->_db->quoteName('id') . ' = ' . implode(' OR ' . $this->_db->quoteName('id') . ' = ', $this->groups));
                        $this->_db->setQuery($query);

                        // Set the titles for the user groups.
                        $this->groups = $this->_db->loadAssocList('id', 'id');

                }

                return $return;
        }

Voici le graphe d'appel pour cette fonction :

JTableUser::check

(

)

Validation and filtering

Renvoie:

boolean True if satisfactory

Depuis:

11.1

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

Définition à la ligne 166 du fichier user.php.

Références JText\_(), JStringPunycode\emailToPunycode(), JFactory\getConfig(), JFactory\getDate(), JMailHelper\isEmailAddress(), et JText\sprintf().

        {
                // Set user id to null istead of 0, if needed
                if ($this->id === 0)
                {
                        $this->id = null;
                }

                // Validate user information
                if (trim($this->name) == '')
                {
                        $this->setError(JText::_('JLIB_DATABASE_ERROR_PLEASE_ENTER_YOUR_NAME'));

                        return false;
                }

                if (trim($this->username) == '')
                {
                        $this->setError(JText::_('JLIB_DATABASE_ERROR_PLEASE_ENTER_A_USER_NAME'));

                        return false;
                }

                if (preg_match('#[<>"\'%;()&\\s\\\\]|\\.\\./#', $this->username) || strlen(utf8_decode($this->username)) < 2)
                {
                        $this->setError(JText::sprintf('JLIB_DATABASE_ERROR_VALID_AZ09', 2));

                        return false;
                }

                if ((trim($this->email) == "") || !JMailHelper::isEmailAddress($this->email))
                {
                        $this->setError(JText::_('JLIB_DATABASE_ERROR_VALID_MAIL'));

                        return false;
                }

                // Convert e-mail to punycode for storage
                $this->email = JStringPunycode::emailToPunycode($this->email);

                // Set the registration timestamp
                if (empty($this->registerDate) || $this->registerDate == $this->_db->getNullDate())
                {
                        $this->registerDate = JFactory::getDate()->toSql();
                }

                // Set the lastvisitDate timestamp
                if (empty($this->lastvisitDate))
                {
                        $this->lastvisitDate = $this->_db->getNullDate();
                }

                // Check for existing username
                $query = $this->_db->getQuery(true)
                        ->select($this->_db->quoteName('id'))
                        ->from($this->_db->quoteName('#__users'))
                        ->where($this->_db->quoteName('username') . ' = ' . $this->_db->quote($this->username))
                        ->where($this->_db->quoteName('id') . ' != ' . (int) $this->id);
                $this->_db->setQuery($query);

                $xid = (int) $this->_db->loadResult();

                if ($xid && $xid != (int) $this->id)
                {
                        $this->setError(JText::_('JLIB_DATABASE_ERROR_USERNAME_INUSE'));

                        return false;
                }

                // Check for existing email
                $query->clear()
                        ->select($this->_db->quoteName('id'))
                        ->from($this->_db->quoteName('#__users'))
                        ->where($this->_db->quoteName('email') . ' = ' . $this->_db->quote($this->email))
                        ->where($this->_db->quoteName('id') . ' != ' . (int) $this->id);
                $this->_db->setQuery($query);
                $xid = (int) $this->_db->loadResult();

                if ($xid && $xid != (int) $this->id)
                {
                        $this->setError(JText::_('JLIB_DATABASE_ERROR_EMAIL_INUSE'));

                        return false;
                }

                // Check for root_user != username
                $config = JFactory::getConfig();
                $rootUser = $config->get('root_user');

                if (!is_numeric($rootUser))
                {
                        $query->clear()
                                ->select($this->_db->quoteName('id'))
                                ->from($this->_db->quoteName('#__users'))
                                ->where($this->_db->quoteName('username') . ' = ' . $this->_db->quote($rootUser));
                        $this->_db->setQuery($query);
                        $xid = (int) $this->_db->loadResult();

                        if ($rootUser == $this->username && (!$xid || $xid && $xid != (int) $this->id)
                                || $xid && $xid == (int) $this->id && $rootUser != $this->username)
                        {
                                $this->setError(JText::_('JLIB_DATABASE_ERROR_USERNAME_CANNOT_CHANGE'));

                                return false;
                        }
                }

                return true;
        }

Voici le graphe d'appel pour cette fonction :

JTableUser::delete

(

$userId = null

)

Method to delete a user, user groups, and any other necessary data from the database.

Paramètres:

integer

$userId

An optional user id.

Renvoie:

boolean True on success, false on failure.

Depuis:

11.1

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

Définition à la ligne 364 du fichier user.php.

        {
                // Set the primary key to delete.
                $k = $this->_tbl_key;

                if ($userId)
                {
                        $this->$k = (int) $userId;
                }

                // Delete the user.
                $query = $this->_db->getQuery(true)
                        ->delete($this->_db->quoteName($this->_tbl))
                        ->where($this->_db->quoteName($this->_tbl_key) . ' = ' . (int) $this->$k);
                $this->_db->setQuery($query);
                $this->_db->execute();

                // Delete the user group maps.
                $query->clear()
                        ->delete($this->_db->quoteName('#__user_usergroup_map'))
                        ->where($this->_db->quoteName('user_id') . ' = ' . (int) $this->$k);
                $this->_db->setQuery($query);
                $this->_db->execute();

                /*
                 * Clean Up Related Data.
                 */

                $query->clear()
                        ->delete($this->_db->quoteName('#__messages_cfg'))
                        ->where($this->_db->quoteName('user_id') . ' = ' . (int) $this->$k);
                $this->_db->setQuery($query);
                $this->_db->execute();

                $query->clear()
                        ->delete($this->_db->quoteName('#__messages'))
                        ->where($this->_db->quoteName('user_id_to') . ' = ' . (int) $this->$k);
                $this->_db->setQuery($query);
                $this->_db->execute();

                $query->clear()
                        ->delete($this->_db->quoteName('#__user_keys'))
                        ->where($this->_db->quoteName('user_id') . ' = ' . $this->_db->quote($this->username));
                $this->_db->setQuery($query);
                $this->_db->execute();

                return true;
        }

JTableUser::load	(		$userId = null,
			$reset = true
	)

Method to load a user, user groups, and any other necessary data from the database so that it can be bound to the user object.

Paramètres:

integer	$userId	An optional user id.
boolean	$reset	False if row not found or on error (internal error state set in that case).

Renvoie:

boolean True on success, false on failure.

Depuis:

11.1

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

Définition à la ligne 57 du fichier user.php.

Références JStringPunycode\emailToUTF8().

        {
                // Get the id to load.
                if ($userId !== null)
                {
                        $this->id = $userId;
                }
                else
                {
                        $userId = $this->id;
                }

                // Check for a valid id to load.
                if ($userId === null)
                {
                        return false;
                }

                // Reset the table.
                $this->reset();

                // Load the user data.
                $query = $this->_db->getQuery(true)
                        ->select('*')
                        ->from($this->_db->quoteName('#__users'))
                        ->where($this->_db->quoteName('id') . ' = ' . (int) $userId);
                $this->_db->setQuery($query);
                $data = (array) $this->_db->loadAssoc();

                if (!count($data))
                {
                        return false;
                }

                // Convert e-mail from punycode
                $data['email'] = JStringPunycode::emailToUTF8($data['email']);

                // Bind the data to the table.
                $return = $this->bind($data);

                if ($return !== false)
                {
                        // Load the user groups.
                        $query->clear()
                                ->select($this->_db->quoteName('g.id'))
                                ->select($this->_db->quoteName('g.title'))
                                ->from($this->_db->quoteName('#__usergroups') . ' AS g')
                                ->join('INNER', $this->_db->quoteName('#__user_usergroup_map') . ' AS m ON m.group_id = g.id')
                                ->where($this->_db->quoteName('m.user_id') . ' = ' . (int) $userId);
                        $this->_db->setQuery($query);

                        // Add the groups to the user data.
                        $this->groups = $this->_db->loadAssocList('id', 'id');
                }

                return $return;
        }

Voici le graphe d'appel pour cette fonction :

JTableUser::setLastVisit	(		$timeStamp = null,
			$userId = null
	)

Updates last visit time of user

Paramètres:

integer	$timeStamp	The timestamp, defaults to 'now'.
integer	$userId	The user id (optional).

Renvoie:

boolean False if an error occurs

Depuis:

11.1

Définition à la ligne 423 du fichier user.php.

Références JFactory\getDate(), et jexit().

        {
                // Check for User ID
                if (is_null($userId))
                {
                        if (isset($this))
                        {
                                $userId = $this->id;
                        }
                        else
                        {
                                jexit('No userid in setLastVisit');
                        }
                }

                // If no timestamp value is passed to function, than current time is used.
                $date = JFactory::getDate($timeStamp);

                // Update the database row for the user.
                $db = $this->_db;
                $query = $db->getQuery(true)
                        ->update($db->quoteName($this->_tbl))
                        ->set($db->quoteName('lastvisitDate') . '=' . $db->quote($date->toSql()))
                        ->where($db->quoteName('id') . '=' . (int) $userId);
                $db->setQuery($query);
                $db->execute();

                return true;
        }

Voici le graphe d'appel pour cette fonction :

JTableUser::store

(

$updateNulls = false

)

Method to store a row in the database from the JTable instance properties. If a primary key value is set the row with that primary key value will be updated with the instance property values. If no primary key value is set a new row will be inserted into the database with the properties from the JTable instance.

Paramètres:

boolean

$updateNulls

True to update fields even if they are null.

Renvoie:

boolean True on success.

11.1

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

Définition à la ligne 290 du fichier user.php.

        {
                // Get the table key and key value.
                $k = $this->_tbl_key;
                $key = $this->$k;

                // TODO: This is a dumb way to handle the groups.
                // Store groups locally so as to not update directly.
                $groups = $this->groups;
                unset($this->groups);

                // Insert or update the object based on presence of a key value.
                if ($key)
                {
                        // Already have a table key, update the row.
                        $this->_db->updateObject($this->_tbl, $this, $this->_tbl_key, $updateNulls);
                }
                else
                {
                        // Don't have a table key, insert the row.
                        $this->_db->insertObject($this->_tbl, $this, $this->_tbl_key);
                }

                // Reset groups to the local object.
                $this->groups = $groups;
                unset($groups);

                // Store the group data if the user data was saved.
                if (is_array($this->groups) && count($this->groups))
                {
                        // Delete the old user group maps.
                        $query = $this->_db->getQuery(true)
                                ->delete($this->_db->quoteName('#__user_usergroup_map'))
                                ->where($this->_db->quoteName('user_id') . ' = ' . (int) $this->id);
                        $this->_db->setQuery($query);
                        $this->_db->execute();

                        // Set the new user group maps.
                        $query->clear()
                                ->insert($this->_db->quoteName('#__user_usergroup_map'))
                                ->columns(array($this->_db->quoteName('user_id'), $this->_db->quoteName('group_id')));

                        // Have to break this up into individual queries for cross-database support.
                        foreach ($this->groups as $group)
                        {
                                $query->clear('values')
                                        ->values($this->id . ', ' . $group);
                                $this->_db->setQuery($query);
                                $this->_db->execute();
                        }
                }

                // If a user is blocked, delete the cookie login rows
                if ($this->block == (int) 1)
                {
                        $query->clear()
                                ->delete($this->_db->quoteName('#__user_keys'))
                                ->where($this->_db->quoteName('user_id') . ' = ' . $this->_db->quote($this->username));
                        $this->_db->setQuery($query);
                        $this->_db->execute();
                }

                return true;
        }

---

Documentation des données membres

JTableUser::$groups

Définition à la ligne 27 du fichier user.php.

---

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

• jplatform-13.1/joomla/table/user.php