Class JModelUser

Description

Users model

Located in /model/model/user.php (line 22)

JObject
   |
   --JModel
      |
      --JModelUser
Direct descendents
Class Description
 class mosUser Legacy class, use JModelUser instead
Variable Summary
 string $activation
 int $block
 string $email
 int $gid
 int $id
 datetime $lastvisitDate
 string $name
 string $params
 string $password
 datetime $registerDate
 string $username
 string $usertype
Method Summary
 JModelUser __construct (database &$database)
 boolean check ()
 void delete ([mixed $oid = null])
 array getUserList ()
 array getUserListFromGroup (string $value, string $name, [string $recurse = 'NO_RECURSE'], [string $order = 'name'])
 boolean setLastVisit ([int $timeStamp = null], [mixed $id = null])
 void store ([mixed $updateNulls = false])
 int userExists (string $username)
Variables
string $activation = null (line 47)
  • var: activation hash
int $block = null (line 37)
string $email = null (line 31)
  • var: email
int $gid = null (line 41)
  • var: The group id number
int $id = null (line 25)
  • var: Unique id
datetime $lastvisitDate = null (line 45)
string $name = null (line 27)
  • var: The users real name (or nickname)
string $params = null (line 49)
string $password = null (line 33)
  • var: MD5 encrypted password
datetime $registerDate = null (line 43)
int $sendEmail = null (line 39)
string $username = null (line 29)
  • var: The login name
string $usertype = null (line 35)

Inherited Variables

Inherited from JModel

JModel::$_db
JModel::$_error
JModel::$_tbl
JModel::$_tbl_key
Methods
Constructor __construct (line 54)
JModelUser __construct (database &$database)
  • database &$database: A database connector object

Redefinition of:
JModel::__construct()
Object constructor to set table and key field

Redefined in descendants as:
check (line 66)

Validation and filtering

  • return: True is satisfactory
boolean check ()

Redefinition of:
JModel::check()
Generic check method
delete (line 162)
void delete ([mixed $oid = null])

Redefinition of:
JModel::delete()
Default delete method
getUserList (line 263)

Returns a complete user list

array getUserList ()
getUserListFromGroup (line 278)

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 211)

Updates last visit time of user

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

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

Returns if a user exists

  • return: Number of matching rows (either 0 or 1)
int userExists (string $username)
  • string $username: The username to search on

Inherited Methods

Inherited From JModel

 JModel::__construct()
 JModel::bind()
 JModel::canDelete()
 JModel::check()
 JModel::checkin()
 JModel::checkout()
 JModel::delete()
 JModel::filter()
 JModel::getError()
 JModel::getInstance()
 JModel::getPublicProperties()
 JModel::hit()
 JModel::isCheckedOut()
 JModel::load()
 JModel::move()
 JModel::publish()
 JModel::publish_array()
 JModel::save()
 JModel::store()
 JModel::toXML()
 JModel::updateOrder()

Inherited From JObject

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

Documentation generated on Sat, 4 Feb 2006 14:27:16 +0100 by phpDocumentor 1.3.0RC4