Open Journal Systems  3.3.0
PKPReportGeneratorForm Class Reference
Inheritance diagram for PKPReportGeneratorForm:
Form ReportGeneratorForm

Public Member Functions

 __construct ($columns, $optionalColumns, $objects, $fileTypes, $metricType, $defaultReportTemplates, $reportTemplateIndex=null)
 
 execute (... $functionArgs)
 
 fetch ($request, $template=null, $display=false)
 
 getFileAssocTypes ()
 
 readInputData ()
 
- Public Member Functions inherited from Form
 __construct ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 addSupportedFormLocale ($supportedLocale)
 
 display ($request=null, $template=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Additional Inherited Members

- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Base form class to generate custom statistics reports.

See also
Form

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

Constructor & Destructor Documentation

◆ __construct()

PKPReportGeneratorForm::__construct (   $columns,
  $optionalColumns,
  $objects,
  $fileTypes,
  $metricType,
  $defaultReportTemplates,
  $reportTemplateIndex = null 
)

Constructor.

Parameters
$columnsarray Report column names.
$optionalColumnsarray Report column names that are optional.
$objectsarray Object types.
$fileTypesarray File types.
$metricTypestring The default report metric type.
$defaultReportTemplatesarray Default report templates that defines columns and filters selections. The key for each array item is expected to be a localized key that describes the report Template.
$reportTemplateIndexint (optional) Current report template index from the passed default report templates array.

Definition at line 82 of file PKPReportGeneratorForm.inc.php.

References Form\addCheck().

Member Function Documentation

◆ execute()

PKPReportGeneratorForm::execute (   $functionArgs)

Execute the form's action. (Note that it is assumed that the form has already been validated.)

Parameters
mixed$functionArgs,...Arguments from the caller to be passed to the hook consumer
Returns
mixed Result from the consumer to be passed to the caller. Send a true-ish result if you want the caller to do something with the return value.

Reimplemented from Form.

Definition at line 245 of file PKPReportGeneratorForm.inc.php.

References PKPApplication\get(), and Form\getData().

◆ fetch()

PKPReportGeneratorForm::fetch (   $request,
  $template = null,
  $display = false 
)

Returns a string of the rendered form

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.
$displayboolean
Returns
string the rendered form

Reimplemented from Form.

Definition at line 101 of file PKPReportGeneratorForm.inc.php.

References getFileAssocTypes(), and Form\setData().

◆ getFileAssocTypes()

PKPReportGeneratorForm::getFileAssocTypes ( )
abstract

Return which assoc types represents file objects.

Returns
array

Reimplemented in ReportGeneratorForm.

Referenced by fetch().

◆ readInputData()

PKPReportGeneratorForm::readInputData ( )

Assign user-submitted data to form.

Reimplemented from Form.

Definition at line 235 of file PKPReportGeneratorForm.inc.php.

References Form\readUserVars().


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