CatalogBookHandler Class Reference

Inheritance diagram for CatalogBookHandler:

Public Member Functions
	__construct ()
	authorize ($request, &$args, $roleAssignments)
	book ($args, $request)
	download ($args, $request, $view=false)
	setupTemplate ($request, $submission=null)
	view ($args, $request)
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
	$isVersionRequest = false
	$publication
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 Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

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

Definition at line 23 of file CatalogBookHandler.inc.php.

Constructor & Destructor Documentation

__construct()

CatalogBookHandler::__construct

(

)

Constructor

Reimplemented from PKPHandler.

Definition at line 39 of file CatalogBookHandler.inc.php.

Member Function Documentation

authorize()

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

See also

PKPHandler::authorize()

Parameters

$request	PKPRequest
$args	array
$roleAssignments	array

Reimplemented from PKPHandler.

Definition at line 53 of file CatalogBookHandler.inc.php.

References PKPHandler\addPolicy().

book()

CatalogBookHandler::book	(		$args,
			$request
	)

Display a published submission in the public catalog.

Parameters

$args	array
$request	PKPRequest

Definition at line 68 of file CatalogBookHandler.inc.php.

References $publication, HookRegistry\call(), PKPHandler\getAuthorizedContextObject(), PKPApplication\getCCLicenseBadge(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), PluginRegistry\loadCategory(), AppLocale\requireComponents(), and setupTemplate().

download()

CatalogBookHandler::download	(		$args,
			$request,
			$view = false
	)

Download a published submission publication format file.

Parameters

$args	array
$request	PKPRequest
$view	boolean True iff inline viewer should be used, if available

Definition at line 227 of file CatalogBookHandler.inc.php.

References $publication, HookRegistry\call(), PKPApplication\get(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), Validation\redirectLogin(), AppLocale\requireComponents(), and setupTemplate().

Referenced by view().

setupTemplate()

CatalogBookHandler::setupTemplate	(		$request,
			$submission = null
	)

Set up common template variables.

Parameters

$request	PKPRequest
$submission	Submission

Definition at line 362 of file CatalogBookHandler.inc.php.

References DAORegistry\getDAO().

Referenced by book(), and download().

view()

CatalogBookHandler::view	(		$args,
			$request
	)

Use an inline viewer to view a published submission publication format file.

Parameters

$args	array
$request	PKPRequest

Definition at line 217 of file CatalogBookHandler.inc.php.

References download().

Field Documentation

$isVersionRequest

boolean CatalogBookHandler::$isVersionRequest = false

Is this a request for a specific version

Definition at line 34 of file CatalogBookHandler.inc.php.

$publication

Publication CatalogBookHandler::$publication

The requested publication

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

Referenced by book(), and download().

---

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

• CatalogBookHandler.inc.php