PHP Class PKPSubmissionHandler, pkp-lib

Inheritance: extends Handler
Datei anzeigen Open project: pkp/pkp-lib Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor
authorize ( $request, &$args, $roleAssignments )
getStepCount ( ) : integer Get the number of submission steps.
getStepsNumberAndLocaleKeys ( ) : array Get the step numbers and their corresponding title locale keys.
index ( $args, $request ) Redirect to the new submission wizard by default.
saveStep ( $args, $request ) : JSONMessage Save a submission step.
setupTemplate ( $request ) Setup common template variables.
step ( $args, $request ) : JSONMessage Display a step for the submission wizard.
wizard ( $args, $request ) Display the tab set for the submission wizard.

Method Details

__construct() public method

Constructor
public __construct ( )

authorize() public method

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

getStepCount() abstract public method

Get the number of submission steps.
abstract public getStepCount ( ) : integer
return integer

getStepsNumberAndLocaleKeys() abstract public method

Get the step numbers and their corresponding title locale keys.
abstract public getStepsNumberAndLocaleKeys ( ) : array
return array

index() public method

Redirect to the new submission wizard by default.
public index ( $args, $request )
$args array
$request Request

saveStep() public method

Save a submission step.
public saveStep ( $args, $request ) : JSONMessage
$args array first parameter is the step being saved
$request Request
return JSONMessage JSON object

setupTemplate() public method

Setup common template variables.
public setupTemplate ( $request )
$request Request

step() public method

Displays submission index page if a valid step is not specified.
public step ( $args, $request ) : JSONMessage
$args array
$request Request
return JSONMessage JSON object

wizard() public method

Display the tab set for the submission wizard.
public wizard ( $args, $request )
$args array
$request PKPRequest