Inheritance diagram for UsageStatsSettingsForm:

Public Member Functions
	__construct ($plugin)

	_dependentFormFieldIsSet ($fieldValue, $form, $dependentFieldName, $expectedValue=null)

	execute (... $functionArgs)

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

	getOptionalColumnsList ()

	initData ()

	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 ()

	isValid ()

	readUserVars ($vars)

	setData ($key, $value=null)

	setDefaultFormLocale ($defaultLocale)

	setTemplate ($template)

	validate ($callHooks=true)

Data Fields
	$plugin

Data Fields inherited from Form
	$_checks

	$_data

	$_errors

	$_template

	$cssValidation

	$defaultLocale

	$errorFields

	$errorsArray

	$formSectionErrors

	$requiredLocale

	$supportedLocales

Detailed Description

Form for journal managers to modify usage statistics plugin settings.

Definition at line 18 of file UsageStatsSettingsForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

UsageStatsSettingsForm::__construct ( $plugin )

Constructor

Parameters

$plugin UsageStatsPlugin

Definition at line 30 of file UsageStatsSettingsForm.inc.php.

References $plugin, and Form\addCheck().

Member Function Documentation

◆ _dependentFormFieldIsSet()

UsageStatsSettingsForm::_dependentFormFieldIsSet	(	$fieldValue,
		$form,
		$dependentFieldName,
		$expectedValue = `null`
	)

Check for the presence of dependent fields if a field value is set The Complement call will enforce a dependent value as unset if a field value is set

Parameters

$fieldValue	mixed the value of the field being checked
$form	object a reference to this form
$dependentFieldName	string the name of the dependent field
$expectedValue	mixed if provided, the expected value which must be in the dependent field

Returns: boolean

Definition at line 166 of file UsageStatsSettingsForm.inc.php.

◆ execute()

UsageStatsSettingsForm::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 106 of file UsageStatsSettingsForm.inc.php.

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