Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
HandlerOperationPolicy Class Reference
Inheritance diagram for HandlerOperationPolicy:
AuthorizationPolicy PKPPublicAccessPolicy RoleBasedHandlerOperationPolicy PKPProcessAccessPolicy

Public Member Functions

 _checkOperationWhitelist ()
 
 getOperations ()
 
getRequest ()
 
 HandlerOperationPolicy ($request, $operations, $message=null)
 
- Public Member Functions inherited from AuthorizationPolicy
 addAuthorizedContextObject ($assocType, &$authorizedObject)
 
 applies ()
 
 AuthorizationPolicy ($message=null)
 
 effect ()
 
getAdvice ($adviceType)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
 hasAdvice ($adviceType)
 
 hasAuthorizedContextObject ($assocType)
 
 setAdvice ($adviceType, &$adviceContent)
 
 setAuthorizedContext (&$authorizedContext)
 

Public Attributes

 $_operations = array()
 
- Public Attributes inherited from AuthorizationPolicy
 $_advice = array()
 
 $_authorizedContext = array()
 

Detailed Description

Abstract base class that provides infrastructure to control access to handler operations.

Definition at line 18 of file HandlerOperationPolicy.inc.php.

Member Function Documentation

HandlerOperationPolicy::_checkOperationWhitelist ( )

Check whether the requested operation is on the list of permitted operations.

Returns
boolean

Definition at line 80 of file HandlerOperationPolicy.inc.php.

Referenced by PKPPublicAccessPolicy\effect().

HandlerOperationPolicy::getOperations ( )

Return the operations whitelist.

Returns
array

Definition at line 67 of file HandlerOperationPolicy.inc.php.

Referenced by RoleBasedHandlerOperationPolicy\effect().

& HandlerOperationPolicy::getRequest ( )

Return the request.

Returns
PKPRequest

Definition at line 59 of file HandlerOperationPolicy.inc.php.

HandlerOperationPolicy::HandlerOperationPolicy (   $request,
  $operations,
  $message = null 
)

Constructor

Parameters
$requestPKPRequest
$operationsarray|string either a single operation or a list of operations that this policy is targeting.
$messagestring a message to be displayed if the authorization fails

Definition at line 38 of file HandlerOperationPolicy.inc.php.

Member Data Documentation

array HandlerOperationPolicy::$_operations = array()

the target operations

Definition at line 29 of file HandlerOperationPolicy.inc.php.


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