LiveUser
[ class tree: LiveUser ] [ index: LiveUser ] [ all elements ]

Class: LiveUser_Perm_Storage

Source Location: /LiveUser-0.16.14/LiveUser/Perm/Storage.php

Class Overview


Abstraction class for all the storage containers


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2002-2006 Markus Wolff

Variables

Methods


Child classes:

LiveUser_Perm_Storage_SQL
SQL container for permission handling
LiveUser_Perm_Storage_XML
XML container for permission handling
LiveUser_Perm_Storage_Cache
Cache container for permission handling

Inherited Variables

Inherited Methods


Class Details

[line 59]
Abstraction class for all the storage containers


[ Top ]


Class Variables

$alias = array()

[line 83]

All fields with their alias
  • Access: public

Type:   array


[ Top ]

$fields = array()

[line 75]

All fields with their types
  • Access: public

Type:   array


[ Top ]

$tables = array()

[line 67]

Table configuration
  • Access: public

Type:   array


[ Top ]



Method Detail

LiveUser_Perm_Storage (Constructor)   [line 92]

void LiveUser_Perm_Storage( mixed 0)

Constructor
  • Access: protected

Parameters:

mixed   0     configuration array

[ Top ]

disconnect   [line 307]

bool disconnect( )

properly disconnect from resources
  • Return: true on success and false on failure
  • Access: public

Overridden in child classes as:

LiveUser_Perm_Storage_SQL::disconnect()
properly disconnect from resources
LiveUser_Perm_Storage_PDO::disconnect()
Override the disconnect method from the parent class.
LiveUser_Perm_Storage_XML::disconnect()
properly disconnect from resources
LiveUser_Perm_Storage_Cache::disconnect()
properly disconnect from resources

[ Top ]

freeze   [line 279]

array freeze( string $sessionName, array $propertyValues)

store all properties in the session and return them as an array
  • Return: containing the property values
  • Access: public

Parameters:

string   $sessionName     name of the key to use inside the session
array   $propertyValues     property values

[ Top ]

init   [line 105]

bool init( array &$storageConf)

Initialize the storage container
  • Return: true on success, false on failure.
  • Access: public

Overridden in child classes as:

LiveUser_Perm_Storage_DB::init()
Initialize the storage container
LiveUser_Perm_Storage_PDO::init()
Initialize the storage container
LiveUser_Perm_Storage_MDB2::init()
Initialize the storage container
LiveUser_Perm_Storage_MDB::init()
Initialize the storage container
LiveUser_Perm_Storage_XML::init()
Initialize the storage container
LiveUser_Perm_Storage_Cache::init()
Initialize the storage container

Parameters:

array   &$storageConf     Array with the storage configuration

[ Top ]

mapUser   [line 145]

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

Overridden in child classes as:

LiveUser_Perm_Storage_DB::mapUser()
map an auth user to a perm user
LiveUser_Perm_Storage_PDO::mapUser()
map an auth user to a perm user
LiveUser_Perm_Storage_MDB2::mapUser()
map an auth user to a perm user
LiveUser_Perm_Storage_MDB::mapUser()
map an auth user to a perm user
LiveUser_Perm_Storage_XML::mapUser()
map an auth user to a perm user
LiveUser_Perm_Storage_Cache::mapUser()
map an auth user to a perm user

Parameters:

int   $auth_user_id     
string   $containerName     

[ Top ]

readAreaAdminAreas   [line 179]

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

Overridden in child classes as:

LiveUser_Perm_Storage_DB::readAreaAdminAreas()
read the areas in which a user is an area admin
LiveUser_Perm_Storage_PDO::readAreaAdminAreas()
read the areas in which a user is an area admin
LiveUser_Perm_Storage_MDB2::readAreaAdminAreas()
read the areas in which a user is an area admin
LiveUser_Perm_Storage_MDB::readAreaAdminAreas()
read the areas in which a user is an area admin
LiveUser_Perm_Storage_Cache::readAreaAdminAreas()
read the areas in which a user is an area admin

Parameters:

int   $perm_user_id     perm user id

[ Top ]

readGroupRights   [line 214]

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

Overridden in child classes as:

LiveUser_Perm_Storage_DB::readGroupRights()
Reads the group rights and put them in the array
LiveUser_Perm_Storage_PDO::readGroupRights()
Reads the group rights and put them in the array
LiveUser_Perm_Storage_MDB2::readGroupRights()
Reads the group rights and put them in the array
LiveUser_Perm_Storage_MDB::readGroupRights()
Reads the group rights and put them in the array
LiveUser_Perm_Storage_Cache::readGroupRights()
Reads the group rights and put them in the array

Parameters:

int   $group_ids     group ids

[ Top ]

readGroups   [line 196]

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

Overridden in child classes as:

LiveUser_Perm_Storage_DB::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_PDO::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_MDB2::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_MDB::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_Cache::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 263]

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

Overridden in child classes as:

LiveUser_Perm_Storage_DB::readImpliedRights()
Read out the implied rights with a given level from the implied_rights table
LiveUser_Perm_Storage_PDO::readImpliedRights()
Read out the implied rights with a given level from the implied_rights table
LiveUser_Perm_Storage_MDB2::readImpliedRights()
Read out the implied rights with a given level from the implied_rights table
LiveUser_Perm_Storage_MDB::readImpliedRights()
Read out the implied rights with a given level from the implied_rights table
LiveUser_Perm_Storage_Cache::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 247]

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

Overridden in child classes as:

LiveUser_Perm_Storage_DB::readImplyingRights()
Read out the rights from the userrights or grouprights table that imply other rights along with their level
LiveUser_Perm_Storage_PDO::readImplyingRights()
Read out the rights from the userrights or grouprights table that imply other rights along with their level
LiveUser_Perm_Storage_MDB2::readImplyingRights()
Read out the rights from the userrights or grouprights table that imply other rights along with their level
LiveUser_Perm_Storage_MDB::readImplyingRights()
Read out the rights from the userrights or grouprights table that imply other rights along with their level
LiveUser_Perm_Storage_Cache::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 230]

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

Overridden in child classes as:

LiveUser_Perm_Storage_DB::readSubGroups()
Read the sub groups of the new groups that are not part of the group ids
LiveUser_Perm_Storage_PDO::readSubGroups()
Read the sub groups of the new groups that are not part of the group ids
LiveUser_Perm_Storage_MDB2::readSubGroups()
Read the sub groups of the new groups that are not part of the group ids
LiveUser_Perm_Storage_MDB::readSubGroups()
Read the sub groups of the new groups that are not part of the group ids
LiveUser_Perm_Storage_Cache::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 164]

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

Overridden in child classes as:

LiveUser_Perm_Storage_DB::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_PDO::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_MDB2::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_MDB::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_XML::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_Cache::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 ]

unfreeze   [line 293]

array unfreeze( string $sessionName)

Reinitializes properties
  • Access: public

Parameters:

string   $sessionName     name of the key to use inside the session

[ Top ]


Documentation generated on Fri, 15 Oct 2010 15:00:15 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.