Docs For Class LiveUser_Admin_Perm

LiveUser_Admin_Perm_Simple (Constructor) [line 119]

LiveUser_Admin_Perm_Simple LiveUser_Admin_Perm_Simple(
)

Class constructor. Feel free to override in backend subclasses.

[ Top ]

addApplication [line 399]

void addApplication(
array
$data)

Add application

Access: public

Parameters:

array $data —

[ Top ]

addArea [line 293]

void addArea(
array
$data)

Add area

Access: public

Parameters:

array $data —

[ Top ]

addRight [line 232]

void addRight(
array
$data)

Add right

Access: public

Parameters:

array $data —

[ Top ]

addTranslation [line 530]

void addTranslation(
array
$data)

Add translation

Access: public

Parameters:

array $data —

[ Top ]

addUser [line 167]

void addUser(
array
$data)

Add user

Access: public

Parameters:

array $data —

[ Top ]

disconnect [line 920]

void disconnect(
)

properly disconnect from resources

Access: public

[ Top ]

getApplications [line 718]

void getApplications(
[array
$params = array()])

Fetches applications

Access: public

Parameters:

array $params —

[ Top ]

getAreas [line 703]

void getAreas(
[array
$params = array()])

Fetches areas

Access: public

Parameters:

array $params —

[ Top ]

getCurrentApplication [line 385]

string getCurrentApplication(
)

Get current application

Return: name of the current application
Access: public

[ Top ]

getRights [line 686]

void getRights(
[array
$params = array()])

Fetches rights

Access: public

Overridden in child classes as:

LiveUser_Admin_Perm_Complex::getRights(): Fetches rights

Parameters:

array $params —

[ Top ]

getTranslations [line 735]

void getTranslations(
[array
$params = array()])

Fetches translations

Access: public

Parameters:

array $params —

[ Top ]

getUsers [line 669]

void getUsers(
[array
$params = array()])

Fetches users

Access: public

Parameters:

array $params —

[ Top ]

grantUserRight [line 460]

void grantUserRight(
array
$data)

Grant user a right

Access: public

Parameters:

array $data —

[ Top ]

init [line 131]

boolean init(
mixed
&$conf)

Load the storage container

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

Parameters:

mixed &$conf — Name of array containing the configuration.

[ Top ]

outputRightsConstants [line 769]

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

Generate the constants to a file or define them directly.

$mode can be either 'file' or 'php'. File will write the constant in the given file, replacing/adding constants as needed. Php will call define() function to actually define the constants.

$options can contain 'prefix' => 'prefix_goes_here', 'area' => 'specific area id to grab rights from', 'application' => 'specific application id to grab rights from' '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

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

Return: boolean, array or DB Error object
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 ]

removeApplication [line 434]

void removeApplication(
array
$filters)

Remove application(s)

Access: public
Uses: LiveUser_Admin_Perm_Simple::removeArea

Parameters:

array $filters — Array containing the filters on what application(s) should be removed

[ Top ]

removeArea [line 344]

void removeArea(
array
$filters)

Removes all areas define in the filter as well as any rights assigned to that area.

  $filters = array(

      'area_id' => '34'
  );
  $foo = $admin->perm->removeArea($filters);

Or you can also remove by any other field like so

  $filters = array(

      'area_define_name' => 'area232'
  );
  $foo = $admin->perm->removeArea($filters);

Access: public
Uses: LiveUser_Admin_Perm_Simple::removeRight

Overridden in child classes as:

LiveUser_Admin_Perm_Complex::removeArea(): Remove Area

Parameters:

array $filters — Array containing the filters on what area(s) should be removed

[ Top ]

removeRight [line 267]

void removeRight(
array
$filters)

Remove right

Access: public
Uses: LiveUser_Admin_Perm_Simple::revokeUserRight

Overridden in child classes as:

LiveUser_Admin_Perm_Medium::removeRight(): Removes right(s)

LiveUser_Admin_Perm_Complex::removeRight(): Remove Right

Parameters:

array $filters — Array containing the filters on what right(s) should be removed

[ Top ]

removeTranslation [line 563]

void removeTranslation(
array
$filters)

Remove translation(s)

Access: public

Parameters:

array $filters — Array containing the filters on what tranlation(s) should be removed

[ Top ]

removeUser [line 206]

void removeUser(
array
$filters)

Remove user

Access: public
Uses: LiveUser_Admin_Perm_Simple::revokeUserRight

Overridden in child classes as:

LiveUser_Admin_Perm_Medium::removeUser(): Removes user(s)

LiveUser_Admin_Perm_Complex::removeUser(): Remove User

Parameters:

array $filters — Array containing the filters on what user(s) should be removed

[ Top ]

revokeUserRight [line 514]

void revokeUserRight(
array
$filters)

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

Access: public

Parameters:

array $filters — Array containing the filters on what right(s) should be removed from what user(s)

[ Top ]

setCurrentApplication [line 370]

boolean setCurrentApplication(
integer
$applicationId)

Set current application

Return: always true
Access: public

Parameters:

integer $applicationId — id of application

[ Top ]

updateApplication [line 416]

void updateApplication(
array
$data, array
$filters)

Update application(s)

Access: public

Parameters:

array	`$data`	—
array	`$filters`	—

[ Top ]

updateArea [line 310]

void updateArea(
array
$data, array
$filters)

Update area(s)

Access: public

Parameters:

array	`$data`	—
array	`$filters`	—

[ Top ]

updateRight [line 249]

void updateRight(
array
$data, array
$filters)

Update right

Access: public

Parameters:

array	`$data`	—
array	`$filters`	—

[ Top ]

updateTranslation [line 547]

void updateTranslation(
array
$data, array
$filters)

Update translation(s)

Access: public

Parameters:

array	`$data`	—
array	`$filters`	—

[ Top ]

updateUser [line 188]

void updateUser(
array
$data, array
$filters)

Update usr

Access: public

Parameters:

array	`$data`	—
array	`$filters`	—

[ Top ]

updateUserRight [line 497]

void updateUserRight(
array
$data, array
$filters)

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

Access: public

Parameters:

array	`$data`	—
array	`$filters`	—

[ Top ]

Class: LiveUser_Admin_Perm_Simple

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

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

Method Detail

LiveUser_Admin_Perm_Simple (Constructor) [line 119]

addApplication [line 399]

Parameters:

addArea [line 293]

Parameters:

addRight [line 232]

Parameters:

addTranslation [line 530]

Parameters:

addUser [line 167]

Parameters:

disconnect [line 920]

getApplications [line 718]

Parameters:

getAreas [line 703]

Parameters:

getCurrentApplication [line 385]

getRights [line 686]

Parameters:

getTranslations [line 735]

Parameters:

getUsers [line 669]

Parameters:

grantUserRight [line 460]

Parameters:

init [line 131]

Parameters:

outputRightsConstants [line 769]

Parameters:

removeApplication [line 434]

Parameters:

removeArea [line 344]

Parameters:

removeRight [line 267]

Parameters:

removeTranslation [line 563]

Parameters:

removeUser [line 206]

Parameters:

revokeUserRight [line 514]

Parameters:

setCurrentApplication [line 370]

Parameters:

updateApplication [line 416]

Parameters:

updateArea [line 310]

Parameters:

updateRight [line 249]

Parameters:

updateTranslation [line 547]

Parameters:

updateUser [line 188]

Parameters:

updateUserRight [line 497]

Parameters:

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