Public Member Functions |
|
| __construct ($adminuserObj, $parentObj) | |
| __get ($varName) | |
| __set ($varName, $varValue) | |
| addParentGroup ($parentGroup) | |
| getAdminUserObj () | |
| getEffectivePermissions ($domain=null) | |
| getPermissions ($domain=null) | |
| getSessionObj () | |
| listAvailableDomains () | |
| listParents () | |
| removeParentGroup ($parentGroup) | |
| savePermissions ($permissions) | |
Member Function Documentation
| AdminUser::__get | ( | $ | varName | ) |
Get member.
|
member |
description |
|---|---|
|
name |
user name |
|
description |
user description |
| AdminUser::__set | ( | $ | varName, | |
| $ | varValue | |||
| ) |
Set member.
|
member |
description |
|---|---|
|
name |
user name |
|
description |
user description |
| AdminUser::addParentGroup | ( | $ | parentGroup | ) |
Adds a new parent group
- Returns:
- bool
- Parameters:
-
$parentGroup string the parent group that you want to add
| AdminUser::getEffectivePermissions | ( | $ | domain = null |
) |
Returns an object with all the effective permissions loaded. Note: the returned object is read only, use getPermissions if you need to grant, deny or revoke rights
- Returns:
- object Permissions
- Parameters:
-
$domain string the domain name from where the permission will be loaded, if it's null the server permissions will be loaded (this parameter is optional - server is default)
| AdminUser::getPermissions | ( | $ | domain = null |
) |
Returns an object with all the server/domain permissions loaded. Note: the returned object is writable (you can use deny, revoke, grant calls on it).
- Returns:
- object Permissions
- Parameters:
-
$domain string the domain name from where the permission will be loaded, if it's null the server permissions will be loaded (this parameter is optional - server is default)
| AdminUser::listAvailableDomains | ( | ) |
Returns an array with all the available domains
- Returns:
- array
| AdminUser::listParents | ( | ) |
Returns an array with all user's parents
- Returns:
- array
| AdminUser::removeParentGroup | ( | $ | parentGroup | ) |
this method removes a parent group
- Returns:
- bool
- Parameters:
-
$parentGroup string the parent group that you want to remove
| AdminUser::savePermissions | ( | $ | permissions | ) |
Save admin user permissions.