Permitable Class Reference

Inheritance diagram for Permitable:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent Group User

Public Member Functions

 contains (Permitable $permitable)
 getEffectiveRight ($moduleName, $rightName)
 getActualRight ($moduleName, $rightName)
 getExplicitActualRight ($moduleName, $rightName)
 getPropagatedActualAllowRight ($moduleName, $rightName)
 getInheritedActualRight ($moduleName, $rightName)
 setRight ($moduleName, $rightName, $type=Right::ALLOW)
 removeRight ($moduleName, $rightName, $type=Right::ALLOW)
 removeAllRights ()
 getEffectivePolicy ($moduleName, $policyName)
 getActualPolicy ($moduleName, $policyName)
 getExplicitActualPolicy ($moduleName, $policyName)
 getInheritedActualPolicy ($moduleName, $policyName)
 setPolicy ($moduleName, $policyName, $value)
 removePolicy ($moduleName, $policyName)
 removeAllPolicies ()

Static Public Member Functions

static getDefaultMetadata ()
static isTypeDeletable ()

Protected Member Functions

 getInheritedActualRightIgnoringEveryone ($moduleName, $rightName)
 onChangeRights ()
 afterSave ()
 onChangePolicies ()

Detailed Description

Definition at line 37 of file Permitable.php.


Member Function Documentation

getEffectiveRight ( moduleName,
rightName 
)
Parameters:
string $moduleName
string $rightName
Returns:
mixed

Reimplemented in Group.

Definition at line 63 of file Permitable.php.

getActualRight ( moduleName,
rightName 
)
Parameters:
string $moduleName
string $rightName
Returns:
int
Exceptions:
NotSupportedException 

Reimplemented in User, and Group.

Definition at line 78 of file Permitable.php.

getExplicitActualRight ( moduleName,
rightName 
)
Parameters:
string $moduleName
string $rightName
Returns:
int

Definition at line 112 of file Permitable.php.

getInheritedActualRight ( moduleName,
rightName 
)
Parameters:
string $moduleName
string $rightName
Returns:
int
Exceptions:
NotSupportedException 

Reimplemented in User, and Group.

Definition at line 171 of file Permitable.php.

getEffectivePolicy ( moduleName,
policyName 
)
Parameters:
string $moduleName
string $policyName
Returns:
mixed|null|string

Definition at line 286 of file Permitable.php.

getActualPolicy ( moduleName,
policyName 
)
Parameters:
string $moduleName
string $policyName
Returns:
mixed|null|string

Definition at line 305 of file Permitable.php.

getExplicitActualPolicy ( moduleName,
policyName 
)
Parameters:
string $moduleName
string $policyName
Returns:
mixed|null|string

Definition at line 350 of file Permitable.php.

getInheritedActualPolicy ( moduleName,
policyName 
)
Parameters:
string $moduleName
string $policyName
Returns:
mixed|null|string

Reimplemented in Group.

Definition at line 395 of file Permitable.php.

setPolicy ( moduleName,
policyName,
value 
)
Parameters:
string $moduleName
string $policyName
$value 

Definition at line 414 of file Permitable.php.

removePolicy ( moduleName,
policyName 
)
Parameters:
string $moduleName
string $policyName

Definition at line 449 of file Permitable.php.

static getDefaultMetadata (  )  [static]

Returns the default meta data for the class. It must be appended to the meta data from the parent model, if any.

Reimplemented from Item.

Reimplemented in User, and Group.

Definition at line 476 of file Permitable.php.

static isTypeDeletable (  )  [static]

To be overriden on intermediate derived classes to return false so that deletes are not done on intermediate classes because the object relational mapping will not clean up properly. For example if User is a Person, and Person is a RedBeanModel delete should be called only on User, not on Person. So User must override isDeletable to return false.

Reimplemented from Item.

Reimplemented in User, and Group.

Definition at line 491 of file Permitable.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Apr 27 07:10:28 2017