PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of User.php

Joomla! Content Management System

Copyright:	(C) 2005 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	535 lines (17 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

User:: (7 methods):
  __construct()
  load()
  bind()
  check()
  store()
  delete()
  setLastVisit()

Class: User - X-Ref

Users table

__construct(DatabaseDriver $db) X-Ref

Constructor

param: DatabaseDriver $db Database driver object.

load($userId = null, $reset = true) X-Ref

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: integer  $userId  An optional user id.
param: boolean  $reset   False if row not found or on error
return: boolean  True on success, false on failure.

bind($array, $ignore = '') X-Ref

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

param: array  $array   The data to bind.
param: mixed  $ignore  An array or space separated list of fields to ignore.
return: boolean  True on success, false on failure.

check() X-Ref

Validation and filtering

return: boolean True if satisfactory

store($updateNulls = true) X-Ref

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: boolean $updateNulls True to update fields even if they are null.
return: boolean True on success.

delete($userId = null) X-Ref

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

param: integer $userId An optional user id.
return: boolean True on success, false on failure.

setLastVisit($timeStamp = null, $userId = null) X-Ref

Updates last visit time of user

param: integer  $timeStamp  The timestamp, defaults to 'now'.
param: integer  $userId     The user id (optional).
return: boolean  False if an error occurs

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/Table/ -> User.php (summary)

Defines 1 class