Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
IssueHandler Class Reference
Inheritance diagram for IssueHandler:
Handler PKPHandler

Public Member Functions

 _setupIssueTemplate ($request, $issue, $showToc=false)
 _showIssueGalley ($request, $inline=false)
 archive ($args, $request)
 current ($args, $request)
 download ($args, $request)
getGalley ()
getIssue ()
 index ($args, $request)
 IssueHandler ()
 setGalley ($galley)
 setIssue ($issue)
 validate ($request, $issueId=null, $galleyId=null)
 view ($args, $request)
 viewDownloadInterstitial ($args, $request)
 viewFile ($args, $request)
 viewIssue ($args, $request)
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 addPolicy (&$authorizationPolicy, $addToTop=false)
 addRoleAssignment ($roleIds, $operations)
 authorize (&$request, &$args, $roleAssignments)
getAuthorizedContext ()
getAuthorizedContextObject ($assocType)
getDispatcher ()
 getId ()
 getLastAuthorizationMessage ()
 getLoginExemptions ()
getRangeInfo ($rangeName, $contextData=null)
 getRoleAssignment ($roleId)
 getRoleAssignments ()
 hashPageContext ($contextData=array())
 index ()
 initialize (&$request, $args=null)
 PKPHandler ()
 requireSSL ()
 setDispatcher (&$dispatcher)
 setId ($id)
 validate ($requiredContexts=null, $request=null)

Detailed Description

Handle requests for issue functions.

Definition at line 19 of file

Member Function Documentation

IssueHandler::_setupIssueTemplate (   $request,
  $showToc = false 

Given an issue, set up the template with all the required variables for issues/view.tpl to function properly (i.e. current issue and view issue).

$issueobject The issue to display
$showTocboolean iff false and a custom cover page exists, the cover page will be displayed. Otherwise table of contents will be displayed.

Definition at line 406 of file

References DAORegistry\getDAO(), AppLocale\getLocale(), Validation\isEditor(), Validation\isLayoutEditor(), Validation\isProofreader(), IssueAction\subscribedDomain(), IssueAction\subscribedUser(), and IssueAction\subscriptionRequired().

Referenced by IndexHandler\index(), and view().

IssueHandler::_showIssueGalley (   $request,
  $inline = false 

Show an issue galley file (either inline or download)


Definition at line 384 of file

References HookRegistry\call(), IssueFileManager\downloadFile(), DAORegistry\getDAO(), getGalley(), and getIssue().

Referenced by download(), and viewFile().

IssueHandler::archive (   $args,

Display the issue archive listings


Definition at line 105 of file

References DAORegistry\getDAO(), AppLocale\getLocale(), PKPHandler\getRangeInfo(), and validate().

IssueHandler::current (   $args,

Display current issue page.

Definition at line 46 of file

References DAORegistry\getDAO(), PluginRegistry\loadCategory(), and validate().

Referenced by index().

IssueHandler::download (   $args,

Downloads an issue galley file

$argsarray ($issueId, $galleyId)

Definition at line 212 of file

References _showIssueGalley(), and validate().

& IssueHandler::getGalley ( )

Get the retrieved issue galley


Definition at line 241 of file

Referenced by _showIssueGalley(), viewDownloadInterstitial(), and viewIssue().

& IssueHandler::getIssue ( )

Get the retrieved issue


Definition at line 225 of file

Referenced by _showIssueGalley(), view(), viewDownloadInterstitial(), and viewIssue().

IssueHandler::index (   $args,

Display about index page.

Definition at line 39 of file

References current().

IssueHandler::IssueHandler ( )


Definition at line 29 of file

References PKPHandler\addCheck(), and Request\getJournal().

IssueHandler::setGalley (   $galley)

Set a retrieved issue galley


Definition at line 249 of file

Referenced by validate().

IssueHandler::setIssue (   $issue)

Set a retrieved issue


Definition at line 233 of file

Referenced by validate().

IssueHandler::validate (   $request,
  $issueId = null,
  $galleyId = null 
IssueHandler::view (   $args,

Display issue view page.

Definition at line 77 of file

References _setupIssueTemplate(), getIssue(), PluginRegistry\loadCategory(), and validate().

IssueHandler::viewDownloadInterstitial (   $args,

Issue galley interstitial page for non-PDF files

$argsarray ($issueId, $galleyId)

Definition at line 174 of file

References getGalley(), getIssue(), and validate().

IssueHandler::viewFile (   $args,

View an issue galley file (inline file).

$argsarray ($issueId, $galleyId)

Definition at line 198 of file

References _showIssueGalley(), and validate().

IssueHandler::viewIssue (   $args,

View a PDF issue galley inline

$argsarray ($issueId, $galleyId)

Definition at line 133 of file

References getGalley(), getIssue(), AppLocale\getLocale(), and validate().

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