CatalogHandler Class Reference

Inheritance diagram for CatalogHandler:

Public Member Functions
	_setupPaginationTemplate ($request, $submissionsCount, $page, $count, $offset, $total)
	fullSize ($args, $request)
	index ($args, $request)
	newReleases ($args, $request)
	page ($args, $request, $isFirstPage=false)
	results ($args, $request)
	series ($args, $request)
	setupTemplate ($request)
	thumbnail ($args, $request)
Public Member Functions inherited from PKPCatalogHandler
	authorize ($request, &$args, $roleAssignments)
	category ($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)
	initialize ($request)
	markRoleAssignmentsChecked ()
	requireSSL ()
	setApiToken ($apiToken)
	setDispatcher ($dispatcher)
	setEnforceRestrictedSite ($enforceRestrictedSite)
	setId ($id)
	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 Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Handle requests for the press-specific part of the public-facing catalog.

Definition at line 19 of file CatalogHandler.inc.php.

Member Function Documentation

_setupPaginationTemplate()

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

Assign the pagination template variables

Parameters

$request	PKPRequest
$submissionsCount	int Number of submissions 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 from PKPCatalogHandler.

Definition at line 293 of file CatalogHandler.inc.php.

References PKPTemplateManager\getManager().

Referenced by page(), and series().

fullSize()

CatalogHandler::fullSize	(		$args,
			$request
	)

Serve the image for a category or series.

Reimplemented from PKPCatalogHandler.

Definition at line 196 of file CatalogHandler.inc.php.

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

index()

CatalogHandler::index	(		$args,
			$request
	)

Show the catalog home.

Parameters

$args	array
$request	PKPRequest

Reimplemented from PKPHandler.

Definition at line 28 of file CatalogHandler.inc.php.

References page().

newReleases()

CatalogHandler::newReleases	(		$args,
			$request
	)

Show the catalog new releases.

Parameters

$args	array
$request	PKPRequest

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

References DAORegistry\getDAO(), PKPTemplateManager\getManager(), and setupTemplate().

page()

CatalogHandler::page	(		$args,
			$request,
			$isFirstPage = false
	)

Show a page of the catalog

Parameters

$args	array [ @option int Page number if available ]
$request	PKPRequest
$isFirstPage	boolean Return the first page of results

Definition at line 40 of file CatalogHandler.inc.php.

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

Referenced by index().

results()

CatalogHandler::results	(		$args,
			$request
	)

Deprecated:

Since OMP 3.2.1, use pages/search instead.

Parameters

$args	array
$request	PKPRequest

Returns

string

Definition at line 189 of file CatalogHandler.inc.php.

series()

CatalogHandler::series	(		$args,
			$request
	)

View the content of a series.

Parameters

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

Returns

string

Definition at line 121 of file CatalogHandler.inc.php.

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

setupTemplate()

CatalogHandler::setupTemplate

(

$request

)

Set up the basic template.

Reimplemented from PKPCatalogHandler.

Definition at line 275 of file CatalogHandler.inc.php.

References PKPTemplateManager\getManager().

Referenced by newReleases(), page(), and series().

thumbnail()

CatalogHandler::thumbnail	(		$args,
			$request
	)

Serve the thumbnail for a category or series.

Reimplemented from PKPCatalogHandler.

Definition at line 236 of file CatalogHandler.inc.php.

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

---

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

• CatalogHandler.inc.php