PKPCatalogHandler Class Reference

Inheritance diagram for PKPCatalogHandler:

Public Member Functions
	authorize ($request, &$args, $roleAssignments)
	category ($args, $request)
	fullSize ($args, $request)
	setupTemplate ($request)
	thumbnail ($args, $request)
Public Member Functions inherited from PKPHandler
	__construct ()
	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)
	validate ($requiredContexts=null, $request=null)

Protected Member Functions
	_setupPaginationTemplate ($request, $submissionsCount, $page, $count, $offset, $total)

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 Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Handle requests for the public-facing catalog.

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

Member Function Documentation

_setupPaginationTemplate()

PKPCatalogHandler::_setupPaginationTemplate (   $request,   $submissionsCount,   $page,   $count,   $offset,   $total  )

protected

Assign the pagination template variables

Parameters

$request	PKPRequest
$submissionsCount	int Number of monographs being shown
$page	int Page number being shown
$count	int Max number of monographs being shown
$offset	int Starting position of monographs
$total	int Total number of monographs available

Reimplemented in CatalogHandler.

Definition at line 154 of file PKPCatalogHandler.inc.php.

References PKPTemplateManager\getManager().

Referenced by category().

authorize()

PKPCatalogHandler::authorize	(		$request,
		&	$args,
			$roleAssignments
	)

See also

PKPHandler::authorize()

Reimplemented from PKPHandler.

Definition at line 29 of file PKPCatalogHandler.inc.php.

References PKPHandler\addPolicy().

category()

PKPCatalogHandler::category	(		$args,
			$request
	)

View the content of a category.

Parameters

$args	array [ @option string Category path @option int Page number if available ]
$request	PKPRequest

Returns

string

Definition at line 44 of file PKPCatalogHandler.inc.php.

References _setupPaginationTemplate(), PKPServices\get(), DAORegistry\getDAO(), PKPHandler\getDispatcher(), PKPTemplateManager\getManager(), Config\getVar(), and setupTemplate().

fullSize()

PKPCatalogHandler::fullSize	(		$args,
			$request
	)

Serve the full sized image for a category.

Parameters

$args	array
$request	PKPRequest

Reimplemented in CatalogHandler.

Definition at line 98 of file PKPCatalogHandler.inc.php.

References fatalError(), DAORegistry\getDAO(), and PKPHandler\getDispatcher().

setupTemplate()

PKPCatalogHandler::setupTemplate

(

$request

)

Set up the basic template.

Reimplemented from PKPHandler.

Reimplemented in CatalogHandler.

Definition at line 140 of file PKPCatalogHandler.inc.php.

References AppLocale\requireComponents().

Referenced by category().

thumbnail()

PKPCatalogHandler::thumbnail	(		$args,
			$request
	)

Serve the thumbnail for a category.

Parameters

$args	array
$request	PKPRequest

Reimplemented in CatalogHandler.

Definition at line 120 of file PKPCatalogHandler.inc.php.

References fatalError(), DAORegistry\getDAO(), and PKPHandler\getDispatcher().

---

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

• PKPCatalogHandler.inc.php