1. class
  2. PhpMyAdmin
  3. \
  4. Config
  5. \
  6. Forms
  7. \
  8. Setup
  9. \
  10. MainForm

MainForm

class MainForm extends MainForm (View source)

Methods

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

No description

from  BaseForm
ConfigFile
getConfigFile()

Returns ConfigFile associated with this instance

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

Registers form in form manager

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

Processes forms, returns true on successful save

from  FormDisplay
string
getDisplay(bool $showButtons = true, string $formAction = '', array $hiddenFields = [])

Outputs HTML for forms

from  FormDisplay
string
displayErrors()

Displays errors

from  FormDisplay
void
fixErrors()

Reverts erroneous fields to their default values

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

Validates and saves form data to session

from  FormDisplay
bool
hasErrors()

Tells whether form validation failed

from  FormDisplay
string
getDocLink(string $path)

Returns link to documentation

from  FormDisplay
array
getRegisteredForms()

No description

from  FormDisplay
static array
getForms()

No description

static array
getFields()

Returns list of fields used in the form.

from  BaseForm
static string
getName()

Returns name of the form

from  MainForm

Details

in BaseForm at line 24
final __construct(ConfigFile $cf, int|null $serverId = null)

No description

Parameters

ConfigFile $cf

Config file instance
int|null $serverId

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

in FormDisplay at line 114
ConfigFile getConfigFile()

Returns ConfigFile associated with this instance

Return Value

ConfigFile

in FormDisplay at line 126
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

in FormDisplay at line 146
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

in FormDisplay at line 212
string getDisplay(bool $showButtons = true, string $formAction = '', array $hiddenFields = [])

Outputs HTML for forms

Parameters

bool $showButtons

whether show submit and reset button
string $formAction

action attribute for the form
array $hiddenFields

array of form hidden fields (key: field name)

Return Value

string

HTML for forms

in FormDisplay at line 466
string displayErrors()

Displays errors

Return Value

string

HTML for errors

in FormDisplay at line 488
void fixErrors()

Reverts erroneous fields to their default values

Return Value

void

in FormDisplay at line 542
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

in FormDisplay at line 702
bool hasErrors()

Tells whether form validation failed

Return Value

bool

Returns link to documentation

Parameters

string $path

Path to documentation

Return Value

string

in FormDisplay at line 842
array getRegisteredForms()

No description

Return Value

array

at line 13
static array getForms()

No description

Return Value

array

in BaseForm at line 64
static array getFields()

Returns list of fields used in the form.

Return Value

array

in MainForm at line 74
static string getName()

Returns name of the form

Return Value

string