class Binlog extends StorageEngine

The binary log storage engine

Properties

string $engine from StorageEngine
string $title from StorageEngine
string $comment from StorageEngine
int $support from StorageEngine

Methods

__construct(string $engine)

No description

static array[]
getStorageEngines()

Returns array of storage engines

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

Returns HTML code for storage engine select box

static StorageEngine
getEngine(string $engine)

Loads the corresponding engine plugin, if available.

static bool
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(int $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

in StorageEngine at line 64
__construct(string $engine)

Parameters

string $engine The engine ID

in StorageEngine at line 97
static array[] getStorageEngines()

Returns array of storage engines

Return Value

array[] array of storage engines

in StorageEngine at line 138
static string getHtmlSelect(string $name = 'engine', string $id = null, string $selected = null, bool $offerUnavailableEngines = false, bool $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
bool $offerUnavailableEngines Should unavailable storage engines be offered?
bool $addEmpty Whether to provide empty option

Return Value

string html selectbox

in StorageEngine at line 186
static StorageEngine getEngine(string $engine)

Loads the corresponding engine plugin, if available.

Parameters

string $engine The engine ID

Return Value

StorageEngine The engine plugin

in StorageEngine at line 227
static bool isValid(string $engine)

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

Parameters

string $engine name of engine

Return Value

bool whether $engine is valid or not

in StorageEngine at line 242
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

in StorageEngine at line 302
array resolveTypeSize(int $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

int $value Value to format

Return Value

array the formatted value and its unit

in StorageEngine at line 312
array getVariablesStatus()

Returns array with detailed info about engine specific server variables

Return Value

array array with detailed info about specific engine server variables

in StorageEngine at line 357
string getTitle()

Reveals the engine's title

Return Value

string The title

in StorageEngine at line 367
string getComment()

Fetches the server's comment about this engine

Return Value

string The comment

in StorageEngine at line 377
string getSupportInformationMessage()

Information message on whether this storage engine is supported

Return Value

string The localized message.

in StorageEngine at line 405
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 22
string getMysqlHelpPage()

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

Return Value

string MySQL help page filename

in StorageEngine at line 427
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

in StorageEngine at line 437
string[] getInfoPages()

Returns a list of available information pages with labels

Return Value

string[] The list

in StorageEngine at line 449
string getPage(string $id)

Generates the requested information page

Parameters

string $id page id

Return Value

string html output