Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

 Class JTableUser

Description

Users table

Located in /joomla/database/table/user.php (line 25)

Class JObject   (Subpackage Base)

Abstract class JTable
   
   Class JTableUser   (Subpackage Table)
Variable Summary
Variable string $activation
Variable int $block
Variable string $email
Variable int $gid
Variable int $id
Variable datetime $lastvisitDate
Variable string $name
Variable string $params
Variable string $password
Variable datetime $registerDate
Variable string $username
Variable string $usertype
Method Summary
Constructor JTableUser __construct (database &$db)
Method null|string bind ( $array, [ $ignore = ''], array $hash)
Method boolean check ()
Method void delete ([ $oid = null])
Method array getUserList ()
Method array getUserListFromGroup (string $value, string $name, [string $recurse = 'NO_RECURSE'], [string $order = 'name'])
Method boolean setLastVisit ([int $timeStamp = null], [ $id = null])
Method void store ([ $updateNulls = false])
Variables
string $activation = null (line 109)

Description

  • var: activation hash
int $block = null (line 74)

Description

string $email = null (line 53)

The email

int $gid = null (line 88)

The group id number

int $id = null (line 32)

Unique id

datetime $lastvisitDate = null (line 102)

Description

string $name = null (line 39)

The users real name (or nickname)

string $params = null (line 116)

Description

string $password = null (line 60)

MD5 encrypted password

datetime $registerDate = null (line 95)

Description

int $sendEmail = null (line 81)

Description

string $username = null (line 46)

The login name

string $usertype = null (line 67)

Description

Inherited Variables

Inherited from JTable

Variable JTable::$_db
Variable JTable::$_error
Variable JTable::$_errorNum
Variable JTable::$_tbl
Variable JTable::$_tbl_key
Methods
Constructor __construct (line 121)
JTableUser __construct (database &$db)
  • database &$db: A database connector object

Redefinition of:
JTable::__construct()
Object constructor to set table and key field
bind (line 329)

Overloaded bind function

  • return: null is operation was satisfactory, otherwise returns an error
  • since: 1.5
  • see: JTable:bind
  • access: public
null|string bind ( $array, [ $ignore = ''], array $hash)
  • array $hash: named array
  • $array
  • $ignore

Redefinition of:
JTable::bind()
Binds a named array/hash to this object
check (line 136)

Validation and filtering

  • return: True is satisfactory
boolean check ()

Redefinition of:
JTable::check()
Generic check method
delete (line 234)
void delete ([ $oid = null])
  • $oid

Redefinition of:
JTable::delete()
Default delete method
getUserList (line 345)

Returns a complete user list

array getUserList ()
getUserListFromGroup (line 360)

Gets the users from a group

array getUserListFromGroup (string $value, string $name, [string $recurse = 'NO_RECURSE'], [string $order = 'name'])
  • string $value: The value for the group (not used 1.0)
  • string $name: The name for the group
  • string $recurse: If RECURSE, will drill into child groups
  • string $order: Ordering for the list
setLastVisit (line 284)

Updates last visit time of user

  • return: False if an error occurs
boolean setLastVisit ([int $timeStamp = null], [ $id = null])
  • int $timeStamp: The timestamp, defaults to 'now'
  • $id
store (line 190)
void store ([ $updateNulls = false])
  • $updateNulls

Redefinition of:
JTable::store()
Inserts a new row if id is zero or updates an existing row in the database table

Inherited Methods

Inherited From JTable

 JTable::__construct()
 JTable::addIncludePath()
 JTable::bind()
 JTable::canDelete()
 JTable::check()
 JTable::checkin()
 JTable::checkout()
 JTable::delete()
 JTable::getDBO()
 JTable::getError()
 JTable::getErrorNum()
 JTable::getInstance()
 JTable::getKeyName()
 JTable::getNextOrder()
 JTable::getTableName()
 JTable::hit()
 JTable::isCheckedOut()
 JTable::load()
 JTable::move()
 JTable::publish()
 JTable::reorder()
 JTable::reset()
 JTable::save()
 JTable::setDBO()
 JTable::setError()
 JTable::setErrorNum()
 JTable::store()
 JTable::toXML()

Inherited From JObject

 JObject::JObject()
 JObject::__construct()
 JObject::get()
 JObject::getPublicProperties()
 JObject::set()
 JObject::toString()

Documentation generated on Mon, 05 Mar 2007 21:30:35 +0000 by phpDocumentor 1.3.1