Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
ReportGeneratorForm Class Reference
Inheritance diagram for ReportGeneratorForm:
Form

Public Member Functions

 execute (&$request)
 
 fetch (&$request)
 
 readInputData ()
 
 ReportGeneratorForm ($columns, $objects, $fileTypes, $metricType, $defaultReportTemplates, $reportTemplateIndex=null)
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 display ($request=null, $template=null)
 
 execute ($object=null)
 
 fetch (&$request, $template=null, $display=false)
 
 Form ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getFormLocale ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isLocaleResubmit ()
 
 isValid ()
 
 readInputData ()
 
 readUserDateVars ($vars)
 
 readUserVars ($vars)
 
 setData ($key, $value)
 
 setTemplate ($template)
 
 smartyFormLanguageChooser ($params, &$smarty)
 
 validate ($callHooks=true)
 

Additional Inherited Members

- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 

Detailed Description

Form to generate custom statistics reports.

See Also
Form

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

Member Function Documentation

ReportGeneratorForm::execute ( $request)
ReportGeneratorForm::fetch ( $request)
ReportGeneratorForm::readInputData ( )

Assign user-submitted data to form.

Definition at line 217 of file ReportGeneratorForm.inc.php.

References Form\readUserVars().

ReportGeneratorForm::ReportGeneratorForm (   $columns,
  $objects,
  $fileTypes,
  $metricType,
  $defaultReportTemplates,
  $reportTemplateIndex = null 
)

Constructor.

Parameters
$columnsarray Report column names.
$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 57 of file ReportGeneratorForm.inc.php.

References Form\addCheck().


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