Public Member Functions | Public Attributes

PaperHandler Class Reference
[Pages_paper]

Inheritance diagram for PaperHandler:
Handler RTHandler

List of all members.

Public Member Functions

 download ($args, &$request)
 downloadSuppFile ($args, &$request)
 PaperHandler (&$request)
 validate (&$request, $paperId, $galleyId=null)
 view ($args, &$request)
 viewDownloadInterstitial ($args, &$request, $galley=null)
 viewFile ($args, &$request)
 viewPaper ($args, &$request)
 viewPDFInterstitial ($args, &$request, $galley=null)
 viewRST ($args, &$request)

Public Attributes

 $paper

Detailed Description

Handle requests for paper functions.

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

Member Function Documentation

PaperHandler.download ( $  args,
&$  request 
)

Downloads the document

Parameters:
$args array
$request Request

Definition at line 361 of file PaperHandler.inc.php.

References $paper, and validate().

PaperHandler.downloadSuppFile ( $  args,
&$  request 
)

Downloads a supplementary file

Parameters:
$args array
$request Request

Definition at line 384 of file PaperHandler.inc.php.

References $paper, and validate().

PaperHandler.PaperHandler ( &$  request  ) 

Constructor

Parameters:
$request Request

Definition at line 31 of file PaperHandler.inc.php.

Referenced by RTHandler.RTHandler().

PaperHandler.validate ( &$  request,
$  paperId,
$  galleyId = null 
)

Validation

See also:
lib/pkp/classes/handler/PKPHandlervalidate()
Parameters:
$request Request
$paperId integer
$galleyId integer

Definition at line 419 of file PaperHandler.inc.php.

References $paper, Validation.isLoggedIn(), SchedConfAction.mayViewPapers(), SchedConfAction.mayViewProceedings(), and Validation.redirectLogin().

Referenced by RTHandler.bio(), RTHandler.captureCite(), RTHandler.context(), download(), downloadSuppFile(), RTHandler.emailAuthor(), RTHandler.emailColleague(), RTHandler.findingReferences(), RTHandler.metadata(), RTHandler.printerFriendly(), RTHandler.suppFileMetadata(), RTHandler.suppFiles(), view(), viewDownloadInterstitial(), viewFile(), viewPaper(), viewPDFInterstitial(), and viewRST().

PaperHandler.view ( $  args,
&$  request 
)

View Paper.

Parameters:
$args array
$request Request

Definition at line 43 of file PaperHandler.inc.php.

References $paper, validate(), viewDownloadInterstitial(), viewPaper(), and viewPDFInterstitial().

PaperHandler.viewDownloadInterstitial ( $  args,
&$  request,
$  galley = null 
)

Paper interstitial page before a non-PDF, non-HTML galley is downloaded

Parameters:
$args array
$request Request
$galley PaperGalley

Definition at line 117 of file PaperHandler.inc.php.

References $paper, and validate().

Referenced by view().

PaperHandler.viewFile ( $  args,
&$  request 
)

View a file (inlines file).

Parameters:
$args array ($paperId, $galleyId, $fileId [optional])
$request Request

Definition at line 328 of file PaperHandler.inc.php.

References $paper, and validate().

PaperHandler.viewPaper ( $  args,
&$  request 
)

Paper view

Parameters:
$args array
$request Request

Definition at line 145 of file PaperHandler.inc.php.

References $paper, Validation.isLoggedIn(), SchedConfAction.mayViewPapers(), SchedConfAction.registeredDomain(), SchedConfAction.registeredUser(), and validate().

Referenced by view().

PaperHandler.viewPDFInterstitial ( $  args,
&$  request,
$  galley = null 
)

Paper interstitial page before PDF is shown

Parameters:
$args array
$request Request
$galley PaperGalley

Definition at line 88 of file PaperHandler.inc.php.

References $paper, and validate().

Referenced by view().

PaperHandler.viewRST ( $  args,
&$  request 
)

Paper Reading tools

Parameters:
$args array
$request Request

Definition at line 255 of file PaperHandler.inc.php.

References $paper, Validation.isLoggedIn(), and validate().

Member Data Documentation

PaperHandler.$paper

the paper associated with this request

Definition at line 25 of file PaperHandler.inc.php.

Referenced by RTHandler.bio(), RTHandler.captureCite(), RTHandler.context(), download(), downloadSuppFile(), RTHandler.emailAuthor(), RTHandler.emailColleague(), RTHandler.findingReferences(), RTHandler.metadata(), RTHandler.printerFriendly(), RTHandler.suppFileMetadata(), RTHandler.suppFiles(), validate(), view(), viewDownloadInterstitial(), viewFile(), viewPaper(), viewPDFInterstitial(), and viewRST().

The documentation for this class was generated from the following file:
Generated on Thu Sep 20 2012 17:26:07 for Open Conference Systems by  doxygen 1.7.1