Class XoopsMemberHandler

XOOPS member handler class. This class provides simple interface (a facade class) for handling groups/users/ membership data.

Package: kernel
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Located at ernel/member.php

Methods summary
`public`	# `__construct( XoopsDatabase $db )` constructor constructor Parameters `$db`
`public XoopsGroup &`	# `createGroup( )` create a new group create a new group Returns `XoopsGroup` XoopsGroup reference to the new group
`public XoopsUser`	# `createUser( )` create a new user create a new user Returns `XoopsUser` reference to the new user
`public XoopsGroup`	# `getGroup( integer $id )` retrieve a group retrieve a group Parameters `$id` ID for the group Returns `XoopsGroup` XoopsGroup reference to the group
`public XoopsUser`	# `getUser( integer $id )` retrieve a user retrieve a user Parameters `$id` ID for the user Returns `XoopsUser` reference to the user
`public boolean`	# `deleteGroup( XoopsGroup $group )` delete a group delete a group Parameters `$group` reference to the group to delete Returns boolean FALSE if failed
`public boolean`	# `deleteUser( XoopsUser $user )` delete a user delete a user Parameters `$user` reference to the user to delete Returns boolean FALSE if failed
`public boolean`	# `insertGroup( XoopsGroup $group )` insert a group into the database insert a group into the database Parameters `$group` reference to the group to insert Returns boolean TRUE if already in database and unchanged FALSE on failure
`public boolean`	# `insertUser( XoopsUser $user, boolean $force = false )` insert a user into the database insert a user into the database Parameters `$user` reference to the user to insert `$force` Returns boolean TRUE if already in database and unchanged FALSE on failure
`public array`	# `getGroups( CriteriaElement $criteria = null, boolean $id_as_key = false )` retrieve groups from the database retrieve groups from the database Parameters `$criteria` `CriteriaElement` `$id_as_key` use the group's ID as key for the array? Returns array array of `XoopsGroup` objects
`public array`	# `getUsers( CriteriaElement $criteria = null, boolean $id_as_key = false )` retrieve users from the database retrieve users from the database Parameters `$criteria` `CriteriaElement` `$id_as_key` use the group's ID as key for the array? Returns array array of `XoopsUser` objects
`public array`	# `getGroupList( CriteriaElement $criteria = null )` get a list of groupnames and their IDs get a list of groupnames and their IDs Parameters `$criteria` `CriteriaElement` object Returns array associative array of group-IDs and names
`public array`	# `getUserList( CriteriaElement $criteria = null )` get a list of usernames and their IDs get a list of usernames and their IDs Parameters `$criteria` `CriteriaElement` object Returns array associative array of user-IDs and names
`public XoopsMembership`	# `addUserToGroup( integer $group_id, integer $user_id )` add a user to a group add a user to a group Parameters `$group_id` ID of the group `$user_id` ID of the user Returns `XoopsMembership` XoopsMembership
`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` ID of the group `$user_ids` 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` ID of the group `$asobject` return the users as objects? `$limit` number of users to return `$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.
`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` ID of the user `$asobject` return groups as `XoopsGroup` objects or arrays? Returns array array of objects or arrays
`public XoopsUser\|false`	# `loginUser( string $uname, string $pwd )` log in a user log in a user Parameters `$uname` username as entered in the login form `$pwd` password entered in the login form Returns `XoopsUser`\|false logged in XoopsUser, FALSE if failed to log in
`public integer\|null`	# `getColumnCharacterLength( string $table, string $column )` Get maximum character length for a table column Get maximum character length for a table column Parameters `$table` database table `$column` table column Returns integer\|null max length or null on error
`public integer`	# `getUserCount( CriteriaElement $criteria = null )` count users matching certain conditions count users matching certain conditions Parameters `$criteria` `CriteriaElement` object Returns integer
`public integer`	# `getUserCountByGroup( integer $group_id )` count users belonging to a group count users belonging to a group Parameters `$group_id` ID of the group Returns integer
`public boolean`	# `updateUserByField( XoopsUser $user, string $fieldName, string $fieldValue )` updates a single field in a users record updates a single field in a users record Parameters `$user` reference to the `XoopsUser` object `$fieldName` name of the field to update `$fieldValue` updated value for the field Returns boolean TRUE if success or unchanged, FALSE on failure
`public boolean`	# `updateUsersByField( string $fieldName, string $fieldValue, CriteriaElement $criteria = null )` updates a single field in a users record updates a single field in a users record Parameters `$fieldName` name of the field to update `$fieldValue` updated value for the field `$criteria` `CriteriaElement` object Returns boolean TRUE if success or unchanged, FALSE on failure
`public mixed`	# `activateUser( XoopsUser $user )` activate a user activate a user Parameters `$user` reference to the `XoopsUser` object Returns mixed successful? false on failure
`public array`	# `getUsersByGroupLink( array $groups, CriteriaElement $criteria = null, boolean $asobject = false, boolean $id_as_key = false )` Get a list of users belonging to certain groups and matching criteria Temporary solution Get a list of users belonging to certain groups and matching criteria Temporary solution Parameters `$groups` IDs of groups `$criteria` `CriteriaElement` object `$asobject` return the users as objects? `$id_as_key` use the UID as key for the array if $asobject is TRUE Returns array Array of `XoopsUser` objects (if $asobject is TRUE) or of associative arrays matching the record structure in the database.
`public integer`	# `getUserCountByGroupLink( integer $groups, CriteriaElement $criteria = null )` Get count of users belonging to certain groups and matching criteria Temporary solution Get count of users belonging to certain groups and matching criteria Temporary solution Parameters `$groups` IDs of groups `$criteria` Returns integer count of users

Properties summary
`protected`	`$groupHandler` holds reference to group handler(DAO) class holds reference to group handler(DAO) class	#
`protected`	`$userHandler` holds reference to user handler(DAO) class holds reference to user handler(DAO) class	#
`protected`	`$membershipHandler` holds reference to membership handler(DAO) class holds reference to membership handler(DAO) class	#
`protected array`	`$membersWorkingList` holds temporary user objects holds temporary user objects	# `array()`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsMemberHandler

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns