StorageEngine
class StorageEngine (View source)
Library for extracting information about the available storage engines
Constants
| protected SUPPORT_NO |
|
| protected SUPPORT_DISABLED |
|
| protected SUPPORT_YES |
|
| protected SUPPORT_DEFAULT |
|
| protected DETAILS_TYPE_PLAINTEXT |
|
| protected DETAILS_TYPE_SIZE |
|
| protected DETAILS_TYPE_NUMERIC |
|
| protected DETAILS_TYPE_BOOLEAN |
|
Properties
| string | $engine | ||
| string | $title | ||
| string | $comment | ||
| int | $support | Engine supported by current server. |
Methods
No description
Returns array of storage engines
Returns if Mroonga is available to be used
Get the lengths of a table of database
No description
Loads the corresponding engine plugin, if available.
Returns true if given engine name is supported/valid, otherwise false
Returns as HTML table of the engine's server variables
Returns the engine specific handling for DETAILS_TYPE_SIZE type variables.
Returns array with detailed info about engine specific server variables
Reveals the engine's title
Fetches the server's comment about this engine
Information message on whether this storage engine is supported
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.
Returns string with filename for the MySQL helppage about this storage engine
Returns the pattern to be used in the query for SQL variables related to the storage engine
Returns a list of available information pages with labels
Generates the requested information page
Details
__construct(string $engine)
No description
static array
getStorageEngines()
Returns array of storage engines
static bool
hasMroongaEngine()
Returns if Mroonga is available to be used
This is public to be used in the StructureComtroller, the first release of this function was looking Mroonga in the engines list but this second method checks too that mroonga is installed successfully
static array
getMroongaLengths(string $dbName, string $tableName)
Get the lengths of a table of database
static array
getArray()
No description
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|string $value)
Returns the engine specific handling for DETAILS_TYPE_SIZE type variables.
This function should be overridden when DETAILS_TYPE_SIZE type needs to be handled differently for a particular engine.
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
array
getInfoPages()
Returns a list of available information pages with labels
string
getPage(string $id)
Generates the requested information page