Open Journal Systems  3.3.0
PKPSiteAccessPolicy Class Reference
Inheritance diagram for PKPSiteAccessPolicy:
PolicySet

Public Member Functions

 __construct ($request, $operations, $roleAssignments, $message='user.authorization.loginRequired')
 
 effect ()
 
- Public Member Functions inherited from PolicySet
 __construct ($combiningAlgorithm=COMBINING_DENY_OVERRIDES)
 
 addPolicy ($policyOrPolicySet, $addToTop=false)
 
 getCombiningAlgorithm ()
 
 getEffectIfNoPolicyApplies ()
 
getPolicies ()
 
 setEffectIfNoPolicyApplies ($effectIfNoPolicyApplies)
 

Additional Inherited Members

- Data Fields inherited from PolicySet
 $_combiningAlgorithm
 
 $_effectIfNoPolicyApplies = AUTHORIZATION_DENY
 
 $_policies = array()
 

Detailed Description

Class to that makes sure that a user is logged in.

Definition at line 20 of file PKPSiteAccessPolicy.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PKPSiteAccessPolicy::__construct (   $request,
  $operations,
  $roleAssignments,
  $message = 'user.authorization.loginRequired' 
)

Constructor

Parameters
$requestPKPRequest
$operationsarray|string either a single operation or a list of operations that this policy is targeting.
$roleAssignmentsarray|int Either an array of role -> operation assignments or the constant SITE_ACCESS_ALL_ROLES
$messagestring a message to be displayed if the authorization fails

Definition at line 30 of file PKPSiteAccessPolicy.inc.php.

References PolicySet\addPolicy().

Member Function Documentation

◆ effect()

PKPSiteAccessPolicy::effect ( )
See also
AuthorizationPolicy::effect()

Definition at line 53 of file PKPSiteAccessPolicy.inc.php.

References PKPApplication\get().


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