XoopsUserHandler Class Reference

Inheritance diagram for XoopsUserHandler:

Public Member Functions
&	create ($isNew=true)
&	get ($id)
	insert (&$user, $force=false)
	delete (&$user, $force=false)
	getUnames ($criteria=null, $id_as_key=false)
&	getObjects ($criteria=null, $id_as_key=false)
&	getObjectsByLevel ($level=0)
	getCount ($criteria=null)
	deleteAll ($criteria=null)
	updateAll ($fieldname, $fieldvalue, $criteria=null)
Public Member Functions inherited from XoopsObjectHandler
	__construct (&$db)
&	create ()
	insert (&$object)
	delete (&$object)

Additional Inherited Members
Data Fields inherited from XoopsObjectHandler
	$db

Detailed Description

Definition at line 500 of file user.php.

Member Function Documentation

create()

& create

(

$isNew = true

)

create a new user

Parameters

bool

$isNew

flag the new objects as "new"?

Returns

object XoopsUser

Definition at line 509 of file user.php.

delete()

delete	(	&	$user,
			$force = false )

delete a user from the database

Parameters

object	$user	reference to the user to delete
bool	$force

Returns

bool FALSE if failed.

Definition at line 633 of file user.php.

deleteAll()

deleteAll

(

$criteria = null

)

delete users matching a set of conditions

Parameters

object

$criteria

CriteriaElement

Returns

bool FALSE if deletion failed

Definition at line 773 of file user.php.

get()

& get

(

$id

)

retrieve a user

Parameters

int

$id

UID of the user

Returns

mixed reference to the XoopsUser object, FALSE if failed

Reimplemented from XoopsObjectHandler.

Definition at line 524 of file user.php.

getCount()

getCount

(

$criteria = null

)

count users matching a condition

Parameters

object

$criteria

CriteriaElement to match

Returns

int count of users

Definition at line 753 of file user.php.

getObjects()

& getObjects	(		$criteria = null,
			$id_as_key = false )

retrieve users from the database

Parameters

object	$criteria	CriteriaElement conditions to be met
bool	$id_as_key	use the UID as key for the array?

Returns

array array of XoopsUser objects

Definition at line 691 of file user.php.

getObjectsByLevel()

& getObjectsByLevel

(

$level = 0

)

This method is called from pmlite.php. Wmm.. Type:expand (no using criteria).

Author

minahito

Parameters

int

$level

Returns

array

Definition at line 728 of file user.php.

getUnames()

getUnames	(		$criteria = null,
			$id_as_key = false )

Get unames from the database

Parameters

object	$criteria	CriteriaElement conditions to be met
bool	$id_as_key	use the UID as key for the array?

Returns

array array of uname

Definition at line 657 of file user.php.

insert()

insert	(	&	$user,
			$force = false )

insert a new user in the database

Parameters

object	$user	reference to the XoopsUser object
bool	$force

Returns

bool FALSE if failed, TRUE if already present and unchanged or successful

Definition at line 548 of file user.php.

updateAll()

updateAll	(		$fieldname,
			$fieldvalue,
			$criteria = null )

Change a value for users with a certain criteria

Parameters

string	$fieldname	Name of the field
string	$fieldvalue	Value to write
object	$criteria	CriteriaElement

Returns

bool

Definition at line 794 of file user.php.

---

The documentation for this class was generated from the following file:

• html/kernel/user.php