[ Index ]

PHP Cross Reference of ACL Module

title

Body

[close]

/models/ -> RestrictedActiveRecord.php (summary)

RestrictedActiveRecord Class File This class serves as a base-class for all the objects which have to control their access

Author: dispy <dispyfree@googlemail.com>
License: LGPLv2
File Size: 474 lines (19 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 20 functions

  generateAccessCheck()
  find()
  findByAttributes()
  findByPk()
  findBySQL()
  findAll()
  findAllByAttributes()
  findAllByPk()
  findAllBySQL()
  getDirectlyPermitted()
  beforeSave()
  beforeDelete()
  afterSave()
  getAutoPermissions()
  grants()
  getUser()
  mayGenerally()
  checkBirPermission()
  getPermissionsWithBiz()
  areBusinessRulesFulfilled()

Functions
Functions that are not part of a class:

generateAccessCheck($conditions = '', $params = array()   X-Ref
The following functions generates the CDbCriteria necessary to filter all accessable rows
The CDbCriteria is solely passsed to the wrapped methods

param: sql $conditions the conditions being passed to the real method
param: array $params the params being passed to the real method
param: array   $options    options to be used by the method itself (keys: disableInheritance)
return: CDbCriteria the criteria assuring that the user only gets what he has access to

find($conditions = '', $params = array()   X-Ref
No description

findByAttributes($attributes, $conditions = '', $params = array()   X-Ref
No description

findByPk($pk, $conditions = '', $params = array()   X-Ref
No description

findBySQL($sql, $params = array()   X-Ref
No description

findAll($conditions = '', $params = array()   X-Ref
No description

findAllByAttributes($attributes, $conditions = '', $params = array()   X-Ref
No description

findAllByPk($pk, $conditions = '', $params = array()   X-Ref
No description

findAllBySQL($sql, $params = array()   X-Ref
No description

getDirectlyPermitted($actions = '*')   X-Ref
Gets the Aros who are directly (no inheritance!) permitted to perform
one of the specified actions on this object

param: mixed $actions the actions to be considered
return: array All of the objects which have one of the permissions

beforeSave()   X-Ref
This method checks whether the user has the right to update the current record
By default, it's always allowed to create a new object. This object is automatically assigned to the user who created it with full permissions


beforeDelete()   X-Ref
This method checks whether the user has the right to delete the current record


afterSave()   X-Ref
This method takes care to assign individual rights to newly created objects

param: CEvent $evt

getAutoPermissions($obj)   X-Ref
No description

grants($permission)   X-Ref
Checks whether the current ARO has the given permission on this object

param: string $permission

getUser()   X-Ref
Fetches the Access Request-Object to use (either the current user
or an object from self::inAttendance.

return: AclObject

mayGenerally($aco, $perm)   X-Ref
Checks whether the user is generally allowed to perform the given permission(s) on the given object

param: mixed $aco the object to perform the action on (either a string or a class)
param: mixed $perm“the permission to perform

checkBirPermission($condition, $params)   X-Ref
Checks if the given permission is granted - includes business-rules

param: string    $condition the query condition
param: array     $params  the attached parameters
param: Object    $originalAco the passed object (aco)

getPermissionsWithBiz($conditions, $params)   X-Ref
Finds all permissions including their associated objects (nodes and collections)
Uses the configuration to determine in which direction(s) to fetch objects

param: array $conditions ("aroCondition" and "acoCondition")
param: array $params
return: array ["aro" =>Permissions, "aco" => Permissions]  

areBusinessRulesFulfilled($mode, $permission)   X-Ref
Checks whether the business-rules attached to this permission are fulfilled

param: string    $mode (either "aro" or "aco"
param: Permission $permission  the permission to check
return: boolean  true if they are fulfilled, false otherwise



Generated: Sun Jul 1 19:24:45 2012 Cross-referenced by PHPXref 0.7.1