PHP Class ArticleHandler, ojs

Inheritance: extends ToroHandler
Show file Open project: pkp/ojs Class Usage Examples

Public Properties

Property Type Description
$article article associated with the request *
$galley galley associated with the request *
$issue issue associated with the request *
$journal journal associated with the request *

Public Methods

Method Description
__construct ( ) Constructor
authorize ( $request, &$args, $roleAssignments )
cite ( $args, $request ) Fetch an item citation
download ( array $args, PKPRequest $request ) Download an article file
downloadSuppFile ( $args, $request ) Download a supplementary file.
initialize ( $request, $args )
setupTemplate ( $request ) Set up the template. (Load required locale components.)
userCanViewGalley ( $request, $articleId, $galleyId = null ) Determines whether a user can view this article galley or not.
view ( $args, $request ) View Article. (Either article landing page or galley view.)
viewFile ( $args, $request ) Download an article file For deprecated OJS 2.x URLs; see https://github.com/pkp/pkp-lib/issues/1541

Method Details

__construct() public method

Constructor
public __construct ( )

authorize() public method

public authorize ( $request, &$args, $roleAssignments )

cite() public method

Fetch an item citation
public cite ( $args, $request )
$args
$request

download() public method

Download an article file
public download ( array $args, PKPRequest $request )
$args array
$request PKPRequest

downloadSuppFile() public method

For deprecated OJS 2.x URLs; see https://github.com/pkp/pkp-lib/issues/1541
public downloadSuppFile ( $args, $request )
$args array
$request PKPRequest

initialize() public method

See also: PKPHandler::initialize()
public initialize ( $request, $args )

setupTemplate() public method

Set up the template. (Load required locale components.)
public setupTemplate ( $request )
$request PKPRequest

userCanViewGalley() public method

Determines whether a user can view this article galley or not.
public userCanViewGalley ( $request, $articleId, $galleyId = null )
$request Request
$articleId string
$galleyId int or string

view() public method

View Article. (Either article landing page or galley view.)
public view ( $args, $request )
$args array
$request Request

viewFile() public method

Download an article file For deprecated OJS 2.x URLs; see https://github.com/pkp/pkp-lib/issues/1541
public viewFile ( $args, $request )
$args array
$request PKPRequest

Property Details

$article public property

article associated with the request *
public $article

$galley public property

galley associated with the request *
public $galley

$issue public property

issue associated with the request *
public $issue

$journal public property

journal associated with the request *
public $journal