Methods summary
public
|
|
public
object
&
|
#
createGroup( )
create a new group
Returns
object XoopsGroup reference to the new group
|
public
object
&
|
#
createUser( )
create a new user
Returns
object XoopsUser reference to the new user
|
public
object
&
|
#
getGroup( integer $id )
retrieve a group
Parameters
- $id
integer ID for the group
Returns
object XoopsGroup reference to the group
|
public
object
&
|
#
getUser( integer $id )
retrieve a user
Parameters
- $id
integer ID for the user
Returns
object XoopsUser reference to the user
|
public
&
|
|
public
|
#
delete( $object & $object )
Delete function. This function is virtual overload function.
Delete function. This function is virtual overload function.
Parameters
- $object
$object XoopsUser or XoopsGroup
|
public
boolean
|
#
deleteGroup( object & $group )
delete a group
Parameters
- $group
object reference to the group to delete
Returns
boolean FALSE if failed
|
public
boolean
|
#
deleteUser( object & $user )
delete a user
Parameters
- $user
object reference to the user to delete
Returns
boolean FALSE if failed
|
public
boolean
|
#
insertGroup( object & $group )
insert a group into the database
insert a group into the database
Parameters
- $group
object reference to the group to insert
Returns
boolean TRUE if already in database and unchanged FALSE on failure
|
public
boolean
|
#
insertUser( object & $user, $force = false )
insert a user into the database
insert a user into the database
Parameters
- $user
object reference to the user to insert
- $force
Returns
boolean TRUE if already in database and unchanged FALSE on failure
|
public
array
&
|
#
getGroups( object $criteria = null, boolean $id_as_key = false )
retrieve groups from the database
retrieve groups from the database
Parameters
- $criteria
object CriteriaElement
- $id_as_key
boolean use the group's ID as key for the array?
Returns
|
public
array
&
|
#
getUsers( object $criteria = null, boolean $id_as_key = false )
retrieve users from the database
retrieve users from the database
Parameters
- $criteria
object CriteriaElement
- $id_as_key
boolean use the group's ID as key for the array?
Returns
|
public
array
&
|
#
getGroupList( object $criteria = null )
get a list of groupnames and their IDs
get a list of groupnames and their IDs
Parameters
Returns
array associative array of group-IDs and names
|
public
array
|
#
getUserList( object $criteria = null )
get a list of usernames and their IDs
get a list of usernames and their IDs
Parameters
Returns
array associative array of user-IDs and names
|
public
object
|
#
addUserToGroup( integer $group_id, integer $user_id )
add a user to a group
Parameters
- $group_id
integer ID of the group
- $user_id
integer ID of the user
Returns
object XoopsMembership
|
public
boolean
|
#
removeUserFromGroup( integer $group_id, integer $user_id )
remove a one user from a group.
remove a one user from a group.
Parameters
- $group_id
integer ID of the group
- $user_id
integer ID of the user
Returns
boolean success?
|
public
boolean
|
#
removeUsersFromGroup( integer $group_id, array $user_ids = array() )
remove a list of users from a group
remove a list of users from a group
Parameters
- $group_id
integer ID of the group
- $user_ids
array array of user-IDs
Returns
boolean success?
|
public
array
&
|
#
getUsersByGroup( integer $group_id, boolean $asobject = false, integer $limit = 0, integer $start = 0 )
get a list of users belonging to a group
get a list of users belonging to a group
Parameters
- $group_id
integer ID of the group
- $asobject
boolean return the users as objects?
- $limit
integer number of users to return
- $start
integer index of the first user to return
Returns
array Array of XoopsUser objects (if $asobject is TRUE) or of associative
arrays matching the record structure in the database.
|
public
&
|
|
public
array
&
|
#
getGroupsByUser( integer $user_id, boolean $asobject = false )
get a list of groups that a user is member of
get a list of groups that a user is member of
Parameters
- $user_id
integer ID of the user
- $asobject
boolean return groups as XoopsGroup objects or arrays?
Returns
array array of objects or arrays
|
public
object
&
|
#
loginUser( string $uname, string $pwd )
log in a user
Parameters
- $uname
string username as entered in the login form
- $pwd
string password entered in the login form
Returns
object XoopsUser reference to the logged in user. FALSE if failed to log in
|
public
object
&
|
#
loginUserMd5( string $uname, string $md5pwd )
logs in a user with an md5 encrypted password
logs in a user with an md5 encrypted password
Parameters
- $uname
string username
- $md5pwd
string password encrypted with md5
Returns
object XoopsUser reference to the logged in user. FALSE if failed to log in
|
public
integer
|
#
getUserCount( object $criteria = null )
count users matching certain conditions
count users matching certain conditions
Parameters
Returns
integer
|
public
integer
|
#
getUserCountByGroup( integer $group_id )
count users belonging to a group
count users belonging to a group
Parameters
- $group_id
integer ID of the group
Returns
integer
|
public
integer
|
|
public
boolean
|
#
updateUserByField( object & $user, string $fieldName, string $fieldValue )
updates a single field in a users record
updates a single field in a users record
Parameters
- $user
object reference to the XoopsUser object
- $fieldName
string name of the field to update
- $fieldValue
string updated value for the field
Returns
boolean TRUE if success or unchanged, FALSE on failure
|
public
boolean
|
#
updateUsersByField( string $fieldName, string $fieldValue, object $criteria = null )
updates a single field in a users record
updates a single field in a users record
Parameters
- $fieldName
string name of the field to update
- $fieldValue
string updated value for the field
- $criteria
object CriteriaElement object
Returns
boolean TRUE if success or unchanged, FALSE on failure
|
public
boolean
|
#
activateUser( object & $user )
activate a user
Parameters
- $user
object reference to the XoopsUser object
Returns
boolean successful?
|