Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PKPReportGeneratorForm Class Reference
Inheritance diagram for PKPReportGeneratorForm:
Form ReportGeneratorForm

Public Member Functions

 execute ($request)
 
 fetch ($request)
 
 getFileAssocTypes ()
 
 PKPReportGeneratorForm ($columns, $objects, $fileTypes, $metricType, $defaultReportTemplates, $reportTemplateIndex=null)
 
 readInputData ()
 
- 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
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Base form class to generate custom statistics reports.

See Also
Form

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

Member Function Documentation

PKPReportGeneratorForm::execute (   $request)
See Also
Form::execute()

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

PKPReportGeneratorForm::fetch (   $request)

Initialize the form from the current settings.

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

References Form\setData().

PKPReportGeneratorForm::getFileAssocTypes ( )
abstract

Return which assoc types represents file objects.

Returns
array
PKPReportGeneratorForm::PKPReportGeneratorForm (   $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 75 of file PKPReportGeneratorForm.inc.php.

PKPReportGeneratorForm::readInputData ( )

Assign user-submitted data to form.

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

References Form\getData().


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