Open Journal Systems
3.3.0
|
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 | |
Base form class to generate custom statistics reports.
Definition at line 24 of file PKPReportGeneratorForm.inc.php.
PKPReportGeneratorForm::__construct | ( | $columns, | |
$optionalColumns, | |||
$objects, | |||
$fileTypes, | |||
$metricType, | |||
$defaultReportTemplates, | |||
$reportTemplateIndex = null |
|||
) |
Constructor.
$columns | array Report column names. |
$optionalColumns | array Report column names that are optional. |
$objects | array Object types. |
$fileTypes | array File types. |
$metricType | string The default report metric type. |
$defaultReportTemplates | array 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. |
$reportTemplateIndex | int (optional) Current report template index from the passed default report templates array. |
Definition at line 82 of file PKPReportGeneratorForm.inc.php.
References Form\addCheck().
PKPReportGeneratorForm::execute | ( | $functionArgs | ) |
Execute the form's action. (Note that it is assumed that the form has already been validated.)
mixed | $functionArgs,... | Arguments from the caller to be passed to the hook consumer |
Reimplemented from Form.
Definition at line 245 of file PKPReportGeneratorForm.inc.php.
References PKPApplication\get(), and Form\getData().
PKPReportGeneratorForm::fetch | ( | $request, | |
$template = null , |
|||
$display = false |
|||
) |
Returns a string of the rendered form
$request | PKPRequest |
$template | string the template to be rendered, mandatory if no template has been specified on class instantiation. |
$display | boolean |
Reimplemented from Form.
Definition at line 101 of file PKPReportGeneratorForm.inc.php.
References getFileAssocTypes(), and Form\setData().
|
abstract |
Return which assoc types represents file objects.
Reimplemented in ReportGeneratorForm.
Referenced by fetch().
PKPReportGeneratorForm::readInputData | ( | ) |
Assign user-submitted data to form.
Reimplemented from Form.
Definition at line 235 of file PKPReportGeneratorForm.inc.php.
References Form\readUserVars().