Référence de la classe User

Graphe d'héritage de User:

Fonctions membres publiques
	__construct (DatabaseDriver $db)
	load ($userId=null, $reset=true)
	bind ($array, $ignore='')
	check ()
	store ($updateNulls=true)
	delete ($userId=null)
	setLastVisit ($timeStamp=null, $userId=null)
Fonctions membres publiques hérités de Table
	__construct ($table, $key, DatabaseDriver $db, DispatcherInterface $dispatcher=null)
	getFields ($reload=false)
	appendPrimaryKeys ($query, $pk=null)
	getTableName ()
	getKeyName ($multiple=false)
	getId ()
	getDbo ()
	setDbo (DatabaseDriver $db)
	setRules ($input)
	getRules ()
	reset ()
	bind ($src, $ignore=array())
	load ($keys=null, $reset=true)
	check ()
	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)
	getColumnAlias ($column)
	setColumnAlias ($column, $columnAlias)
	hasField ($key)
Fonctions membres publiques hérités de CMSObject
	__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)
Fonctions membres publiques hérités de TableInterface
	getKeyName ()
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

Champs de données
	$groups
Champs de données hérités de Table
	$typeAlias = null

Attributs protégés
	$_supportNullValue = true
Attributs protégés hérités de Table
	$_tbl = ''
	$_tbl_key = ''
	$_tbl_keys = array()
	$_db
	$_trackAssets = false
	$_rules
	$_locked = false
	$_autoincrement = true
	$_columnAlias = array()
	$_jsonEncode = array()
	$_supportNullValue = false
Attributs protégés hérités de CMSObject
	$_errors = array()

Membres hérités additionnels
Fonctions membres publiques statiques hérités de Table
static	getInstance ($type, $prefix='JTable', $config=array())
static	addIncludePath ($path=null)
Fonctions membres protégées hérités de Table
	_getAssetName ()
	_getAssetTitle ()
	_lock ()
	_unlock ()

Description détaillée

Users table

Depuis

1.7.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

DatabaseDriver

$db

)

Constructor

Paramètres

DatabaseDriver

$db

Database driver object.

Depuis

1.7.0

Références $db, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

bind()

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

1.7.0

Implémente TableInterface.

Références $query, $return, et ArrayHelper\toInteger().

check()

check

(

)

Validation and filtering

Renvoie

boolean True if satisfactory

Depuis

1.7.0

Implémente TableInterface.

Références $query, $this, Text\_(), PunycodeHelper\emailToPunycode(), Factory\getApplication(), Factory\getDate(), InputFilter\getInstance(), ParameterType\INTEGER, MailHelper\isEmailAddress(), null, Text\sprintf(), et StringHelper\strlen().

delete()

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

1.7.0

Implémente TableInterface.

Références $key, $query, $this, $userId, et ParameterType\INTEGER.

load()

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

1.7.0

Implémente TableInterface.

Références $data, $id, $query, $return, $userId, PunycodeHelper\emailToUTF8(), ParameterType\INTEGER, et null.

setLastVisit()

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

1.7.0

Pass through method to the table for setting the last visit date

Paramètres

integer

$timestamp

The timestamp, defaults to 'now'.

Renvoie

boolean True on success.

Depuis

1.7.0

Références $date, $db, $id, $query, $this, $userId, Factory\getDate(), ParameterType\INTEGER, et null.

store()

store

(

$updateNulls = true

)

Method to store a row in the database from the Table 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 Table instance.

Paramètres

boolean

$updateNulls

True to update fields even if they are null.

Renvoie

boolean True on success.

Depuis

1.7.0

Implémente TableInterface.

Références $groups, $key, $query, $result, $this, block, et ParameterType\INTEGER.

Documentation des champs

$_supportNullValue

$_supportNullValue = true

protected

$groups

$groups

---

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

• Table/User.php