Public Member Functions | |
| __construct () | |
| authorize ($request, &$args, $roleAssignments) | |
| edit ($slimRequest, $response, $args) | |
| editTheme ($slimRequest, $response, $args) | |
| get ($slimRequest, $response, $args) | |
| getTheme ($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) | |
Data Fields | |
| $schemaName = SCHEMA_SITE | |
| Data Fields inherited from PKPHandler | |
| $_authorizationDecisionManager | |
| $_checks = array() | |
| $_dispatcher | |
| $_enforceRestrictedSite = true | |
| $_id | |
| $_isBackendPage = false | |
| $_roleAssignments = array() | |
| $_roleAssignmentsChecked = false | |
Additional Inherited Members | |
| Static Public Member Functions inherited from PKPHandler | |
| static | getPageParamName ($rangeName) |
| static | getRangeInfo ($request, $rangeName, $contextData=null) |
| static | hashPageContext ($request, $contextData=array()) |
| 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
Base class to handle API requests for the site object.
Definition at line 17 of file PKPSiteHandler.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| PKPSiteHandler::__construct | ( | ) |
Constructor
Reimplemented from APIHandler.
Definition at line 27 of file PKPSiteHandler.inc.php.
References APIHandler\getEndpointPattern().
Member Function Documentation
◆ authorize()
| PKPSiteHandler::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 62 of file PKPSiteHandler.inc.php.
References PKPHandler\addPolicy().
◆ edit()
| PKPSiteHandler::edit | ( | $slimRequest, | |
| $response, | |||
| $args | |||
| ) |
Edit the site
- Parameters
-
$slimRequest Request Slim request object $response Response object array $args arguments
- Returns
- Response
Definition at line 139 of file PKPSiteHandler.inc.php.
References APIHandler\convertStringsToSchema(), PKPServices\get(), and APIHandler\getRequest().
◆ editTheme()
| PKPSiteHandler::editTheme | ( | $slimRequest, | |
| $response, | |||
| $args | |||
| ) |
Edit the active theme and theme options on the site
- Parameters
-
$slimRequest Request Slim request object $response Response object array $args arguments
- Returns
- Response
Definition at line 170 of file PKPSiteHandler.inc.php.
References PKPServices\get(), PKPApplication\get(), PKPTemplateManager\getManager(), APIHandler\getRequest(), and PluginRegistry\loadCategory().
◆ get()
| PKPSiteHandler::get | ( | $slimRequest, | |
| $response, | |||
| $args | |||
| ) |
Get the site
- Parameters
-
$slimRequest Request Slim request object $response Response object array $args arguments
- Returns
- Response
Definition at line 84 of file PKPSiteHandler.inc.php.
References PKPServices\get(), and APIHandler\getRequest().
◆ getTheme()
| PKPSiteHandler::getTheme | ( | $slimRequest, | |
| $response, | |||
| $args | |||
| ) |
Get the active theme on the site
- Parameters
-
$slimRequest Request Slim request object $response Response object array $args arguments
- Returns
- Response
Definition at line 104 of file PKPSiteHandler.inc.php.
References APIHandler\getRequest(), and PluginRegistry\loadCategory().
Field Documentation
◆ $schemaName
| string PKPSiteHandler::$schemaName = SCHEMA_SITE |
One of the SCHEMA_... constants
Definition at line 22 of file PKPSiteHandler.inc.php.
The documentation for this class was generated from the following file:
