Public Member Functions | |
| __construct ($request) | |
| _getContextRoles ($roleContext, $contextDepth, $userRoles) | |
| _prepareContextRolesArray ($userRoles, $contextRoles=array()) | |
| effect () | |
 Public Member Functions inherited from AuthorizationPolicy | |
| addAuthorizedContextObject ($assocType, &$authorizedObject) | |
| applies () | |
| & | getAdvice ($adviceType) |
| & | getAuthorizedContext () |
| & | getAuthorizedContextObject ($assocType) |
| hasAdvice ($adviceType) | |
| hasAuthorizedContextObject ($assocType) | |
| setAdvice ($adviceType, &$adviceContent) | |
| setAuthorizedContext (&$authorizedContext) | |
Data Fields | |
| $_request | |
| Data Fields 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.
Constructor & Destructor Documentation
◆ __construct()
| UserRolesRequiredPolicy::__construct | ( | $request | ) |
Constructor
- Parameters
-
$request PKPRequest
Reimplemented from AuthorizationPolicy.
Definition at line 30 of file UserRolesRequiredPolicy.inc.php.
Member Function Documentation
◆ _getContextRoles()
| 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.
References _prepareContextRolesArray(), and DAORegistry\getDAO().
Referenced by effect().
◆ _prepareContextRolesArray()
| UserRolesRequiredPolicy::_prepareContextRolesArray | ( | $userRoles, | |
$contextRoles = array() |
|||
| ) |
Prepare an array with the passed user roles. Can optionally add those roles to an already created array.
- Parameters
-
$userRoles array $contextRoles array
- Returns
- array
Definition at line 126 of file UserRolesRequiredPolicy.inc.php.
Referenced by _getContextRoles().
◆ effect()
| UserRolesRequiredPolicy::effect | ( | ) |
- See also
- AuthorizationPolicy::effect()
Reimplemented from AuthorizationPolicy.
Definition at line 42 of file UserRolesRequiredPolicy.inc.php.
References $_request, $application, _getContextRoles(), AuthorizationPolicy\addAuthorizedContextObject(), PKPApplication\get(), and DAORegistry\getDAO().
Field Documentation
◆ $_request
| Request UserRolesRequiredPolicy::$_request |
Definition at line 23 of file UserRolesRequiredPolicy.inc.php.
Referenced by effect().
The documentation for this class was generated from the following file:
