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

Class: LiveUser_Perm_Storage

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

Class Overview


Abstraction class for all the storage containers


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2002-2005 Markus Wolff

Variables

Methods


Child classes:

LiveUser_Perm_Storage_XML
XML container for permission handling
LiveUser_Perm_Storage_SQL
SQL 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 80]

  • Access: public

Type:   array


[ Top ]

$fields = array()

[line 73]

  • Access: public

Type:   array


[ Top ]

$tables = array()

[line 66]

  • Access: public

Type:   array


[ Top ]



Method Detail

LiveUser_Perm_Storage (Constructor)   [line 89]

void LiveUser_Perm_Storage( mixed 0)

Constructor
  • Access: protected

Parameters:

mixed   0   —  configuration array

[ Top ]

disconnect   [line 253]

void disconnect( )

properly disconnect from resources
  • Access: public

Overridden in child classes as:

LiveUser_Perm_Storage_XML::disconnect()
properly disconnect from resources
LiveUser_Perm_Storage_SQL::disconnect()
Properly disconnect from database
LiveUser_Perm_Storage_Cache::disconnect()
properly disconnect from resources

[ Top ]

freeze   [line 226]

array freeze( string $sessionName, array $propertyValues)

store all properties in an array
  • Return: containing the property values
  • Access: public

Parameters:

string   $sessionName   —  name of the session in use.
array   $propertyValues   — 

[ Top ]

init   [line 103]

boolean init( array &$storageConf)

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

Overridden in child classes as:

LiveUser_Perm_Storage_XML::init()
LiveUser_Perm_Storage_MDB2::init()
LiveUser_Perm_Storage_MDB::init()
LiveUser_Perm_Storage_DB::init()
LiveUser_Perm_Storage_Cache::init()

Parameters:

array   &$storageConf   —  Array with the storage configuration

[ Top ]

mapUser   [line 143]

mixed mapUser( int $auth_user_id, string $containerName)

  • Return: array or false on failure
  • Access: public

Overridden in child classes as:

LiveUser_Perm_Storage_XML::mapUser()
LiveUser_Perm_Storage_MDB2::mapUser()
LiveUser_Perm_Storage_MDB::mapUser()
LiveUser_Perm_Storage_DB::mapUser()
Returns the perm userid from an auth userid and a container name.
LiveUser_Perm_Storage_Cache::mapUser()

Parameters:

int   $auth_user_id   — 
string   $containerName   — 

[ Top ]

readAreaAdminAreas   [line 171]

mixed readAreaAdminAreas( int $perm_user_id)

  • Return: array or false on failure
  • Access: public

Overridden in child classes as:

LiveUser_Perm_Storage_MDB2::readAreaAdminAreas()
LiveUser_Perm_Storage_MDB::readAreaAdminAreas()
LiveUser_Perm_Storage_DB::readAreaAdminAreas()
Fetch all the rights for every area where the user is an area admin.
LiveUser_Perm_Storage_Cache::readAreaAdminAreas()

Parameters:

int   $perm_user_id   — 

[ Top ]

readGroupRights   [line 200]

mixed readGroupRights( array $group_ids)

Reads the group rights and put them in the array

right => 1

  • Return: MDB2_Error on failure or nothing
  • Access: public

Overridden in child classes as:

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_DB::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:

array   $group_ids   — 

[ Top ]

readSubGroups   [line 213]

mixed readSubGroups( array $group_ids, array $newGroupIds)

  • Return: array or false on failure
  • Access: public

Overridden in child classes as:

LiveUser_Perm_Storage_MDB2::readSubGroups()
LiveUser_Perm_Storage_MDB::readSubGroups()
LiveUser_Perm_Storage_DB::readSubGroups()
LiveUser_Perm_Storage_Cache::readSubGroups()

Parameters:

array   $group_ids   — 
array   $newGroupIds   — 

[ Top ]

readUserRights   [line 159]

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

Overridden in child classes as:

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_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_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_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   — 

[ Top ]

unfreeze   [line 240]

array unfreeze( $sessionName, array $propertyValues)

Reinitializes properties
  • Access: public

Parameters:

array   $propertyValues   — 
   $sessionName   — 

[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:16:42 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.