Open Journal Systems  3.3.0
StageRolePolicy Class Reference
Inheritance diagram for StageRolePolicy:
AuthorizationPolicy

Public Member Functions

 __construct ($roleIds, $stageId=null, $allowRecommendOnly=true)
 
 effect ()
 
- Public Member Functions inherited from AuthorizationPolicy
 __construct ($message=null)
 
 addAuthorizedContextObject ($assocType, &$authorizedObject)
 
 applies ()
 
getAdvice ($adviceType)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
 hasAdvice ($adviceType)
 
 hasAuthorizedContextObject ($assocType)
 
 setAdvice ($adviceType, &$adviceContent)
 
 setAuthorizedContext (&$authorizedContext)
 

Additional Inherited Members

- Data Fields inherited from AuthorizationPolicy
 $_advice = array()
 
 $_authorizedContext = array()
 

Detailed Description

Class to check if the user has an assigned role on a specific submission stage. Optionally deny authorization if that stage assignment is a "recommend only" assignment.

Definition at line 19 of file StageRolePolicy.inc.php.

Constructor & Destructor Documentation

◆ __construct()

StageRolePolicy::__construct (   $roleIds,
  $stageId = null,
  $allowRecommendOnly = true 
)

Constructor

Parameters
array$roleIdsThe roles required to be authorized
int$stageIdThe stage the role assignment is required on to be authorized. Leave this null to check against the submission's currently active stage.
boolean$allowRecommendOnlyAuthorize the user even if the stage assignment is a "recommend only" assignment. Default allows "recommend only" assignments to pass authorization.

Definition at line 47 of file StageRolePolicy.inc.php.

References AppLocale\requireComponents().

Member Function Documentation

◆ effect()

StageRolePolicy::effect ( )

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