Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
UserRolesRequiredPolicy Class Reference
Inheritance diagram for UserRolesRequiredPolicy:
AuthorizationPolicy

Public Member Functions

 _getContextRoles ($roleContext, $contextDepth, $userRoles)
 
 _prepareContextRolesArray ($userRoles, $contextRoles=array())
 
 effect ()
 
 UserRolesRequiredPolicy ($request)
 
- 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)
 

Additional Inherited Members

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

Detailed Description

Policy to build an authorized user roles object. Because we may have users with no roles, we don't deny access when no user roles are found.

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

Member Function Documentation

UserRolesRequiredPolicy::_getContextRoles (   $roleContext,
  $contextDepth,
  $userRoles 
)

Get the current context roles from all user roles.

Parameters
array$roleContext
int$contextDepth
array$userRoles
Returns
mixed array or null

Definition at line 77 of file UserRolesRequiredPolicy.inc.php.

UserRolesRequiredPolicy::_prepareContextRolesArray (   $userRoles,
  $contextRoles = array() 
)

Prepare an array with the passed user roles. Can optionally add those roles to an already created array.

Parameters
$userRolesarray
$contextRolesarray
Returns
array

Definition at line 126 of file UserRolesRequiredPolicy.inc.php.

UserRolesRequiredPolicy::effect ( )
UserRolesRequiredPolicy::UserRolesRequiredPolicy (   $request)

Constructor

Parameters
$requestPKPRequest

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


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