|
| | __construct (XoopsDatabase $db) |
| |
| & | createGroup () |
| |
| | createUser () |
| |
| | getGroup ($id) |
| |
| | getUser ($id) |
| |
| | deleteGroup (XoopsGroup $group) |
| |
| | deleteUser (XoopsUser $user) |
| |
| | insertGroup (XoopsGroup $group) |
| |
| | insertUser (XoopsUser $user, $force=false) |
| |
| | getGroups (CriteriaElement $criteria=null, $id_as_key=false) |
| |
| | getUsers (CriteriaElement $criteria=null, $id_as_key=false) |
| |
| | getGroupList (CriteriaElement $criteria=null) |
| |
| | getUserList (CriteriaElement $criteria=null) |
| |
| | addUserToGroup ($group_id, $user_id) |
| |
| | removeUsersFromGroup ($group_id, $user_ids=array()) |
| |
| | getUsersByGroup ($group_id, $asobject=false, $limit=0, $start=0) |
| |
| | getGroupsByUser ($user_id, $asobject=false) |
| |
| | loginUser ($uname, $pwd) |
| |
| | getUserCount (CriteriaElement $criteria=null) |
| |
| | getUserCountByGroup ($group_id) |
| |
| | updateUserByField (XoopsUser $user, $fieldName, $fieldValue) |
| |
| | updateUsersByField ($fieldName, $fieldValue, CriteriaElement $criteria=null) |
| |
| | activateUser (XoopsUser $user) |
| |
| | getUsersByGroupLink ($groups, CriteriaElement $criteria=null, $asobject=false, $id_as_key=false) |
| |
| | getUserCountByGroupLink ($groups, CriteriaElement $criteria=null) |
| |
◆ __construct()
◆ activateUser()
activate a user
- Paramètres
-
- Renvoie
- mixed successful? false on failure
◆ addUserToGroup()
| addUserToGroup |
( |
|
$group_id, |
|
|
|
$user_id |
|
) |
| |
◆ createGroup()
◆ createUser()
create a new user
- Renvoie
- XoopsUser reference to the new user
◆ deleteGroup()
delete a group
- Paramètres
-
- Renvoie
- bool FALSE if failed
◆ deleteUser()
delete a user
- Paramètres
-
| XoopsUser | $user | reference to the user to delete |
- Renvoie
- bool FALSE if failed
◆ getGroup()
◆ getGroupList()
get a list of groupnames and their IDs
- Paramètres
-
- Renvoie
- array associative array of group-IDs and names
◆ getGroups()
retrieve groups from the database
- Paramètres
-
- Renvoie
- array array of XoopsGroup objects
◆ getGroupsByUser()
| getGroupsByUser |
( |
|
$user_id, |
|
|
|
$asobject = false |
|
) |
| |
get a list of groups that a user is member of
- Paramètres
-
| int | $user_id | ID of the user |
| bool | $asobject | return groups as XoopsGroup objects or arrays? |
- Renvoie
- array array of objects or arrays
◆ getUser()
retrieve a user
- Paramètres
-
- Renvoie
- XoopsUser reference to the user
◆ getUserCount()
count users matching certain conditions
- Paramètres
-
- Renvoie
- int
◆ getUserCountByGroup()
| getUserCountByGroup |
( |
|
$group_id | ) |
|
count users belonging to a group
- Paramètres
-
| int | $group_id | ID of the group |
- Renvoie
- int
◆ getUserCountByGroupLink()
Get count of users belonging to certain groups and matching criteria Temporary solution
- Paramètres
-
- Renvoie
- int count of users
◆ getUserList()
get a list of usernames and their IDs
- Paramètres
-
- Renvoie
- array associative array of user-IDs and names
◆ getUsers()
retrieve users from the database
- Paramètres
-
- Renvoie
- array array of XoopsUser objects
◆ getUsersByGroup()
| getUsersByGroup |
( |
|
$group_id, |
|
|
|
$asobject = false, |
|
|
|
$limit = 0, |
|
|
|
$start = 0 |
|
) |
| |
get a list of users belonging to a group
- Paramètres
-
| 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 |
- Renvoie
- array Array of XoopsUser objects (if $asobject is TRUE) or of associative arrays matching the record structure in the database.
◆ getUsersByGroupLink()
Get a list of users belonging to certain groups and matching criteria Temporary solution
- Paramètres
-
| array | $groups | IDs of groups |
| CriteriaElement | $criteria | CriteriaElement object |
| bool | $asobject | return the users as objects? |
| bool | $id_as_key | use the UID as key for the array if $asobject is TRUE |
- Renvoie
- array Array of XoopsUser objects (if $asobject is TRUE) or of associative arrays matching the record structure in the database.
◆ insertGroup()
insert a group into the database
- Paramètres
-
- Renvoie
- bool TRUE if already in database and unchanged FALSE on failure
◆ insertUser()
insert a user into the database
- Paramètres
-
| XoopsUser | $user | reference to the user to insert |
| bool | $force | |
- Renvoie
- bool TRUE if already in database and unchanged FALSE on failure
◆ loginUser()
| loginUser |
( |
|
$uname, |
|
|
|
$pwd |
|
) |
| |
log in a user
- Paramètres
-
| string | $uname | username as entered in the login form |
| string | $pwd | password entered in the login form |
- Renvoie
- XoopsUser|false logged in XoopsUser, FALSE if failed to log in
◆ removeUsersFromGroup()
| removeUsersFromGroup |
( |
|
$group_id, |
|
|
|
$user_ids = array() |
|
) |
| |
remove a list of users from a group
- Paramètres
-
| int | $group_id | ID of the group |
| array | $user_ids | array of user-IDs |
- Renvoie
- bool success?
◆ updateUserByField()
| updateUserByField |
( |
XoopsUser |
$user, |
|
|
|
$fieldName, |
|
|
|
$fieldValue |
|
) |
| |
updates a single field in a users record
- Paramètres
-
| XoopsUser | $user | reference to the XoopsUser object |
| string | $fieldName | name of the field to update |
| string | $fieldValue | updated value for the field |
- Renvoie
- bool TRUE if success or unchanged, FALSE on failure
◆ updateUsersByField()
updates a single field in a users record
- Paramètres
-
- Renvoie
- bool TRUE if success or unchanged, FALSE on failure
◆ $groupHandler
holds reference to group handler(DAO) class @access private
◆ $membershipHandler
holds reference to membership handler(DAO) class
◆ $membersWorkingList
| $membersWorkingList = array() |
|
protected |
holds temporary user objects
◆ $userHandler
holds reference to user handler(DAO) class
La documentation de cette classe a été générée à partir du fichier suivant :
Voici le graphe d'appel pour cette fonction :
1.8.17 
