Class: LiveUser_Perm_Storage_DB

Source Location: /LiveUser-0.16.14/LiveUser/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-2006 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 resources

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 the session and return them as an array
LiveUser_Perm_Storage::init(): Initialize the storage container
LiveUser_Perm_Storage::mapUser(): map an auth user to a perm user
LiveUser_Perm_Storage::readAreaAdminAreas(): read the areas in which a user is an area admin
LiveUser_Perm_Storage::readGroupRights(): Reads the group rights and put them in the array
LiveUser_Perm_Storage::readGroups(): Reads all the group ids in that the user is also a member of (all groups that are subgroups of these are also added recursively)
LiveUser_Perm_Storage::readImpliedRights(): Read out the implied rights with a given level from the implied_rights table
LiveUser_Perm_Storage::readImplyingRights(): Read out the rights from the userrights or grouprights table that imply other rights along with their level
LiveUser_Perm_Storage::readSubGroups(): Read the sub groups of the new groups that are not part of the group ids
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 304421 2010-10-15 13:30:56Z clockwerx $
Version: Release: @package_version@
Copyright: 2002-2006 Markus Wolff
Link: http://pear.php.net/LiveUser
License: http://www.gnu.org/licenses/lgpl.txt

[ Top ]

Method Detail

init [line 88]

bool init(
array
&$storageConf)

Initialize the storage container

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

Overrides LiveUser_Perm_Storage::init() (Initialize the storage container)

Parameters:

array &$storageConf — Array with the storage configuration

[ Top ]

mapUser [line 122]

array mapUser(
int
$auth_user_id, string
$containerName)

map an auth user to a perm user

Return: requested data or false on failure
Access: public

Overrides LiveUser_Perm_Storage::mapUser() (map an auth user to a perm user)

Parameters:

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

[ Top ]

readAreaAdminAreas [line 191]

array readAreaAdminAreas(
int
$perm_user_id)

read the areas in which a user is an area admin

Return: requested data or false on failure
Access: public

Overrides LiveUser_Perm_Storage::readAreaAdminAreas() (read the areas in which a user is an area admin)

Parameters:

int $perm_user_id — perm user id

[ Top ]

readGroupRights [line 270]

array readGroupRights(
int
$group_ids)

Reads the group rights and put them in the array

right => 1

Return: requested data or false on failure
Access: public

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

Parameters:

int $group_ids — group ids

[ Top ]

readGroups [line 228]

array readGroups(
int
$perm_user_id)

Reads all the group ids in that the user is also a member of (all groups that are subgroups of these are also added recursively)

Return: requested data or false on failure
See: readRights()
Access: public

Overrides LiveUser_Perm_Storage::readGroups() (Reads all the group ids in that the user is also a member of (all groups that are subgroups of these are also added recursively))

Parameters:

int $perm_user_id — perm user id

[ Top ]

readImpliedRights [line 388]

array readImpliedRights(
array
$currentRights, string
$currentLevel)

Read out the implied rights with a given level from the implied_rights table

Return: requested data or false on failure
Access: public

Overrides LiveUser_Perm_Storage::readImpliedRights() (Read out the implied rights with a given level from the implied_rights table)

Parameters:

array	`$currentRights`	—	current right ids
string	`$currentLevel`	—	current level

[ Top ]

readImplyingRights [line 349]

array readImplyingRights(
array
$rightIds, string
$table)

Read out the rights from the userrights or grouprights table that imply other rights along with their level

Return: requested data or false on failure
Access: public

Overrides LiveUser_Perm_Storage::readImplyingRights() (Read out the rights from the userrights or grouprights table that imply other rights along with their level)

Parameters:

array	`$rightIds`	—	right ids
string	`$table`	—	name of the table

[ Top ]

readSubGroups [line 304]

array readSubGroups(
array
$group_ids, array
$newGroupIds)

Read the sub groups of the new groups that are not part of the group ids

Return: requested data or false on failure
Access: public

Overrides LiveUser_Perm_Storage::readSubGroups() (Read the sub groups of the new groups that are not part of the group ids)

Parameters:

array	`$group_ids`	—	group ids
array	`$newGroupIds`	—	new group ids

[ Top ]

readUserRights [line 160]

array 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: requested data or 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 — perm user id

[ Top ]