Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PolicySet Class Reference
Inheritance diagram for PolicySet:
ContextPolicy OmpPluginAccessPolicy PKPSiteAccessPolicy OmpAuthorDashboardAccessPolicy OmpEditorDecisionAccessPolicy OmpPublishedMonographAccessPolicy PkpContextAccessPolicy PKPSignoffAccessPolicy PKPSubmissionAccessPolicy PKPSubmissionFileAccessPolicy ReviewStageAccessPolicy

Public Member Functions

 addPolicy ($policyOrPolicySet, $addToTop=false)
 
 getCombiningAlgorithm ()
 
 getEffectIfNoPolicyApplies ()
 
getPolicies ()
 
 PolicySet ($combiningAlgorithm=COMBINING_DENY_OVERRIDES)
 
 setEffectIfNoPolicyApplies ($effectIfNoPolicyApplies)
 

Public Attributes

 $_effectIfNoPolicyApplies = AUTHORIZATION_DENY
 

Detailed Description

An ordered list of policies. Policy sets can be added to decision managers like policies. The decision manager will evaluate the contained policies in the order they were added.

NB: PolicySets can be nested.

Definition at line 26 of file PolicySet.inc.php.

Member Function Documentation

PolicySet::getCombiningAlgorithm ( )

Return the combining algorithm

Returns
integer

Definition at line 84 of file PolicySet.inc.php.

PolicySet::getEffectIfNoPolicyApplies ( )

Get the default effect if none of the policies in the set applies

Returns
integer

Definition at line 103 of file PolicySet.inc.php.

& PolicySet::getPolicies ( )

Get all policies within this policy set.

Returns
array a list of AuthorizationPolicy or PolicySet objects.

Definition at line 76 of file PolicySet.inc.php.

PolicySet::setEffectIfNoPolicyApplies (   $effectIfNoPolicyApplies)

Set the default effect if none of the policies in the set applies

Parameters
$effectIfNoPolicyAppliesinteger

Definition at line 92 of file PolicySet.inc.php.

Member Data Documentation

integer PolicySet::$_effectIfNoPolicyApplies = AUTHORIZATION_DENY

the default effect if none of the policies in the set applies

Definition at line 43 of file PolicySet.inc.php.


The documentation for this class was generated from the following file: