1. class
  2. PhpMyAdmin
  3. \
  4. Config
  5. \
  6. FormDisplay

FormDisplay

class FormDisplay (View source)

Form management class, displays and processes forms

Methods

__construct(ConfigFile $configFile)

No description

ConfigFile
getConfigFile()

Returns ConfigFile associated with this instance

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

Registers form in form manager

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

Processes forms, returns true on successful save

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

Outputs HTML for forms

string
displayErrors()

Displays errors

void
fixErrors()

Reverts erroneous fields to their default values

bool
save(array $forms, bool $allowPartialSave = true)

Validates and saves form data to session

bool
hasErrors()

Tells whether form validation failed

string
getDocLink(string $path)

Returns link to documentation

Details

at line 104
__construct(ConfigFile $configFile)

No description

Parameters

ConfigFile $configFile

at line 116
ConfigFile getConfigFile()

Returns ConfigFile associated with this instance

Return Value

ConfigFile

at line 128
void registerForm(string $formName, array $form, int|null $serverId = null)

Registers form in form manager

Parameters

string $formName

Form name
array $form

Form data
int|null $serverId

0 if new server, validation; >= 1 if editing a server

Return Value

void

at line 148
bool 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

bool

at line 214
string getDisplay(bool $showButtons = true, string|null $formAction = null, array|null $hiddenFields = null)

Outputs HTML for forms

Parameters

bool $showButtons

whether show submit and reset button
string|null $formAction

action attribute for the form
array|null $hiddenFields

array of form hidden fields (key: field name)

Return Value

string

HTML for forms

at line 468
string displayErrors()

Displays errors

Return Value

string

HTML for errors

at line 490
void fixErrors()

Reverts erroneous fields to their default values

Return Value

void

at line 544
bool save(array $forms, bool $allowPartialSave = true)

Validates and saves form data to session

Parameters

array $forms

List of form names.
bool $allowPartialSave

Allows for partial form saving on failed validation.

Return Value

bool

at line 704
bool hasErrors()

Tells whether form validation failed

Return Value

bool

Returns link to documentation

Parameters

string $path

Path to documentation

Return Value

string