Class: LiveUser_Admin_Perm_Medium

Source Location: /LiveUser_Admin-0.3.3/Perm/Medium.php

Class Overview

LiveUser_Admin_Perm_Simple
   |
   --LiveUser_Admin_Perm_Medium

Medium container for permission handling

Author(s):

dufuz at php.net>
Markus Wolff <wolff at 21st.de>
Bjoern Kraus <krausbn at php.net>

Version:

Release: @package_version@

Copyright:

2002-2005 Markus Wolff

Methods

Child classes:

LiveUser_Admin_Perm_Complex: Complex permission administration class

Inherited Variables

Class: LiveUser_Admin_Perm_Simple

LiveUser_Admin_Perm_Simple::$selectable_tables
LiveUser_Admin_Perm_Simple::$withFieldMethodMap

Inherited Methods

Class: LiveUser_Admin_Perm_Simple

LiveUser_Admin_Perm_Simple::LiveUser_Admin_Perm_Simple(): Class constructor. Feel free to override in backend subclasses.
LiveUser_Admin_Perm_Simple::addApplication(): Add application
LiveUser_Admin_Perm_Simple::addArea(): Add area
LiveUser_Admin_Perm_Simple::addRight(): Add right
LiveUser_Admin_Perm_Simple::addTranslation(): Add translation
LiveUser_Admin_Perm_Simple::addUser(): Add user
LiveUser_Admin_Perm_Simple::disconnect(): properly disconnect from resources
LiveUser_Admin_Perm_Simple::getApplications(): Fetches applications
LiveUser_Admin_Perm_Simple::getAreas(): Fetches areas
LiveUser_Admin_Perm_Simple::getCurrentApplication(): Get current application
LiveUser_Admin_Perm_Simple::getRights(): Fetches rights
LiveUser_Admin_Perm_Simple::getTranslations(): Fetches translations
LiveUser_Admin_Perm_Simple::getUsers(): Fetches users
LiveUser_Admin_Perm_Simple::grantUserRight(): Grant user a right
LiveUser_Admin_Perm_Simple::init(): Load the storage container
LiveUser_Admin_Perm_Simple::outputRightsConstants(): Generate the constants to a file or define them directly.
LiveUser_Admin_Perm_Simple::removeApplication(): Remove application(s)
LiveUser_Admin_Perm_Simple::removeArea(): Removes all areas define in the filter as well as any rights assigned to that area.
LiveUser_Admin_Perm_Simple::removeRight(): Remove right
LiveUser_Admin_Perm_Simple::removeTranslation(): Remove translation(s)
LiveUser_Admin_Perm_Simple::removeUser(): Remove user
LiveUser_Admin_Perm_Simple::revokeUserRight(): Revoke (remove) right(s) from the user(s)
LiveUser_Admin_Perm_Simple::setCurrentApplication(): Set current application
LiveUser_Admin_Perm_Simple::updateApplication(): Update application(s)
LiveUser_Admin_Perm_Simple::updateArea(): Update area(s)
LiveUser_Admin_Perm_Simple::updateRight(): Update right
LiveUser_Admin_Perm_Simple::updateTranslation(): Update translation(s)
LiveUser_Admin_Perm_Simple::updateUser(): Update usr
LiveUser_Admin_Perm_Simple::updateUserRight(): Update right(s) for the given user(s)

Class Details

[line 90]
Medium container for permission handling

This class provides a set of functions for implementing a user permission management system on live websites. All authorisation backends/containers must be extensions of this base class.

Author: dufuz@php.net>
Author: Markus Wolff <wolff@21st.de>
Author: Bjoern Kraus <krausbn@php.net>
Version: Release: @package_version@
Copyright: 2002-2005 Markus Wolff
Link: http://pear.php.net/LiveUser_Admin
License: http://www.gnu.org/licenses/lgpl.txt

[ Top ]

Method Detail

LiveUser_Admin_Perm_Medium (Constructor) [line 99]

void LiveUser_Admin_Perm_Medium(
mixed
0)

Constructor

Access: protected

Parameters:

mixed 0 — configuration array

[ Top ]

addGroup [line 117]

void addGroup(
array
$data)

Adds a group

Access: public

Parameters:

array $data —

[ Top ]

addUserToGroup [line 252]

void addUserToGroup(
array
$data)

Adds a user to a group

Access: public

Parameters:

array $data —

[ Top ]

getGroups [line 349]

void getGroups(
[array
$params = array()])

Fetches group(s)

Access: public

Overridden in child classes as:

LiveUser_Admin_Perm_Complex::getGroups(): Get groups

Parameters:

array $params —

[ Top ]

grantGroupRight [line 184]

void grantGroupRight(
array
$data)

Grants a group X rights

Access: public

Overridden in child classes as:

LiveUser_Admin_Perm_Complex::grantGroupRight(): Grant Group Rights

Parameters:

array $data —

[ Top ]

removeGroup [line 153]

void removeGroup(
array
$filters)

Removes group(s)

Access: public
Uses: LiveUser_Admin_Perm_Medium::removeUserFromGroup - LiveUser_Admin_Perm_Medium::revokeGroupRight

Overridden in child classes as:

LiveUser_Admin_Perm_Complex::removeGroup(): Removes groups, can remove subgroups recursively if option recursive is passed on as true.

Parameters:

array $filters — Array containing the filters on what group(s) should be removed

[ Top ]

removeRight [line 298]

void removeRight(
array
$filters)

Removes right(s)

Access: public
Uses: LiveUser_Admin_Perm_Simple::removeRight - LiveUser_Admin_Perm_Medium::revokeGroupRight

Overridden in child classes as:

LiveUser_Admin_Perm_Complex::removeRight(): Remove Right

Overrides LiveUser_Admin_Perm_Simple::removeRight() (Remove right)

Parameters:

array $filters — Array containing the filters on what right(s) should be removed

[ Top ]

removeUser [line 325]

void removeUser(
array
$filters)

Removes user(s)

Access: public
Uses: LiveUser_Admin_Perm_Simple::removeUser - LiveUser_Admin_Perm_Medium::removeUserFromGroup

Overridden in child classes as:

LiveUser_Admin_Perm_Complex::removeUser(): Remove User

Overrides LiveUser_Admin_Perm_Simple::removeUser() (Remove user)

Parameters:

array $filters — Array containing the filters on what user(s) should be removed

[ Top ]

removeUserFromGroup [line 279]

void removeUserFromGroup(
array
$filters)

Removes user(s) from group(s)

Access: public

Parameters:

array $filters — Array containing the filters on what user(s) should be removed from what group(s)

[ Top ]

revokeGroupRight [line 237]

void revokeGroupRight(
array
$filters)

Revokes (removes) right(s) from group(s)

Access: public

Parameters:

array $filters — Array containing the filters on what right(s) should be removed from what group(s)

[ Top ]

updateGroup [line 134]

void updateGroup(
array
$data, array
$filters)

Update group(s)

Access: public

Parameters:

array	`$data`	—
array	`$filters`	—

[ Top ]

updateGroupRight [line 220]

void updateGroupRight(
array
$data, array
$filters)

Updates group(s) right(s)

Access: public

Parameters:

array	`$data`	—
array	`$filters`	—

[ Top ]