Public Member Functions | |
| __construct ($combiningAlgorithm=COMBINING_DENY_OVERRIDES) | |
| addPolicy ($policyOrPolicySet, $addToTop=false) | |
| getCombiningAlgorithm () | |
| getEffectIfNoPolicyApplies () | |
| & | getPolicies () |
| setEffectIfNoPolicyApplies ($effectIfNoPolicyApplies) | |
Data Fields | |
| $_combiningAlgorithm | |
| $_effectIfNoPolicyApplies = AUTHORIZATION_DENY | |
| $_policies = array() | |
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.
Constructor & Destructor Documentation
◆ __construct()
| PolicySet::__construct | ( | $combiningAlgorithm = COMBINING_DENY_OVERRIDES | ) |
Constructor
- Parameters
-
$combiningAlgorithm int COMBINING_...
Reimplemented in ContextPolicy.
Definition at line 50 of file PolicySet.inc.php.
Member Function Documentation
◆ addPolicy()
| PolicySet::addPolicy | ( | $policyOrPolicySet, | |
$addToTop = false |
|||
| ) |
Add a policy or a nested policy set.
- Parameters
-
$policyOrPolicySet AuthorizationPolicy|PolicySet $addToTop boolean whether to insert the new policy to the top of the list.
Definition at line 63 of file PolicySet.inc.php.
Referenced by ContextAccessPolicy\__construct(), ContextPolicy\__construct(), AuthorDashboardAccessPolicy\__construct(), EditorDecisionAccessPolicy\__construct(), PublicationWritePolicy\__construct(), QueryAccessPolicy\__construct(), ReviewStageAccessPolicy\__construct(), QueryWorkflowStageAccessPolicy\__construct(), PublicationAccessPolicy\__construct(), SubmissionAccessPolicy\__construct(), PKPSiteAccessPolicy\__construct(), WorkflowStageAccessPolicy\__construct(), PluginAccessPolicy\__construct(), and SubmissionFileAccessPolicy\buildFileAccessPolicy().
◆ getCombiningAlgorithm()
| PolicySet::getCombiningAlgorithm | ( | ) |
Return the combining algorithm
- Returns
- integer
Definition at line 84 of file PolicySet.inc.php.
References $_combiningAlgorithm.
◆ getEffectIfNoPolicyApplies()
| 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.
References $_effectIfNoPolicyApplies.
◆ getPolicies()
| & 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.
References $_policies.
◆ setEffectIfNoPolicyApplies()
| PolicySet::setEffectIfNoPolicyApplies | ( | $effectIfNoPolicyApplies | ) |
Set the default effect if none of the policies in the set applies
- Parameters
-
$effectIfNoPolicyApplies integer
Definition at line 92 of file PolicySet.inc.php.
Field Documentation
◆ $_combiningAlgorithm
| integer PolicySet::$_combiningAlgorithm |
Definition at line 37 of file PolicySet.inc.php.
Referenced by getCombiningAlgorithm().
◆ $_effectIfNoPolicyApplies
| 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.
Referenced by getEffectIfNoPolicyApplies().
◆ $_policies
| array PolicySet::$_policies = array() |
Definition at line 31 of file PolicySet.inc.php.
Referenced by getPolicies().
The documentation for this class was generated from the following file:
