Open Journal Systems  3.3.0
ReportGeneratorHandler Class Reference
Inheritance diagram for ReportGeneratorHandler:
Handler PKPHandler

Public Member Functions

 __construct ()
 
_getReportGeneratorForm ($request)
 
 authorize ($request, &$args, $roleAssignments)
 
 fetchArticlesInfo ($args, $request)
 
 fetchRegions ($args, $request)
 
 fetchReportGenerator ($args, $request)
 
 saveReportGenerator ($args, $request)
 
 setupTemplate ($request)
 
- Public Member Functions inherited from PKPHandler
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 getApiToken ()
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, &$contextsCount=null)
 
 index ($args, $request)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle requests for report generator functions.

Definition at line 20 of file ReportGeneratorHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

ReportGeneratorHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 24 of file ReportGeneratorHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _getReportGeneratorForm()

& ReportGeneratorHandler::_getReportGeneratorForm (   $request)

Get report generator form object.

Returns
ReportGeneratorForm

Definition at line 162 of file ReportGeneratorHandler.inc.php.

References fatalError().

Referenced by fetchReportGenerator(), and saveReportGenerator().

◆ authorize()

ReportGeneratorHandler::authorize (   $request,
$args,
  $roleAssignments 
)

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

Parameters
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
Returns
boolean

Reimplemented from PKPHandler.

Definition at line 34 of file ReportGeneratorHandler.inc.php.

References PKPHandler\addPolicy().

◆ fetchArticlesInfo()

ReportGeneratorHandler::fetchArticlesInfo (   $args,
  $request 
)

Fetch articles title and id from the passed request variable issue id.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Definition at line 92 of file ReportGeneratorHandler.inc.php.

References PKPServices\get(), and PKPHandler\validate().

◆ fetchRegions()

ReportGeneratorHandler::fetchRegions (   $args,
  $request 
)

Fetch regions from the passed request variable country id.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Definition at line 121 of file ReportGeneratorHandler.inc.php.

References PKPHandler\validate().

◆ fetchReportGenerator()

ReportGeneratorHandler::fetchReportGenerator (   $args,
  $request 
)

Fetch form to generate custom reports.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

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

References _getReportGeneratorForm(), and setupTemplate().

◆ saveReportGenerator()

ReportGeneratorHandler::saveReportGenerator (   $args,
  $request 
)

Save form to generate custom reports.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Definition at line 69 of file ReportGeneratorHandler.inc.php.

References _getReportGeneratorForm(), and setupTemplate().

◆ setupTemplate()

ReportGeneratorHandler::setupTemplate (   $request)
See also
PKPHandler::setupTemplate()

Reimplemented from PKPHandler.

Definition at line 148 of file ReportGeneratorHandler.inc.php.

References AppLocale\requireComponents().

Referenced by fetchReportGenerator(), and saveReportGenerator().


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