MCI_Footnotes_LayoutEngine
Layout Engine for the administration dashboard.
Tags
Table of Contents
- $a_arr_Sections : array<string|int, mixed>
- Stores all Sections for the child sub page.
- $a_str_SubPageHook : null|string
- Stores the Hook connection string for the child sub page.
- Description() : mixed
- Output the Description of a section. May be overwritten in any section.
- displayContent() : mixed
- Displays the content of specific sub page.
- getPriority() : int
- Returns a Priority index. Lower numbers have a higher Priority.
- registerSections() : mixed
- Registers all sections for a sub page.
- registerSubPage() : mixed
- Registers a sub page.
- addCheckbox() : string
- Returns the html tag for an input [type = checkbox].
- addColorSelection() : string
- Returns the html tag for an input [type = text] with color selection class.
- addLabel() : string
- Returns the html tag for an input/select label.
- addLineSpace() : string
- Returns a line break to have a space between two lines.
- addMetaBox() : array<string|int, mixed>
- Returns an array describing a meta box.
- addNewline() : string
- Returns a line break to start a new line.
- addNumBox() : string
- Returns the html tag for an input [type = num].
- addSection() : array<string|int, mixed>
- Returns an array describing a sub page section.
- addSelectBox() : string
- Returns the html tag for a select box.
- addText() : string
- Returns a simple text inside html <span> text.
- addTextArea() : string
- Returns the html tag for a text area.
- addTextBox() : string
- Returns the html tag for an input [type = text].
- getMetaBoxes() : array<string|int, mixed>
- Returns an array of all registered meta boxes.
- getSections() : array<string|int, mixed>
- Returns an array of all registered sections for a sub page.
- getSubPageSlug() : string
- Returns the unique slug of the child sub page.
- getSubPageTitle() : string
- Returns the title of the child sub page.
- LoadSetting() : array<string|int, mixed>
- Loads specific setting and returns an array with the keys [id, name, value].
- appendScripts() : mixed
- Append javascript and css files for specific sub page.
- registerMetaBoxes() : mixed
- Registers all Meta boxes for a sub page.
- saveSettings() : bool
- Save all Plugin settings.
Properties
$a_arr_Sections
Stores all Sections for the child sub page.
protected
array<string|int, mixed>
$a_arr_Sections
= array()
Tags
$a_str_SubPageHook
Stores the Hook connection string for the child sub page.
protected
null|string
$a_str_SubPageHook
=
ull
Tags
Methods
Description()
Output the Description of a section. May be overwritten in any section.
public
Description() : mixed
Tags
Return values
mixed —displayContent()
Displays the content of specific sub page.
public
displayContent() : mixed
Tags
Return values
mixed —getPriority()
Returns a Priority index. Lower numbers have a higher Priority.
public
abstract getPriority() : int
Tags
Return values
int —registerSections()
Registers all sections for a sub page.
public
registerSections() : mixed
Tags
Return values
mixed —registerSubPage()
Registers a sub page.
public
registerSubPage() : mixed
Tags
Return values
mixed —addCheckbox()
Returns the html tag for an input [type = checkbox].
protected
addCheckbox(string $p_str_SettingName) : string
Parameters
- $p_str_SettingName : string
-
Name of the Settings key to pre load the input field.
Tags
Return values
string —addColorSelection()
Returns the html tag for an input [type = text] with color selection class.
protected
addColorSelection(string $p_str_SettingName) : string
Parameters
- $p_str_SettingName : string
-
Name of the Settings key to pre load the input field.
Tags
Return values
string —addLabel()
Returns the html tag for an input/select label.
protected
addLabel(string $p_str_SettingName, string $p_str_Caption) : string
Parameters
- $p_str_SettingName : string
-
Name of the Settings key to connect the Label with the input/select field.
- $p_str_Caption : string
-
Label caption.
Tags
Return values
string —Edited 2020-12-01T0159+0100..
addLineSpace()
Returns a line break to have a space between two lines.
protected
addLineSpace() : string
Tags
Return values
string —addMetaBox()
Returns an array describing a meta box.
protected
addMetaBox(string $p_str_SectionID, string $p_str_ID, string $p_str_Title, string $p_str_CallbackFunctionName) : array<string|int, mixed>
Parameters
- $p_str_SectionID : string
-
Parent Section ID.
- $p_str_ID : string
-
Unique ID suffix.
- $p_str_Title : string
-
Title for the meta box.
- $p_str_CallbackFunctionName : string
-
Class method name for callback.
Tags
Return values
array<string|int, mixed> —meta box description to be able to append a meta box to the output.
addNewline()
Returns a line break to start a new line.
protected
addNewline() : string
Tags
Return values
string —addNumBox()
Returns the html tag for an input [type = num].
protected
addNumBox(string $p_str_SettingName, int $p_in_Min, int $p_int_Max[, bool $p_bool_Deci = false ]) : string
Parameters
- $p_str_SettingName : string
-
Name of the Settings key to pre load the input field.
- $p_in_Min : int
-
Minimum value.
- $p_int_Max : int
-
Maximum value.
- $p_bool_Deci : bool = false
-
true if 0.1 steps and floating to string, false if integer (default)
Tags
Return values
string —Edited:
addSection()
Returns an array describing a sub page section.
protected
addSection(string $p_str_ID, string $p_str_Title, int $p_int_SettingsContainerIndex[, bool $p_bool_hasSubmitButton = true ]) : array<string|int, mixed>
Parameters
- $p_str_ID : string
-
Unique ID suffix.
- $p_str_Title : string
-
Title of the section.
- $p_int_SettingsContainerIndex : int
-
Settings Container Index.
- $p_bool_hasSubmitButton : bool = true
-
Should a Submit Button be displayed for this section, default: true.
Tags
Return values
array<string|int, mixed> —Array describing the section.
addSelectBox()
Returns the html tag for a select box.
protected
addSelectBox(string $p_str_SettingName, array<string|int, mixed> $p_arr_Options) : string
Parameters
- $p_str_SettingName : string
-
Name of the Settings key to pre select the current value.
- $p_arr_Options : array<string|int, mixed>
-
Possible options to be selected.
Tags
Return values
string —addText()
Returns a simple text inside html <span> text.
protected
addText(string $p_str_Text) : string
Parameters
- $p_str_Text : string
-
Message to be surrounded with simple html tag (span).
Tags
Return values
string —addTextArea()
Returns the html tag for a text area.
protected
addTextArea(string $p_str_SettingName) : string
Parameters
- $p_str_SettingName : string
-
Name of the Settings key to pre fill the text area.
Tags
Return values
string —addTextBox()
Returns the html tag for an input [type = text].
protected
addTextBox(string $p_str_SettingName[, int $p_str_MaxLength = 999 ][, bool $p_bool_Readonly = false ][, bool $p_bool_Hidden = false ]) : string
Parameters
- $p_str_SettingName : string
-
Name of the Settings key to pre load the input field.
- $p_str_MaxLength : int = 999
-
Maximum length of the input, default 999 characters.
- $p_bool_Readonly : bool = false
-
Set the input to be read only, default false.
- $p_bool_Hidden : bool = false
-
Set the input to be hidden, default false.
Tags
Return values
string —getMetaBoxes()
Returns an array of all registered meta boxes.
protected
abstract getMetaBoxes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getSections()
Returns an array of all registered sections for a sub page.
protected
abstract getSections() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getSubPageSlug()
Returns the unique slug of the child sub page.
protected
abstract getSubPageSlug() : string
Tags
Return values
string —getSubPageTitle()
Returns the title of the child sub page.
protected
abstract getSubPageTitle() : string
Tags
Return values
string —LoadSetting()
Loads specific setting and returns an array with the keys [id, name, value].
protected
LoadSetting(string $p_str_SettingKeyName) : array<string|int, mixed>
Parameters
- $p_str_SettingKeyName : string
-
Settings Array key name.
Tags
Return values
array<string|int, mixed> —Contains Settings ID, Settings Name and Settings Value.
appendScripts()
Append javascript and css files for specific sub page.
private
appendScripts() : mixed
Tags
Return values
mixed —registerMetaBoxes()
Registers all Meta boxes for a sub page.
private
registerMetaBoxes(string $p_str_ParentID) : mixed
Parameters
- $p_str_ParentID : string
-
Parent section unique id.
Tags
Return values
mixed —saveSettings()
Save all Plugin settings.
private
saveSettings() : bool