Class: LiveUser_Perm_Container_XML_Simple

Source Location: /LiveUser-0.13.0/Perm/Container/XML/Simple.php

Class Overview

LiveUser_Perm_Common
   |
   --LiveUser_Perm_Container_XML_Simple

Simple XML-based complexity driver for LiveUser.

Author(s):

krausbn at php.net>

Version:

$Id: Simple.php,v 1.2 2004/07/31 08:15:28 lsmith Exp $

Variables

$init_ok

Methods

Inherited Variables

Class: LiveUser_Perm_Common

LiveUser_Perm_Common::$groupIds
LiveUser_Perm_Common::$groupRights
LiveUser_Perm_Common::$ondemand
LiveUser_Perm_Common::$permUserId
LiveUser_Perm_Common::$rights
LiveUser_Perm_Common::$userRights
LiveUser_Perm_Common::$userType

Inherited Methods

Class: LiveUser_Perm_Common

LiveUser_Perm_Common::LiveUser_Perm_Common(): Class constructor. Feel free to override in backend subclasses.
LiveUser_Perm_Common::checkLevel(): Checks if the current user has a certain right in a given area at the necessary level.
LiveUser_Perm_Common::checkRight(): Checks if the current user has a certain right in a given area.
LiveUser_Perm_Common::disconnect(): properly disconnect from resources
LiveUser_Perm_Common::freeze(): store all properties in an array
LiveUser_Perm_Common::getProperty(): Function returns the inquired value if it exists in the class.
LiveUser_Perm_Common::getRights(): Returns a one-dimensional array with all rights assigned
LiveUser_Perm_Common::init(): Tries to find the user with the given user ID in the permissions container. Will read all permission data and return true on success.
LiveUser_Perm_Common::readGroupRights(): Reads all individual rights of current user into a two-dimensional array of this format: "GroupName" => "AreaName" -> "RightName"
LiveUser_Perm_Common::readRights(): 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_Common::readUserRights(): Reads all individual rights of current user into a two-dimensional array of this format: AreaName => RightName -> Value
LiveUser_Perm_Common::unfreeze(): Reinitializes properties
LiveUser_Perm_Common::userExists(): Checks if a user with the given perm_user_id exists in the permission container and returns true on success.

Class Details

[line 45]
Simple XML-based complexity driver for LiveUser.

Description: The XML_Simple provides the following functionalities

users
userrights

Author: krausbn@php.net>
Version: $Id: Simple.php,v 1.2 2004/07/31 08:15:28 lsmith Exp $

[ Top ]

Class Variables

$init_ok = false

[line 81]

Indicates if backend module initialized correctly. If yes,

true, if not false. Backend module won't initialize if the init value (usually an object or resource handle that identifies the backend to be used) is not of the required type.

Access: public

Type:

boolean

[ Top ]

Method Detail

LiveUser_Perm_Container_XML_Simple (Constructor) [line 90]

void &LiveUser_Perm_Container_XML_Simple(
mixed
&$connectOptions)

Constructor

Access: protected

Parameters:

mixed &$connectOptions — configuration array

[ Top ]

disconnect [line 171]

void disconnect(
)

properly disconnect from resources

Access: public

Overrides LiveUser_Perm_Common::disconnect() (properly disconnect from resources)

[ Top ]

init [line 135]

boolean init(
string
$uid)

Tries to find the user with the given user ID in the permissions container. Will read all permission data and return true on success.

Return: true on success or false on failure
Access: public

Overrides LiveUser_Perm_Common::init() (Tries to find the user with the given user ID in the permissions container. Will read all permission data and return true on success.)

Parameters:

string $uid — user identifier

[ Top ]

readRights [line 212]

void readRights(
)

Reads all rights of current user into an associative array.

Right => 1

Access: public

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

[ Top ]

userExists [line 185]

boolean userExists(
integer
$user_id)

Checks if a user with the given perm_user_id exists in the permission container and returns true on success.

Return: true if the id was found, else false.
Access: public

Overrides LiveUser_Perm_Common::userExists() (Checks if a user with the given perm_user_id exists in the permission container and returns true on success.)

Parameters:

integer $user_id — The users id in the permission table.

[ Top ]