class StorageEngine

Base Storage Engine Class

Properties

string $engine
string $title
string $comment
integer $support

Methods

__construct(string $engine)

Constructor

static array[]
getStorageEngines()

Returns array of storage engines

static string
getHtmlSelect(string $name = 'engine', string $id = null, string $selected = null, boolean $offerUnavailableEngines = false, boolean $addEmpty = false)

Returns HTML code for storage engine select box

static StorageEngine
getEngine(string $engine)

Loads the corresponding engine plugin, if available.

static boolean
isValid(string $engine)

Returns true if given engine name is supported/valid, otherwise false

string
getHtmlVariables()

Returns as HTML table of the engine's server variables

array
resolveTypeSize(integer $value)

Returns the engine specific handling for PMA_ENGINE_DETAILS_TYPE_SIZE type variables.

array
getVariablesStatus()

Returns array with detailed info about engine specific server variables

string
getTitle()

Reveals the engine's title

string
getComment()

Fetches the server's comment about this engine

string
getSupportInformationMessage()

Information message on whether this storage engine is supported

array
getVariables()

Generates a list of MySQL variables that provide information about this engine. This function should be overridden when extending this class for a particular engine.

string
getMysqlHelpPage()

Returns string with filename for the MySQL helppage about this storage engine

string
getVariablesLikePattern()

Returns the pattern to be used in the query for SQL variables related to the storage engine

string[]
getInfoPages()

Returns a list of available information pages with labels

string
getPage(string $id)

Generates the requested information page

Details

at line 71
__construct(string $engine)

Constructor

Parameters

string $engine The engine ID

at line 105
static array[] getStorageEngines()

Returns array of storage engines

Return Value

array[] array of storage engines

at line 145
static string getHtmlSelect(string $name = 'engine', string $id = null, string $selected = null, boolean $offerUnavailableEngines = false, boolean $addEmpty = false)

Returns HTML code for storage engine select box

Parameters

string $name The name of the select form element
string $id The ID of the form field
string $selected The selected engine
boolean $offerUnavailableEngines Should unavailable storage engines be offered?
boolean $addEmpty Whether to provide empty option

Return Value

string html selectbox

at line 192
static StorageEngine getEngine(string $engine)

Loads the corresponding engine plugin, if available.

Parameters

string $engine The engine ID

Return Value

StorageEngine The engine plugin

at line 232
static boolean isValid(string $engine)

Returns true if given engine name is supported/valid, otherwise false

Parameters

string $engine name of engine

Return Value

boolean whether $engine is valid or not

at line 247
string getHtmlVariables()

Returns as HTML table of the engine's server variables

Return Value

string The table that was generated based on the retrieved information

at line 307
array resolveTypeSize(integer $value)

Returns the engine specific handling for PMA_ENGINE_DETAILS_TYPE_SIZE type variables.

This function should be overridden when PMA_ENGINE_DETAILS_TYPE_SIZE type needs to be handled differently for a particular engine.

Parameters

integer $value Value to format

Return Value

array the formatted value and its unit

at line 317
array getVariablesStatus()

Returns array with detailed info about engine specific server variables

Return Value

array array with detailed info about specific engine server variables

at line 362
string getTitle()

Reveals the engine's title

Return Value

string The title

at line 372
string getComment()

Fetches the server's comment about this engine

Return Value

string The comment

at line 382
string getSupportInformationMessage()

Information message on whether this storage engine is supported

Return Value

string The localized message.

at line 410
array getVariables()

Generates a list of MySQL variables that provide information about this engine. This function should be overridden when extending this class for a particular engine.

Return Value

array The list of variables.

at line 421
string getMysqlHelpPage()

Returns string with filename for the MySQL helppage about this storage engine

Return Value

string MySQL help page filename

at line 432
string getVariablesLikePattern()

Returns the pattern to be used in the query for SQL variables related to the storage engine

Return Value

string SQL query LIKE pattern

at line 442
string[] getInfoPages()

Returns a list of available information pages with labels

Return Value

string[] The list

at line 454
string getPage(string $id)

Generates the requested information page

Parameters

string $id page id

Return Value

string html output