Public Member Functions
	__construct (&$db)

	XoopsMemberHandler (&$db)

&	createGroup ()

&	createUser ()

&	getGroup ($id)

&	getUser ($id)

&	getUserByEmail ($email)

	delete (&$object)

	deleteGroup (&$group)

	deleteUser (&$user)

	insertGroup (&$group)

	insertUser (&$user, $force=false)

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

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

&	getGroupList ($criteria=null)

	getUserList ($criteria=null)

	addUserToGroup ($group_id, $user_id)

	removeUserFromGroup ($group_id, $user_id)

	removeUsersFromGroup ($group_id, $user_ids=[])

&	getUsersByGroup ($group_id, $asobject=false, $limit=0, $start=0)

&	getUsersByNoGroup ($group_id, $asobject=false, $limit=0, $start=0)

&	getGroupsByUser ($user_id, $asobject=false)

&	loginUser ($uname, $pwd)

&	loginUserMd5 ($uname, $md5pwd)

	getUserCount ($criteria=null)

	getUserCountByGroup ($group_id)

	getUserCountByNoGroup ($group_id)

	updateUserByField (&$user, $fieldName, $fieldValue)

	updateUsersByField ($fieldName, $fieldValue, $criteria=null)

	activateUser (&$user)

Data Fields
	$_gHandler

	$_uHandler

	$_mHandler

	$_members = []

Detailed Description

Definition at line 29 of file member.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( & $db )

#- constructor

Parameters

$db

Definition at line 58 of file member.php.

Member Function Documentation

◆ activateUser()

activateUser ( & $user )

activate a user

Parameters

object $user reference to the XoopsUser object

Returns: bool successful?

Definition at line 512 of file member.php.

◆ addUserToGroup()

addUserToGroup	(		$group_id,
			$user_id )

add a user to a group

Parameters

int	$group_id	ID of the group
int	$user_id	ID of the user

Returns: bool XoopsMembership

Definition at line 258 of file member.php.

◆ createGroup()

& createGroup ( )

create a new group

Returns: object XoopsGroup reference to the new group

Definition at line 74 of file member.php.

◆ createUser()

& createUser ( )

create a new user

Returns: object XoopsUser reference to the new user

Definition at line 85 of file member.php.

◆ delete()

delete ( & $object )

Delete function. This function is virtual overload function.

Parameters

XoopsUser $object or XoopsGroup

Returns: bool

Definition at line 138 of file member.php.

◆ deleteGroup()

deleteGroup ( & $group )

delete a group

Parameters

object $group reference to the group to delete

Returns: bool FALSE if failed

Definition at line 153 of file member.php.

◆ deleteUser()

deleteUser ( & $user )

delete a user

Parameters

object $user reference to the user to delete

Returns: bool FALSE if failed

Definition at line 166 of file member.php.

◆ getGroup()

& getGroup ( $id )

retrieve a group

Parameters

int $id ID for the group

Returns: object XoopsGroup reference to the group

Definition at line 97 of file member.php.

◆ getGroupList()

& getGroupList ( $criteria = null )

get a list of groupnames and their IDs

Parameters

object $criteria CriteriaElement object

Returns: array associative array of group-IDs and names

Definition at line 230 of file member.php.

◆ getGroups()

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

retrieve groups from the database

Parameters

object	$criteria	`CriteriaElement`
bool	$id_as_key	use the group's ID as key for the array?

Returns: array array of XoopsGroup objects

Definition at line 205 of file member.php.

◆ getGroupsByUser()

& getGroupsByUser	(		$user_id,
			$asobject = false )

get a list of groups that a user is member of

Parameters

int	$user_id	ID of the user
bool	$asobject	return groups as `XoopsGroup` objects or arrays?

Returns: array array of objects or arrays

Definition at line 364 of file member.php.

◆ getUser()

& getUser ( $id )

retrieve a user

Parameters

int $id ID for the user

Returns: object XoopsUser reference to the user

Definition at line 109 of file member.php.

◆ getUserByEmail()

& getUserByEmail ( $email )

<

Todo: not depends

Definition at line 117 of file member.php.

◆ getUserCount()

getUserCount ( $criteria = null )

count users matching certain conditions

Parameters

object $criteria CriteriaElement object

Returns: int

Definition at line 437 of file member.php.

◆ getUserCountByGroup()

getUserCountByGroup ( $group_id )

count users belonging to a group

Parameters

int $group_id ID of the group

Returns: int

Definition at line 448 of file member.php.

◆ getUserCountByNoGroup()

getUserCountByNoGroup ( $group_id )

Parameters

$group_id

Returns: int

See also: getUserCountByGroup

Definition at line 458 of file member.php.

◆ getUserList()

getUserList ( $criteria = null )

get a list of usernames and their IDs

Parameters

object $criteria CriteriaElement object

Returns: array associative array of user-IDs and names

Definition at line 246 of file member.php.

◆ getUsers()

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

retrieve users from the database

Parameters

object	$criteria	`CriteriaElement`
bool	$id_as_key	use the group's ID as key for the array?

Returns: array array of XoopsUser objects

Definition at line 218 of file member.php.

◆ getUsersByGroup()

& getUsersByGroup	(	$group_id,
		$asobject = false,
		$limit = 0,
		$start = 0 )

get a list of users belonging to a group

Parameters

int	$group_id	ID of the group
bool	$asobject	return the users as objects?
int	$limit	number of users to return
int	$start	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.

Definition at line 313 of file member.php.

◆ getUsersByNoGroup()

& getUsersByNoGroup	(	$group_id,
		$asobject = false,
		$limit = 0,
		$start = 0 )

Parameters

	$group_id
bool	$asobject
int	$limit
int	$start

Returns: array

See also: getUsersByGroup

Definition at line 339 of file member.php.

◆ insertGroup()

insertGroup ( & $group )

insert a group into the database

Parameters

object $group reference to the group to insert

Returns: bool TRUE if already in database and unchanged FALSE on failure

Definition at line 180 of file member.php.

◆ insertUser()

insertUser	(	&	$user,
			$force = false )

insert a user into the database

Parameters

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

Returns: bool TRUE if already in database and unchanged FALSE on failure

Definition at line 193 of file member.php.

◆ loginUser()

& loginUser	(		$uname,
			$pwd )

log in a user

Parameters

string	$uname	username as entered in the login form
string	$pwd	password entered in the login form

Returns: object XoopsUser reference to the logged in user. FALSE if failed to log in

Definition at line 385 of file member.php.

◆ loginUserMd5()

& loginUserMd5	(		$uname,
			$md5pwd )

logs in a user with an md5 encrypted password

Parameters

string	$uname	username
string	$md5pwd	password encrypted with md5

Returns: object XoopsUser reference to the logged in user. FALSE if failed to log in

Definition at line 419 of file member.php.

◆ removeUserFromGroup()

removeUserFromGroup	(		$group_id,
			$user_id )

remove a one user from a group.

Parameters

int	$group_id	ID of the group
int	$user_id	ID of the user

Returns: bool success?

Definition at line 278 of file member.php.

◆ removeUsersFromGroup()

removeUsersFromGroup	(		$group_id,
			$user_ids = [] )

remove a list of users from a group

Parameters

int	$group_id	ID of the group
array	$user_ids	array of user-IDs

Returns: bool success?

Definition at line 291 of file member.php.

◆ updateUserByField()

updateUserByField	(	&	$user,
			$fieldName,
			$fieldValue )

updates a single field in a users record

Parameters

object	$user	reference to the `XoopsUser` object
string	$fieldName	name of the field to update
string	$fieldValue	updated value for the field

Returns: bool TRUE if success or unchanged, FALSE on failure

Definition at line 487 of file member.php.

◆ updateUsersByField()

updateUsersByField	(	$fieldName,
		$fieldValue,
		$criteria = null )

updates a single field in a users record

Parameters

string	$fieldName	name of the field to update
string	$fieldValue	updated value for the field
object	$criteria	`CriteriaElement` object

Returns: bool TRUE if success or unchanged, FALSE on failure

Definition at line 501 of file member.php.

◆ XoopsMemberHandler()

XoopsMemberHandler ( & $db )

Definition at line 64 of file member.php.

Field Documentation

◆ $_gHandler

$_gHandler

#+ holds reference to group handler(DAO) class @access private

Definition at line 36 of file member.php.

◆ $_members

$_members = []

holds temporary user objects

Definition at line 51 of file member.php.

◆ $_mHandler

$_mHandler

holds reference to membership handler(DAO) class

Definition at line 46 of file member.php.

◆ $_uHandler

$_uHandler

holds reference to user handler(DAO) class

Definition at line 41 of file member.php.

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

html/kernel/member.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateUser()

◆ addUserToGroup()

◆ createGroup()

◆ createUser()

◆ delete()

◆ deleteGroup()

◆ deleteUser()

◆ getGroup()

◆ getGroupList()

◆ getGroups()

◆ getGroupsByUser()

◆ getUser()

◆ getUserByEmail()

◆ getUserCount()

◆ getUserCountByGroup()

◆ getUserCountByNoGroup()

◆ getUserList()

◆ getUsers()

◆ getUsersByGroup()

◆ getUsersByNoGroup()

◆ insertGroup()

◆ insertUser()

◆ loginUser()

◆ loginUserMd5()

◆ removeUserFromGroup()

◆ removeUsersFromGroup()

◆ updateUserByField()

◆ updateUsersByField()

◆ XoopsMemberHandler()

Field Documentation

◆ $_gHandler

◆ $_members

◆ $_mHandler

◆ $_uHandler