| 프로퍼티 | 타입 | 설명 | |
|---|---|---|---|
| $groupcache | The list of all groups | ||
| $pdo | PDO |
| 메소드 | 설명 | |
|---|---|---|
| __construct ( ) | Constructor. | |
| addGroup ( string $group ) : boolean | Create a new group with the given name | |
| checkPass ( string $user, string $pass ) : boolean | Check user+password | |
| createUser ( string $user, string $clear, string $name, string $mail, null | array $grps = null ) : boolean | null | Create a new User [implement only where required/possible] | |
| deleteUsers ( array $users ) : integer | Delete one or more users | |
| getUserCount ( array $filter = [] ) : integer | Return a count of the number of user which meet $filter criteria | |
| getUserData ( string $user, boolean $requireGroups = true ) : array | boolean | Return user info | |
| modifyUser ( string $user, array $changes ) : boolean | Modify user data | |
| retrieveGroups ( integer $start, integer $limit ) : array | Retrieve groups | |
| retrieveUsers ( integer $start, integer $limit, array $filter = null ) : array | Bulk retrieval of user data [implement only where required/possible] |
| 메소드 | 설명 | |
|---|---|---|
| _chkcnf ( string[] $keys ) : boolean | Check if the given config strings are set | |
| _clearGroupCache ( ) | Remove all entries from the group cache | |
| _debug ( string | Exception $message, integer $err, integer $line ) | Wrapper around msg() but outputs only when debug is enabled | |
| _debugSQL ( string $sql, array $params, boolean $htmlescape = true ) : string | create an approximation of the SQL string with parameters replaced | |
| _deleteUser ( string $user ) : boolean | Delete a user after removing all their group memberships | |
| _joinGroup ( array $userdata, array $groupdata ) : boolean | Adds the user to the group | |
| _leaveGroup ( array $userdata, array $groupdata ) : boolean | Removes the user from the group | |
| _query ( string $sql, array $arguments = [] ) : array | integer | boolean | Executes a query | |
| _selectGroups ( ) : array | boolean | Select all available groups | |
| _selectUser ( string $user ) : boolean | array | Select data of a specified user | |
| _selectUserGroups ( array $userdata ) : array | boolean | Select all groups of a user |
| protected _deleteUser ( string $user ) : boolean | ||
| $user | string | |
| 리턴 | boolean | true when the user was deleted |
| protected _query ( string $sql, array $arguments = [] ) : array | integer | boolean | ||
| $sql | string | The SQL statement to execute |
| $arguments | array | Named parameters to be used in the statement |
| 리턴 | array | integer | boolean | The result as associative array for SELECTs, affected rows for others, false on error |
| protected _selectGroups ( ) : array | boolean | ||
| 리턴 | array | boolean | list of all available groups and their properties |
| public deleteUsers ( array $users ) : integer | ||
| $users | array | |
| 리턴 | integer | number of users deleted |
| public getUserCount ( array $filter = [] ) : integer | ||
| $filter | array | array of field/pattern pairs, empty array for no filter |
| 리턴 | integer | |
| public retrieveUsers ( integer $start, integer $limit, array $filter = null ) : array | ||
| $start | integer | index of first user to be returned |
| $limit | integer | max number of users to be returned |
| $filter | array | array of field/pattern pairs, null for no filter |
| 리턴 | array | list of userinfo (refer getUserData for internal userinfo details) |