Class: LiveUser_Admin_Perm_Container_MDB2_Simple
Source Location: /LiveUser-0.13.0/Admin/Perm/Container/MDB2_Simple.php
LiveUser_Admin_Perm_Common
|
--LiveUser_Admin_Perm_Container_MDB2_Simple
Container for simple rights managements.
Author(s):
Version:
- $Id: MDB2_Simple.php,v 1.35 2004/08/28 15:46:37 lsmith Exp $
|
|
Child classes:
|
Inherited Variables
|
Inherited Methods
|
Class Details
Method Detail
LiveUser_Admin_Perm_Container_MDB2_Simple (Constructor) [line 45]
void LiveUser_Admin_Perm_Container_MDB2_Simple(
array
&$connectOptions)
|
|
Constructor
Parameters:
addApplication [line 534]
mixed addApplication(
[string
$define_name = null], [string
$application_name = null], [string
$application_description = null])
|
|
Add an application
Parameters:
addArea [line 585]
mixed addArea(
string
$applicationId, [string
$define_name = null], [string
$area_name = null], [string
$area_description = null])
|
|
Add an area
Parameters:
addLanguage [line 385]
mixed addLanguage(
string
$two_letter_code, string
$language_name, [string
$language_description = null])
|
|
Add a new language
Parameters:
addRight [line 857]
mixed addRight(
integer
$areaId, [string
$define_name = null], [string
$right_name = null], [string
$right_description = null])
|
|
Add a right in special area
Parameters:
addTranslation [line 224]
mixed addTranslation(
integer
$sectionId, integer
$section_type, string
$language, string
$name, [string
$description = null])
|
|
Assigns name (and description) in specified language to a section
Parameters:
addUser [line 1001]
mixed addUser(
string
$authId,
$authName, [int
$type = LIVEUSER_USER_TYPE_ID], [mixed
$permId = null], string
$authname)
|
|
Add a user
Overrides LiveUser_Admin_Perm_Common::addUser() (Adds a new user to Perm.)
Parameters:
addUserAreaAdmin [line 1586]
mixed addUserAreaAdmin(
mixed
$permId, int
$areaId)
|
|
Make a user an admin of a given area.
Parameters:
getApplications [line 1252]
mixed getApplications(
[array
$options = null])
|
|
Get list of all applications This method accepts the following options... 'where_application_id' = [APPLICATION_ID]
Parameters:
getAreas [line 1299]
mixed getAreas(
[array
$options = null])
|
|
Get list of all areas within a given application This method accepts the following options... 'where_area_id' = [AREA_ID], 'where_application_id' = [APPLICATION_ID], 'with_applications' = [BOOLEAN]
Parameters:
getAuthUserId [line 113]
getCurrentApplication [line 208]
string getCurrentApplication(
)
|
|
Get current application
getCurrentLanguage [line 183]
string getCurrentLanguage(
)
|
|
Get current language
getLanguages [line 1363]
mixed getLanguages(
[array
$options = null])
|
|
Get list of all languages This method accepts the following options... 'where_language_id' = [LANGUAGE_ID], 'with_translations' = [BOOLEAN]
Parameters:
getPermUserId [line 90]
getRights [line 1442]
mixed getRights(
[array
$options = null])
|
|
Get list of all rights This method accepts the following options... 'where_user_id' = [AUTH_USER_ID], 'where_group_id' = [GROUP_ID], 'where_right_id' = [RIGHT_ID], 'where_area_id' = [AREA_ID], 'where_application_id' = [APPLICATION_ID], 'with_areas' = [BOOLEAN], 'with_applications' = [BOOLEAN]
Overridden in child classes as:
- LiveUser_Admin_Perm_Container_MDB2_Complex::getRights()
- Get list of all rights
Parameters:
getTranslation [line 353]
mixed getTranslation(
integer
$sectionId, integer
$section_type)
|
|
Get name (and description) of the [section] in specified language
Parameters:
getUsers [line 1661]
mixed getUsers(
[array
$filters = array()], [boolean
$options = array()], [boolean
$rekey = false])
|
|
Fetch users from the database. The only supported filter is perm_user_id => 'value' The array will look like this: $userData[0]['perm_user_id'] = 1;
['type'] = 1;
['container'] = '';
['rights'] = array(); // the array returned by getRights()
Overrides LiveUser_Admin_Perm_Common::getUsers() (Gets all perm_user_id, type, container and rights)
Parameters:
grantUserRight [line 1147]
removeApplication [line 635]
mixed removeApplication(
integer
$applicationId)
|
|
Delete an application
Parameters:
removeArea [line 695]
mixed removeArea(
integer
$areaId)
|
|
Delete an area
Parameters:
removeLanguage [line 446]
mixed removeLanguage(
integer
$language)
|
|
Remove a language
Parameters:
removeRight [line 908]
removeTranslation [line 313]
mixed removeTranslation(
integer
$sectionId, integer
$section_type, string
$language, [boolean
$recursive = false])
|
|
Remove name (and description) of the [section] in specified language
Parameters:
removeUser [line 1086]
removeUserAreaAdmin [line 1617]
mixed removeUserAreaAdmin(
mixed
$permId, [int
$areaId = null])
|
|
Remove the privilege of being an admin. If no area_id is provided the user will be removed asan admin from all areas he was an admin for.
Parameters:
revokeUserRight [line 1221]
mixed revokeUserRight(
string
$permId, [integer
$rightId = null])
|
|
Revoke right from user
Parameters:
setCurrentApplication [line 195]
boolean setCurrentApplication(
integer
$applicationId)
|
|
Set current application
Parameters:
setCurrentLanguage [line 160]
mixed setCurrentLanguage(
string
$language)
|
|
Set current language Returns false if the language is not known
Parameters:
updateApplication [line 767]
mixed updateApplication(
integer
$applicationId, [string
$define_name = null], [string
$application_name = null], [string
$application_description = null])
|
|
Update an application
Parameters:
updateArea [line 811]
mixed updateArea(
integer
$areaId, int
$applicationId, [string
$define_name = null], [string
$area_name = null], [string
$area_description = null])
|
|
Update an area
Parameters:
updateLanguage [line 493]
mixed updateLanguage(
integer
$language, string
$language_name, [string
$language_description = null])
|
|
Update language
Parameters:
updateRight [line 957]
mixed updateRight(
integer
$rightId, integer
$areaId, [string
$define_name = null], [string
$right_name = null], [string
$right_description = null])
|
|
Update a right
Parameters:
updateTranslation [line 270]
mixed updateTranslation(
integer
$sectionId, integer
$section_type, string
$language, string
$name, [string
$description = null])
|
|
Updates name (and description) of [section] in specified language
Parameters:
updateUser [line 1043]
mixed updateUser(
int
$permId, [mixed
$authId = false], [mixed
$authName = false], [mixed
$type = false])
|
|
Updates auth_user_id in the mapping table.
Parameters:
updateUserRight [line 1193]
mixed updateUserRight(
string
$permId, integer
$rightId, integer
$right_level)
|
|
Update right level of userRight
Parameters:
Documentation generated on Mon, 11 Mar 2019 13:56:18 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|