Public Member Functions | |
| __construct () | |
| authorize ($request, &$args, $roleAssignments) | |
| getMany ($slimRequest, $response, $args) | |
 Public Member Functions inherited from APIHandler | |
| convertStringsToSchema ($schema, $params) | |
| getApp () | |
| getEndpointPattern () | |
| getEndpoints () | |
| getEntityId ($parameterName) | |
| getParameter ($parameterName, $default=null) | |
| getRequest () | |
| getSlimRequest () | |
| setSlimRequest ($slimRequest) | |
| setupEndpoints () | |
| Public Member Functions inherited from PKPHandler | |
| addPolicy ($authorizationPolicy, $addToTop=false) | |
| addRoleAssignment ($roleIds, $operations) | |
| getApiToken () | |
| & | getAuthorizedContext () |
| & | getAuthorizedContextObject ($assocType) |
| & | getDispatcher () |
| getFirstUserContext ($user, $contexts) | |
| getId () | |
| getLastAuthorizationMessage () | |
| getRoleAssignment ($roleId) | |
| getRoleAssignments () | |
| getSiteRedirectContext ($request) | |
| getTargetContext ($request, &$contextsCount=null) | |
| index ($args, $request) | |
| initialize ($request) | |
| markRoleAssignmentsChecked () | |
| requireSSL () | |
| setApiToken ($apiToken) | |
| setDispatcher ($dispatcher) | |
| setEnforceRestrictedSite ($enforceRestrictedSite) | |
| setId ($id) | |
| setupTemplate ($request) | |
| validate ($requiredContexts=null, $request=null) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from PKPHandler | |
| static | getPageParamName ($rangeName) |
| static | getRangeInfo ($request, $rangeName, $contextData=null) |
| static | hashPageContext ($request, $contextData=array()) |
| Data Fields inherited from PKPHandler | |
| $_authorizationDecisionManager | |
| $_checks = array() | |
| $_dispatcher | |
| $_enforceRestrictedSite = true | |
| $_id | |
| $_isBackendPage = false | |
| $_roleAssignments = array() | |
| $_roleAssignmentsChecked = false | |
| Protected Member Functions inherited from APIHandler | |
| _validateStatDates ($params, $dateStartParam='dateStart', $dateEndParam='dateEnd') | |
| Protected Attributes inherited from APIHandler | |
| $_app | |
| $_endpoints = array() | |
| $_handlerPath = null | |
| $_pathPattern | |
| $_request | |
| $_slimRequest = null | |
| Protected Attributes inherited from PKPHandler | |
| $_apiToken = null | |
Detailed Description
Handle API requests for controlled vocab operations.
Definition at line 20 of file PKPVocabHandler.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| PKPVocabHandler::__construct | ( | ) |
Constructor
Reimplemented from APIHandler.
Definition at line 25 of file PKPVocabHandler.inc.php.
References APIHandler\getEndpointPattern().
Member Function Documentation
◆ authorize()
| PKPVocabHandler::authorize | ( | $request, | |
| & | $args, | ||
| $roleAssignments | |||
| ) |
Authorize this request.
Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.
NB: This method will be called once for every request only.
- Parameters
-
$request Request $args array request arguments $roleAssignments array the operation role assignment, see getRoleAssignment() for more details.
- Returns
- boolean
Reimplemented from PKPHandler.
Definition at line 42 of file PKPVocabHandler.inc.php.
References PKPHandler\addPolicy().
◆ getMany()
| PKPVocabHandler::getMany | ( | $slimRequest, | |
| $response, | |||
| $args | |||
| ) |
Get the controlled vocab entries available in this context
- Parameters
-
$slimRequest Request Slim request object $response Response object array $args arguments
- Returns
- Response
Definition at line 57 of file PKPVocabHandler.inc.php.
References HookRegistry\call(), PKPApplication\get(), DAORegistry\getDAO(), and AppLocale\getLocale().
The documentation for this class was generated from the following file:
