PHP Class SubmissionFilesGridHandler, pkp-lib

Inheritance: extends GridHandler
Show file Open project: pkp/pkp-lib Class Usage Examples

Public Properties

Property Type Description
$_capabilities FilesGridCapabilities
$_stageId integer

Public Methods

Method Description
__construct ( $dataProvider, $stageId, $capabilities ) Constructor
authorize ( $request, &$args, $roleAssignments )
getCapabilities ( ) : FilesGridCapabilities Get grid capabilities object.
getFilesToDownload ( $request )
getFilterSelectionData ( $request )
getStageId ( ) : integer Get the workflow stage id.
getSubmission ( ) : Submission Get the authorized submission.
initialize ( $request )
renderFilter ( $request, $filterData = [] )

Protected Methods

Method Description
getFilterColumns ( ) : Array Get which columns can be used by users to filter data.
getFilterForm ( )
getRowInstance ( )

Method Details

__construct() public method

Constructor
public __construct ( $dataProvider, $stageId, $capabilities )
$dataProvider GridDataProvider
$stageId integer One of the WORKFLOW_STAGE_ID_* constants.
$capabilities integer A bit map with zero or more FILE_GRID_* capabilities set.

authorize() public method

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

getCapabilities() public method

Get grid capabilities object.
public getCapabilities ( ) : FilesGridCapabilities
return FilesGridCapabilities

getFilesToDownload() public method

public getFilesToDownload ( $request )

getFilterColumns() protected method

Get which columns can be used by users to filter data.
protected getFilterColumns ( ) : Array
return Array

getFilterForm() protected method

protected getFilterForm ( )

getFilterSelectionData() public method

public getFilterSelectionData ( $request )

getRowInstance() protected method

protected getRowInstance ( )

getStageId() public method

Get the workflow stage id.
public getStageId ( ) : integer
return integer

getSubmission() public method

Get the authorized submission.
public getSubmission ( ) : Submission
return Submission

initialize() public method

public initialize ( $request )

renderFilter() public method

public renderFilter ( $request, $filterData = [] )

Property Details

$_capabilities public property

public FilesGridCapabilities $_capabilities
return FilesGridCapabilities

$_stageId public property

public int $_stageId
return integer