Class XoopsUserHandler
XOOPS user handler class. This class is responsible for providing data access
mechanisms to the data source of XOOPS user class objects.
-
XoopsObjectHandler
-
XoopsUserHandler
Methods summary
public
object
&
|
#
create( boolean $isNew = true )
create a new user
Parameters
- $isNew
boolean flag the new objects as "new"?
Returns
object XoopsUser
Overrides
|
public
mixed
&
|
#
get( integer $id )
retrieve a user
Parameters
- $id
integer UID of the user
Returns
mixed reference to the XoopsUser object, FALSE if failed
Overrides
|
public
boolean
|
#
insert( object & $user, boolean $force = false )
insert a new user in the database
insert a new user in the database
Parameters
- $user
object reference to the XoopsUser object
- $force
boolean
Returns
boolean FALSE if failed, TRUE if already present and unchanged or successful
Overrides
|
public
boolean
|
#
delete( object & $user, boolean $force = false )
delete a user from the database
delete a user from the database
Parameters
- $user
object reference to the user to delete
- $force
boolean
Returns
boolean FALSE if failed.
Overrides
|
public
array
&
|
#
getObjects( object $criteria = null, boolean $id_as_key = false )
retrieve users from the database
retrieve users from the database
Parameters
- $criteria
object CriteriaElement conditions to be met
- $id_as_key
boolean use the UID as key for the array?
Returns
|
public
&
|
#
getObjectsByLevel( $level = 0 )
This method is called from pmlite.php. Wmm.. Type:expand (no using
criteria).
This method is called from pmlite.php. Wmm.. Type:expand (no using
criteria).
Author
minahito
|
public
integer
|
#
getCount( object $criteria = null )
count users matching a condition
count users matching a condition
Parameters
Returns
integer count of users
|
public
boolean
|
#
deleteAll( object $criteria = null )
delete users matching a set of conditions
delete users matching a set of conditions
Parameters
Returns
boolean FALSE if deletion failed
|
public
boolean
|
#
updateAll( string $fieldname, string $fieldvalue, object $criteria = null )
Change a value for users with a certain criteria
Change a value for users with a certain criteria
Parameters
- $fieldname
string Name of the field
- $fieldvalue
string Value to write
- $criteria
object CriteriaElement
Returns
boolean
|