Open Journal Systems
3.3.0
|
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 | |
Form for journal managers to modify usage statistics plugin settings.
Definition at line 18 of file UsageStatsSettingsForm.inc.php.
UsageStatsSettingsForm::__construct | ( | $plugin | ) |
Constructor
$plugin | UsageStatsPlugin |
Definition at line 30 of file UsageStatsSettingsForm.inc.php.
References $plugin, and Form\addCheck().
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
$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 |
Definition at line 166 of file UsageStatsSettingsForm.inc.php.
UsageStatsSettingsForm::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 106 of file UsageStatsSettingsForm.inc.php.
References $plugin, PKPApplication\get(), and Form\getData().
UsageStatsSettingsForm::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 83 of file UsageStatsSettingsForm.inc.php.
References $application, PKPApplication\get(), Form\getData(), PKPTemplateManager\getManager(), getOptionalColumnsList(), Config\getVar(), and Form\setData().
UsageStatsSettingsForm::getOptionalColumnsList | ( | ) |
Get optional columns list.
Definition at line 143 of file UsageStatsSettingsForm.inc.php.
References $plugin.
Referenced by fetch().
UsageStatsSettingsForm::initData | ( | ) |
Initialize form data for a new form.
Reimplemented from Form.
Definition at line 45 of file UsageStatsSettingsForm.inc.php.
References $plugin, PKPApplication\get(), and Form\setData().
UsageStatsSettingsForm::readInputData | ( | ) |
Assign form data to user-submitted data. Can be overridden from subclasses.
Reimplemented from Form.
Definition at line 65 of file UsageStatsSettingsForm.inc.php.
References Form\getData(), Form\readUserVars(), and Form\setData().
$plugin UsageStatsSettingsForm::$plugin |
Definition at line 24 of file UsageStatsSettingsForm.inc.php.
Referenced by __construct(), execute(), getOptionalColumnsList(), and initData().