Class: LiveUser_Perm_Storage_DB

Source Location: /LiveUser-0.16.5/Perm/Storage/DB.php

Class Overview

LiveUser_Perm_Storage
   |
   --LiveUser_Perm_Storage_SQL
      |
      --LiveUser_Perm_Storage_DB

DB container for permission handling

Author(s):

Lukas Smith <smith at pooteeweet.org>
Bjoern Kraus <krausbn at php.net>

Version:

Release: @package_version@

Copyright:

2002-2005 Markus Wolff

Inherited Variables

Class: LiveUser_Perm_Storage_SQL

LiveUser_Perm_Storage_SQL::$prefix

Class: LiveUser_Perm_Storage

LiveUser_Perm_Storage::$alias
LiveUser_Perm_Storage::$fields
LiveUser_Perm_Storage::$tables

Inherited Methods

Class: LiveUser_Perm_Storage_SQL

LiveUser_Perm_Storage_SQL::disconnect(): Properly disconnect from database

Class: LiveUser_Perm_Storage

LiveUser_Perm_Storage::LiveUser_Perm_Storage(): Constructor
LiveUser_Perm_Storage::disconnect(): properly disconnect from resources
LiveUser_Perm_Storage::freeze(): store all properties in an array
LiveUser_Perm_Storage::init()
LiveUser_Perm_Storage::mapUser()
LiveUser_Perm_Storage::readAreaAdminAreas()
LiveUser_Perm_Storage::readGroupRights(): Reads the group rights and put them in the array
LiveUser_Perm_Storage::readSubGroups()
LiveUser_Perm_Storage::readUserRights(): Reads all rights of current user into a two-dimensional associative array, having the area names as the key of the 1st dimension.
LiveUser_Perm_Storage::unfreeze(): Reinitializes properties

Class Details

[line 78]
DB container for permission handling

This is a PEAR::DB backend driver for the LiveUser class. A PEAR::DB connection object can be passed to the constructor to reuse an existing connection. Alternatively, a DSN can be passed to open a new one.

Requirements:

File "Liveuser.php" (contains the parent class "LiveUser")
Array of connection options or a PEAR::DB connection object must be passed to the constructor. Example: array('dsn' => 'mysql://user:pass@host/db_name') OR &$conn (PEAR::DB connection object)

Author: Lukas Smith <smith@pooteeweet.org>
Author: Bjoern Kraus <krausbn@php.net>
Version: $Id: DB.php,v 1.20 2005/08/16 08:53:08 lsmith Exp $
Version: Release: @package_version@
Copyright: 2002-2005 Markus Wolff
Link: http://pear.php.net/LiveUser
License: http://www.gnu.org/licenses/lgpl.txt

[ Top ]

Method Detail

init [line 89]

boolean init(
array
&$storageConf)

Return: true on success, false on failure.
Access: public

Overrides LiveUser_Perm_Storage::init() (parent method not documented)

Parameters:

array &$storageConf — Array with the storage configuration

[ Top ]

mapUser [line 126]

mixed mapUser(
int
$auth_user_id, string
$containerName)

Returns the perm userid from an auth userid and a container name.

Return: array or false on failure
Access: public

Overrides LiveUser_Perm_Storage::mapUser() (parent method not documented)

Parameters:

int	`$auth_user_id`	—
string	`$containerName`	—

[ Top ]

readAreaAdminAreas [line 198]

mixed readAreaAdminAreas(
int
$perm_user_id)

Fetch all the rights for every area where the user is an area admin.

Return: array or false on failure
Access: public

Overrides LiveUser_Perm_Storage::readAreaAdminAreas() (parent method not documented)

Parameters:

int $perm_user_id —

[ Top ]

readGroupRights [line 279]

mixed readGroupRights(
array
$group_ids)

Reads the group rights and put them in the array

right => 1

Return: array or false on failure
Access: public

Overrides LiveUser_Perm_Storage::readGroupRights() (Reads the group rights and put them in the array)

Parameters:

array $group_ids — array with id's for the groups that rights will be read from

[ Top ]

readImpliedRights [line 400]

mixed readImpliedRights(
array
$currentRights, string
$currentLevel)

Fetch rights implied by other rights.

For instance you may have "write" implies "read" so whenever you affect "write" the user will also have the "read" right.

Return: array or false on failure
Access: public

Parameters:

array	`$currentRights`	—
string	`$currentLevel`	—

[ Top ]

readImplyingRights [line 357]

mixed readImplyingRights(
array
$rightIds, string
$table)

Return: array or false on failure
Access: public

Parameters:

array	`$rightIds`	—
string	`$table`	—

[ Top ]

readSubGroups [line 313]

mixed readSubGroups(
array
$group_ids, array
$newGroupIds)

Return: array or false on failure
Access: public

Overrides LiveUser_Perm_Storage::readSubGroups() (parent method not documented)

Parameters:

array	`$group_ids`	—
array	`$newGroupIds`	—

[ Top ]

readUserRights [line 164]

mixed readUserRights(
int
$perm_user_id)

Reads all rights of current user into a two-dimensional associative array, having the area names as the key of the 1st dimension.

Group rights and invididual rights are being merged in the process.

Return: array of false on failure
Access: public

Overrides LiveUser_Perm_Storage::readUserRights() (Reads all rights of current user into a two-dimensional associative array, having the area names as the key of the 1st dimension.)

Parameters:

int $perm_user_id —

[ Top ]