class Plugins

PhpMyAdmin\Plugins class

Methods

static object|null
getPlugin(string $plugin_type, string $plugin_format, string $plugins_dir, mixed $plugin_param = false)

Includes and instantiates the specified plugin type for a certain format

static array
getPlugins(string $plugin_type, string $plugins_dir, mixed $plugin_param)

Reads all plugin information from directory $plugins_dir

static string
getString(string $name)

Returns locale string for $name or $name if no locale is found

static string
checkboxCheck(string $section, string $opt)

Returns html input tag option 'checked' if plugin $opt should be set by config or request

static string
getDefault(string $section, string $opt)

Returns default value for option $opt

static string
getChoice(string $section, string $name, array $list, string $cfgname = null)

Returns html select form element for plugin choice and hidden fields denoting whether each plugin must be exported as a file

static string
getOneOption(string $section, string $plugin_name, array|PropertyItem $propertyGroup, boolean $is_subgroup = false)

Returns single option in a list element

static string
getHtmlForProperty(string $section, string $plugin_name, OptionsPropertyItem $propertyItem)

Get HTML for properties items

static string
getOptions(string $section, array $list)

Returns html div with editable options for plugin

Details

at line 36
static object|null getPlugin(string $plugin_type, string $plugin_format, string $plugins_dir, mixed $plugin_param = false)

Includes and instantiates the specified plugin type for a certain format

Parameters

string $plugin_type the type of the plugin (import, export, etc)
string $plugin_format the format of the plugin (sql, xml, et )
string $plugins_dir directory with plugins
mixed $plugin_param parameter to plugin by which they can decide whether they can work

Return Value

object|null new plugin instance

at line 70
static array getPlugins(string $plugin_type, string $plugins_dir, mixed $plugin_param)

Reads all plugin information from directory $plugins_dir

Parameters

string $plugin_type the type of the plugin (import, export, etc)
string $plugins_dir directory with plugins
mixed $plugin_param parameter to plugin by which they can decide whether they can work

Return Value

array list of plugin instances

at line 125
static string getString(string $name)

Returns locale string for $name or $name if no locale is found

Parameters

string $name for local string

Return Value

string locale string for $name

at line 140
static string checkboxCheck(string $section, string $opt)

Returns html input tag option 'checked' if plugin $opt should be set by config or request

Parameters

string $section name of config section in $GLOBALS['cfg'][$section] for plugin
string $opt name of option

Return Value

string html input tag option 'checked'

at line 162
static string getDefault(string $section, string $opt)

Returns default value for option $opt

Parameters

string $section name of config section in $GLOBALS['cfg'][$section] for plugin
string $opt name of option

Return Value

string default value for option $opt

at line 211
static string getChoice(string $section, string $name, array $list, string $cfgname = null)

Returns html select form element for plugin choice and hidden fields denoting whether each plugin must be exported as a file

Parameters

string $section name of config section in $GLOBALS['cfg'][$section] for plugin
string $name name of select element
array $list array with plugin instances
string $cfgname name of config value, if none same as $name

Return Value

string html select tag

at line 278
static string getOneOption(string $section, string $plugin_name, array|PropertyItem $propertyGroup, boolean $is_subgroup = false)

Returns single option in a list element

Parameters

string $section name of config section in $GLOBALS['cfg'][$section] for plugin
string $plugin_name unique plugin name
array|PropertyItem $propertyGroup &$propertyGroup options property main group instance
boolean $is_subgroup if this group is a subgroup

Return Value

string table row with option

at line 412
static string getHtmlForProperty(string $section, string $plugin_name, OptionsPropertyItem $propertyItem)

Get HTML for properties items

Parameters

string $section name of config section in $GLOBALS['cfg'][$section] for plugin
string $plugin_name unique plugin name
OptionsPropertyItem $propertyItem Property item

Return Value

string

at line 569
static string getOptions(string $section, array $list)

Returns html div with editable options for plugin

Parameters

string $section name of config section in $GLOBALS['cfg'][$section]
array $list array with plugin instances

Return Value

string html fieldset with plugin options