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

Public Member Functions

 _isVisibleIssue ($issue, $journalId)
 
 _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 IssueHandler.inc.php.

Member Function Documentation

IssueHandler::_isVisibleIssue (   $issue,
  $journalId 
)

Given an issue and journal id, return whether the current user can view the issue in the journal

Parameters
$issueobject The issue to display
$journalIdint The id of the journal

Definition at line 408 of file IssueHandler.inc.php.

References Validation\isEditor(), Validation\isLayoutEditor(), and Validation\isProofreader().

Referenced by _setupIssueTemplate(), and validate().

IssueHandler::_setupIssueTemplate (   $request,
  $issue,
  $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).

Parameters
$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 424 of file IssueHandler.inc.php.

References _isVisibleIssue(), DAORegistry\getDAO(), AppLocale\getLocale(), 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)

Parameters
$issueIdint
$galleyIdint
$requestRequest
$inlineboolean

Definition at line 389 of file IssueHandler.inc.php.

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

Referenced by download(), and viewFile().

IssueHandler::archive (   $args,
  $request 
)

Display the issue archive listings

Parameters
$argsarray
$requestPKPRequest

Definition at line 109 of file IssueHandler.inc.php.

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

IssueHandler::current (   $args,
  $request 
)

Display current issue page.

Definition at line 46 of file IssueHandler.inc.php.

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

Referenced by index().

IssueHandler::download (   $args,
  $request 
)

Downloads an issue galley file

Parameters
$argsarray ($issueId, $galleyId)
$requestRequest

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

References _showIssueGalley(), and validate().

& IssueHandler::getGalley ( )

Get the retrieved issue galley

Returns
IssueGalley

Definition at line 246 of file IssueHandler.inc.php.

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

& IssueHandler::getIssue ( )

Get the retrieved issue

Returns
Issue

Definition at line 230 of file IssueHandler.inc.php.

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

IssueHandler::index (   $args,
  $request 
)

Display about index page.

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

References current().

IssueHandler::IssueHandler ( )

Constructor

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

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

IssueHandler::setGalley (   $galley)

Set a retrieved issue galley

Parameters
$galleyIssueGalley

Definition at line 254 of file IssueHandler.inc.php.

Referenced by validate().

IssueHandler::setIssue (   $issue)

Set a retrieved issue

Parameters
$issueIssue

Definition at line 238 of file IssueHandler.inc.php.

Referenced by validate().

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

Display issue view page.

Definition at line 81 of file IssueHandler.inc.php.

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

IssueHandler::viewDownloadInterstitial (   $args,
  $request 
)

Issue galley interstitial page for non-PDF files

Parameters
$argsarray ($issueId, $galleyId)
$requestRequest

Definition at line 179 of file IssueHandler.inc.php.

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

IssueHandler::viewFile (   $args,
  $request 
)

View an issue galley file (inline file).

Parameters
$argsarray ($issueId, $galleyId)
$requestRequest

Definition at line 203 of file IssueHandler.inc.php.

References _showIssueGalley(), and validate().

IssueHandler::viewIssue (   $args,
  $request 
)

View a PDF issue galley inline

Parameters
$argsarray ($issueId, $galleyId)
$requestRequest

Definition at line 138 of file IssueHandler.inc.php.

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


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