Docs For Class LiveUser_Admin_Perm

void LiveUser_Admin_Perm_Simple(
)

Constructor

Access: protected

[ Top ]

int|bool addApplication(
array
$data)

Add an application

Return: false on error, true (or new id) on success
Access: public

Parameters:

array $data — containing atleast the key-value-pairs of all required columns in the applications table

[ Top ]

int|bool addArea(
array
$data)

Add an area

Return: false on error, true (or new id) on success
Access: public

Parameters:

array $data — containing atleast the key-value-pairs of all required columns in the areas table

[ Top ]

int|bool addRight(
array
$data)

Add a right

Return: false on error, true (or new id) on success
Access: public

Parameters:

array $data — containing atleast the key-value-pairs of all required columns in the rights table

[ Top ]

int|bool addTranslation(
array
$data)

Add a translation

Return: false on error, true (or new id) on success
Access: public

Parameters:

array $data — containing atleast the key-value-pairs of all required columns in the users table

[ Top ]

int|bool addUser(
array
$data)

Add a user

Return: false on error, true (or new id) on success
Access: public

Parameters:

array $data — containing atleast the key-value-pairs of all required columns in the perm_users table

[ Top ]

void disconnect(
)

properly disconnect from resources

Access: public

[ Top ]

bool|array getApplications(
[array
$params = array()])

Fetches applications

Return: false on failure or array with selected data
Access: public

Parameters:

array $params — containing key-value pairs for: 'fields' - ordered array containing the fields to fetch if empty all fields from the user table are fetched 'filters' - key values pairs (value may be a string or an array) 'orders' - key value pairs (values 'ASC' or 'DESC') 'rekey' - if set to true, returned array will have the first column as its first dimension 'group' - if set to true and $rekey is set to true, then all values with the same first column will be wrapped in an array 'limit' - number of rows to select 'offset' - first row to select 'select' - determines what query method to use: 'one' -> queryOne, 'row' -> queryRow, 'col' -> queryCol, 'all' ->queryAll (default) 'selectable_tables' - array list of tables that may be joined to in this query, the first element is the root table from which the joins are done

[ Top ]

bool|array getAreas(
[array
$params = array()])

Fetches areas

Return: false on failure or array with selected data
Access: public

Parameters:

array $params — containing key-value pairs for: 'fields' - ordered array containing the fields to fetch if empty all fields from the user table are fetched 'filters' - key values pairs (value may be a string or an array) 'orders' - key value pairs (values 'ASC' or 'DESC') 'rekey' - if set to true, returned array will have the first column as its first dimension 'group' - if set to true and $rekey is set to true, then all values with the same first column will be wrapped in an array 'limit' - number of rows to select 'offset' - first row to select 'select' - determines what query method to use: 'one' -> queryOne, 'row' -> queryRow, 'col' -> queryCol, 'all' ->queryAll (default) 'selectable_tables' - array list of tables that may be joined to in this query, the first element is the root table from which the joins are done

[ Top ]

bool|array getRights(
[array
$params = array()])

Fetches rights

Return: false on failure or array with selected data
Access: public

Overridden in child classes as:

LiveUser_Admin_Perm_Medium::getRights(): Fetches rights

LiveUser_Admin_Perm_Complex::getRights(): Fetches rights

Parameters:

array $params — containing key-value pairs for: 'fields' - ordered array containing the fields to fetch if empty all fields from the user table are fetched 'filters' - key values pairs (value may be a string or an array) 'orders' - key value pairs (values 'ASC' or 'DESC') 'rekey' - if set to true, returned array will have the first column as its first dimension 'group' - if set to true and $rekey is set to true, then all values with the same first column will be wrapped in an array 'limit' - number of rows to select 'offset' - first row to select 'select' - determines what query method to use: 'one' -> queryOne, 'row' -> queryRow, 'col' -> queryCol, 'all' ->queryAll (default) 'selectable_tables' - array list of tables that may be joined to in this query, the first element is the root table from which the joins are done

[ Top ]

bool|array getTranslations(
[array
$params = array()])

Fetches translations

Return: false on failure or array with selected data
Access: public

Parameters:

array $params — containing key-value pairs for: 'fields' - ordered array containing the fields to fetch if empty all fields from the user table are fetched 'filters' - key values pairs (value may be a string or an array) 'orders' - key value pairs (values 'ASC' or 'DESC') 'rekey' - if set to true, returned array will have the first column as its first dimension 'group' - if set to true and $rekey is set to true, then all values with the same first column will be wrapped in an array 'limit' - number of rows to select 'offset' - first row to select 'select' - determines what query method to use: 'one' -> queryOne, 'row' -> queryRow, 'col' -> queryCol, 'all' ->queryAll (default) 'selectable_tables' - array list of tables that may be joined to in this query, the first element is the root table from which the joins are done

[ Top ]

bool|array getUsers(
[array
$params = array()])

Fetches users

Return: false on failure or array with selected data
Access: public

Parameters:

array $params — containing key-value pairs for: 'fields' - ordered array containing the fields to fetch if empty all fields from the user table are fetched 'filters' - key values pairs (value may be a string or an array) 'orders' - key value pairs (values 'ASC' or 'DESC') 'rekey' - if set to true, returned array will have the first column as its first dimension 'group' - if set to true and $rekey is set to true, then all values with the same first column will be wrapped in an array 'limit' - number of rows to select 'offset' - first row to select 'select' - determines what query method to use: 'one' -> queryOne, 'row' -> queryRow, 'col' -> queryCol, 'all' ->queryAll (default) 'selectable_tables' - array list of tables that may be joined to in this query, the first element is the root table from which the joins are done

[ Top ]

void grantUserRight(
array
$data)

Grant user a right

 // grant user id 13 the right NEWS_CHANGE

 $data = array(
      'right_id'     => NEWS_CHANGE,
      'perm_user_id' => 13
 );
 $lua->perm->grantUserRight($data);

Access: public

Parameters:

array $data — containing the perm_user_id and right_id and optionally a right_level

[ Top ]

bool init(
array
&$conf)

Initialize the storage container

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

Parameters:

array &$conf — array containing the configuration.

[ Top ]

bool|array outputRightsConstants(
string
$type, [array
$options = array()], [string
$mode = null])

Generate the constants to a file or define them directly.

$type can be either 'constant' or 'array'. Constant will result in defining constants while array results in defining an array.

$options can contain 'prefix' => prefix for the generated (qualified) names 'area' => specific area id to grab rights from 'application' => specific application id to grab rights from 'filters' => specific set of filters to use (overwrites area/application) 'by_group' => if joins should be done using the 'userrights' (false default) or through the 'grouprights' and 'groupusers' tables (true) 'inherited' => filter array to fetch all rights from (sub)group membership 'implied' => filter array for fetching implied rights 'naming' => LIVEUSER_SECTION_RIGHT for PREFIX_RIGHTNAME <- DEFAULT LIVEUSER_SECTION_AREA for PREFIX_AREANAME_RIGHTNAME LIVEUSER_SECTION_APPLICATION for PREFIX_APPLICATIONNAME_AREANAME_RIGHTNAME 'filename' => if $mode is 'file' you must give the full path for the output file 'varname' => if $mode is 'file' and $type is 'array' you must give the name of the variable to define

If no prefix is given it will not be used to generate the constants/arrays

$mode can either be 'file' or 'direct' and will determine of the constants/arrays will be written to a file, or returned/defined. returned as an array when $type is set to 'array' and defined when $type is set to 'constant'

Return: depending on the type an array with the data or a boolean denoting success or failure
Access: public

Parameters:

string	`$type`	—	type of output ('constant' or 'array')
array	`$options`	—	options for constants generation
string	`$mode`	—	output mode desired ('file' or 'direct')

[ Top ]

int|bool removeApplication(
array
$filters)

Remove applications and all their relevant relations

Return: false on error, the affected rows on success
Access: public

Parameters:

array $filters — key values pairs (value may be a string or an array) This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all applications will be affected by the remove

[ Top ]

int|bool removeArea(
array
$filters)

Remove areas and all their relevant relations

Return: false on error, the affected rows on success
Access: public

Overridden in child classes as:

LiveUser_Admin_Perm_Complex::removeArea(): Remove areas and all their relevant relations

Parameters:

array $filters — key values pairs (value may be a string or an array) This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all areas will be affected by the remove

[ Top ]

int|bool removeRight(
array
$filters)

Remove rights and all their relevant relations

Return: false on error, the affected rows on success
Access: public

Overridden in child classes as:

LiveUser_Admin_Perm_Medium::removeRight(): Remove rights and all their relevant relations

LiveUser_Admin_Perm_Complex::removeRight(): Remove rights and all their relevant relations

Parameters:

array $filters — key values pairs (value may be a string or an array) This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all rights will be affected by the remove

[ Top ]

int|bool removeTranslation(
array
$filters)

Remove translations and all their relevant relations

Return: false on error, the affected rows on success
Access: public

Parameters:

array $filters — key values pairs (value may be a string or an array) This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all translations will be affected by the remove

[ Top ]

int|bool removeUser(
array
$filters)

Remove users and all their relevant relations

Return: false on error, the affected rows on success
Access: public

Overridden in child classes as:

LiveUser_Admin_Perm_Medium::removeUser(): Remove users and all their relevant relations

Parameters:

array $filters — key values pairs (value may be a string or an array) This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all users will be affected by the removed

[ Top ]

int|bool revokeUserRight(
array
$filters)

Revoke (remove) right(s) from the user(s)

Return: false on error, the affected rows on success
Access: public

Parameters:

array $filters — key values pairs (value may be a string or an array) This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all users will be affected by the remove

[ Top ]

int|bool updateApplication(
array
$data, array
$filters)

Update applications

Return: false on error, the affected rows on success
Access: public

Parameters:

array	`$data`	—	containing the key value pairs of columns to update
array	`$filters`	—	key values pairs (value may be a string or an array) This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all applictions will be affected by the update

[ Top ]

int|bool updateArea(
array
$data, array
$filters)

Update areas

Return: false on error, the affected rows on success
Access: public

Parameters:

array	`$data`	—	associative array in the form of $fieldname => $data
array	`$filters`	—	associative array in the form of $fieldname => $data This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all areas will be affected by the update

[ Top ]

int|bool updateRight(
array
$data, array
$filters)

Update rights

Return: false on error, the affected rows on success
Access: public

Parameters:

array	`$data`	—	containing the key value pairs of columns to update
array	`$filters`	—	key values pairs (value may be a string or an array) This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all rights will be affected by the update

[ Top ]

int|bool updateTranslation(
array
$data, array
$filters)

Update translations

Return: false on error, the affected rows on success
Access: public

Parameters:

array	`$data`	—	containing the key value pairs of columns to update
array	`$filters`	—	key values pairs (value may be a string or an array) This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all translations will be affected by the update

[ Top ]

int|bool updateUser(
array
$data, array
$filters)

Update users

Return: false on error, the affected rows on success
Access: public

Parameters:

array	`$data`	—	containing the key value pairs of columns to update
array	`$filters`	—	key values pairs (value may be a string or an array) This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all users will be affected by the update

[ Top ]

int|bool updateUserRight(
array
$data, array
$filters)

Update right(s) for the given user(s)

Return: false on error, the affected rows on success
Access: public

Parameters:

array	`$data`	—	containing the key value pairs of columns to update
array	`$filters`	—	key values pairs (value may be a string or an array) This will construct the WHERE clause of your update Be careful, if you leave this blank no WHERE clause will be used and all users will be affected by the update

[ Top ]

Class: LiveUser_Admin_Perm_Simple

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$stack = null

$withFieldMethodMap = array( 'perm_user_id' => 'getUsers', 'right_id' => 'getRights', 'area_id' => 'getAreas', 'application_id' => 'getApplications', )

Method Detail

LiveUser_Admin_Perm_Simple (Constructor) [line 142]

addApplication [line 403]

Parameters:

addArea [line 336]

Parameters:

addRight [line 269]

Parameters:

addTranslation [line 554]

Parameters:

addUser [line 197]

Parameters:

disconnect [line 1123]

getApplications [line 868]

Parameters:

getAreas [line 835]

Parameters:

getRights [line 802]

Parameters:

getTranslations [line 901]

Parameters:

getUsers [line 769]

Parameters:

grantUserRight [line 478]

Parameters:

init [line 156]

Parameters:

outputRightsConstants [line 947]

Parameters:

removeApplication [line 440]

Parameters:

removeArea [line 373]

Parameters:

removeRight [line 306]

Parameters:

removeTranslation [line 591]

Parameters:

removeUser [line 239]

Parameters:

revokeUserRight [line 538]

Parameters:

updateApplication [line 422]

Parameters:

updateArea [line 355]

Parameters:

updateRight [line 288]

Parameters:

updateTranslation [line 573]

Parameters:

updateUser [line 221]

Parameters:

updateUserRight [line 520]

Parameters:

$withFieldMethodMap = array(
'perm_user_id' => 'getUsers',
'right_id' => 'getRights',
'area_id' => 'getAreas',
'application_id' => 'getApplications',
)