abstract class BaseForm extends FormDisplay

Base form for user preferences

Methods

__construct(ConfigFile $cf, int|null $serverId = null)

Constructor

getConfigFile()

Returns {@link ConfigFile} associated with this instance

void
registerForm(string $formName, array $form, int $serverId = null)

Registers form in form manager

boolean
process(bool $allowPartialSave = true, bool $checkFormSubmit = true)

Processes forms, returns true on successful save

string
getDisplay(bool $tabbedForm = false, bool $showRestoreDefault = false, bool $showButtons = true, string $formAction = null, array|null $hiddenFields = null)

Outputs HTML for forms

string|null
displayErrors()

Displays errors

void
fixErrors()

Reverts erroneous fields to their default values

boolean
save(array|string $forms, bool $allowPartialSave = true)

Validates and saves form data to session

boolean
hasErrors()

Tells whether form validation failed

string
getDocLink(string $path)

Returns link to documentation

static array
getForms()

List of available forms, each form is described as an array of fields to display.

static string[]
getFields()

Returns list of fields used in the form.

static string
getName()

Returns name of the form

Details

at line 27
__construct(ConfigFile $cf, int|null $serverId = null)

Constructor

Parameters

ConfigFile $cf Config file instance
int|null $serverId 0 if new server, validation; >= 1 if editing a server

in FormDisplay at line 117
ConfigFile getConfigFile()

Returns {@link ConfigFile} associated with this instance

Return Value

ConfigFile

in FormDisplay at line 131
void registerForm(string $formName, array $form, int $serverId = null)

Registers form in form manager

Parameters

string $formName Form name
array $form Form data
int $serverId 0 if new server, validation; >= 1 if editing a server

Return Value

void

in FormDisplay at line 158
boolean process(bool $allowPartialSave = true, bool $checkFormSubmit = true)

Processes forms, returns true on successful save

Parameters

bool $allowPartialSave allows for partial form saving on failed validation
bool $checkFormSubmit whether check for $_POST['submit_save']

Return Value

boolean whether processing was successful

in FormDisplay at line 293
string getDisplay(bool $tabbedForm = false, bool $showRestoreDefault = false, bool $showButtons = true, string $formAction = null, array|null $hiddenFields = null)

Outputs HTML for forms

Parameters

bool $tabbedForm if true, use a form with tabs
bool $showRestoreDefault whether show "restore default" button besides the input field
bool $showButtons whether show submit and reset button
string $formAction action attribute for the form
array|null $hiddenFields array of form hidden fields (key: field name)

Return Value

string HTML for forms

in FormDisplay at line 522
string|null displayErrors()

Displays errors

Return Value

string|null HTML for errors

in FormDisplay at line 548
void fixErrors()

Reverts erroneous fields to their default values

Return Value

void

in FormDisplay at line 604
boolean save(array|string $forms, bool $allowPartialSave = true)

Validates and saves form data to session

Parameters

array|string $forms array of form names
bool $allowPartialSave allows for partial form saving on failed validation

Return Value

boolean true on success (no errors and all saved)

in FormDisplay at line 769
boolean hasErrors()

Tells whether form validation failed

Return Value

boolean

Returns link to documentation

Parameters

string $path Path to documentation

Return Value

string

at line 56
static array getForms()

List of available forms, each form is described as an array of fields to display.

Fields MUST have their counterparts in the $cfg array.

To define form field, use the notation below: $forms['Form group']['Form name'] = array('Option/path');

You can assign default values set by special button ("set value: ..."), eg.: 'Servers/1/pmadb' => 'phpmyadmin'

To group options, use: ':group:' . __('group name') // just define a group or 'option' => ':group' // group starting from this option End group blocks with: ':group:end'

Return Value

array

at line 66
static string[] getFields()

Returns list of fields used in the form.

Return Value

string[]

at line 84
static string getName()

Returns name of the form

Return Value

string