class Plugins (View source)

Methods

static object|null
getPlugin(string $type, string $format, ExportType $exportType = ExportType::Raw, bool $singleTable = false)

Instantiates the specified plugin type for a certain format

static array
getExport(ExportType $type, bool $singleTable)

No description

static array
getImport()

No description

static array
getSchema()

No description

static string
checkboxCheck(PluginType $pluginType, string $opt)

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

static string
validatePluginNameOrUseDefault(array $plugins, string $pluginName)

Validates the plugin name and returns it, or falls back to 'sql' if invalid.

static string
getDefault(PluginType $pluginType, string $opt)

Returns default value for option $opt

static array
getChoice(array $list, string $default)

No description

static string
getOptions(PluginType $pluginType, array $list)

Returns html div with editable options for plugin

static string
getDocumentationLinkHtml(OptionsPropertyOneItem $propertyGroup)

No description

Details

static object|null getPlugin(string $type, string $format, ExportType $exportType = ExportType::Raw, bool $singleTable = false)

Instantiates the specified plugin type for a certain format

Parameters

string $type

the type of the plugin (import, export, etc)

string $format

the format of the plugin (sql, xml, et )

ExportType $exportType
bool $singleTable

Return Value

object|null

new plugin instance

static array getExport(ExportType $type, bool $singleTable)

No description

Parameters

ExportType $type
bool $singleTable

Return Value

array

static array getImport()

No description

Return Value

array

static array getSchema()

No description

Return Value

array

static string checkboxCheck(PluginType $pluginType, string $opt)

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

Parameters

PluginType $pluginType
string $opt

name of option

Return Value

string

html input tag option 'checked'

static string validatePluginNameOrUseDefault(array $plugins, string $pluginName)

Validates the plugin name and returns it, or falls back to 'sql' if invalid.

Parameters

array $plugins
string $pluginName

Return Value

string

static string getDefault(PluginType $pluginType, string $opt)

Returns default value for option $opt

Parameters

PluginType $pluginType

type of the plugin

string $opt

name of option

Return Value

string

default value for option $opt

static array getChoice(array $list, string $default)

No description

Parameters

array $list
string $default

Return Value

array

static string getOptions(PluginType $pluginType, array $list)

Returns html div with editable options for plugin

Parameters

PluginType $pluginType
array $list

array with plugin instances

Return Value

string

html fieldset with plugin options

static string getDocumentationLinkHtml(OptionsPropertyOneItem $propertyGroup)

No description

Parameters

OptionsPropertyOneItem $propertyGroup

Return Value

string