PKPContextHandler Class Reference

Inheritance diagram for PKPContextHandler:

Public Member Functions
	__construct ()
	add ($slimRequest, $response, $args)
	authorize ($request, &$args, $roleAssignments)
	delete ($slimRequest, $response, $args)
	edit ($slimRequest, $response, $args)
	editTheme ($slimRequest, $response, $args)
	get ($slimRequest, $response, $args)
	getMany ($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_CONTEXT
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 contexts (journals/presses).

Definition at line 17 of file PKPContextHandler.inc.php.

Constructor & Destructor Documentation

__construct()

PKPContextHandler::__construct

(

)

Constructor

Reimplemented from APIHandler.

Definition at line 27 of file PKPContextHandler.inc.php.

References APIHandler\getEndpointPattern().

Member Function Documentation

add()

PKPContextHandler::add	(		$slimRequest,
			$response,
			$args
	)

Add a context

Parameters

	$slimRequest	Request Slim request object
	$response	Response object
array	$args	arguments

Returns

Response

Definition at line 278 of file PKPContextHandler.inc.php.

References APIHandler\convertStringsToSchema(), PKPServices\get(), Application\getContextDAO(), and APIHandler\getRequest().

authorize()

PKPContextHandler::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 81 of file PKPContextHandler.inc.php.

References PKPHandler\addPolicy().

delete()

PKPContextHandler::delete	(		$slimRequest,
			$response,
			$args
	)

Delete a context

Parameters

	$slimRequest	Request Slim request object
	$response	Response object
array	$args	arguments

Returns

Response

Definition at line 474 of file PKPContextHandler.inc.php.

References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), and APIHandler\getRequest().

edit()

PKPContextHandler::edit	(		$slimRequest,
			$response,
			$args
	)

Edit a context

Parameters

	$slimRequest	Request Slim request object
	$response	Response object
array	$args	arguments

Returns

Response

Definition at line 317 of file PKPContextHandler.inc.php.

References APIHandler\convertStringsToSchema(), PKPServices\get(), PKPHandler\getAuthorizedContextObject(), and APIHandler\getRequest().

editTheme()

PKPContextHandler::editTheme	(		$slimRequest,
			$response,
			$args
	)

Edit a context's theme and theme options

Parameters

	$slimRequest	Request Slim request object
	$response	Response object
array	$args	arguments

Returns

Response

Definition at line 376 of file PKPContextHandler.inc.php.

References PKPServices\get(), PKPApplication\get(), PKPHandler\getAuthorizedContextObject(), PKPTemplateManager\getManager(), APIHandler\getRequest(), and PluginRegistry\loadCategory().

get()

PKPContextHandler::get	(		$slimRequest,
			$response,
			$args
	)

Get a single context

Parameters

	$slimRequest	Request Slim request object
	$response	Response object
array	$args	arguments

Returns

Response

Definition at line 175 of file PKPContextHandler.inc.php.

References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), and APIHandler\getRequest().

getMany()

PKPContextHandler::getMany	(		$slimRequest,
			$response,
			$args
	)

Get a collection of contexts

Parameters

$slimRequest	Request Slim request object
$response	Response object
$args	array arguments

Returns

Response

Definition at line 102 of file PKPContextHandler.inc.php.

References HookRegistry\call(), PKPServices\get(), PKPHandler\getAuthorizedContextObject(), and APIHandler\getRequest().

getTheme()

PKPContextHandler::getTheme	(		$slimRequest,
			$response,
			$args
	)

Get the theme and any theme options for a context

Parameters

	$slimRequest	Request Slim request object
	$response	Response object
array	$args	arguments

Returns

Response

Definition at line 219 of file PKPContextHandler.inc.php.

References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), APIHandler\getRequest(), and PluginRegistry\loadCategory().

Field Documentation

$schemaName

string PKPContextHandler::$schemaName = SCHEMA_CONTEXT

One of the SCHEMA_... constants

Definition at line 22 of file PKPContextHandler.inc.php.

---

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

• PKPContextHandler.inc.php