Inheritance diagram for PKPReportGeneratorForm:

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.

Constructor & Destructor Documentation

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

Constructor.

Parameters

$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.

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.