nettika/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libraries/storage_engines.lib.php revised:

Browse Source 
- added PHP 5 constructor
- added comments
- PEAR coding standard
This commit is contained in:
Sebastian Mendel
2005-12-06 12:24:35 +00:00
parent 91c3b852de
commit d0a1d17561
1 changed files with 140 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

195
libraries/storage_engines.lib.php
View File

@@ -65,31 +65,34 @@ if (PMA_MYSQL_INT_VERSION >= 40102) {
/** /**
* Function for generating the storage engine selection * Function for generating the storage engine selection
* *
* @param string The name of the select form element
* @param string The ID of the form field
* @param boolean Should unavailable storage engines be offered?
* @param string The selected engine
* @param int The indentation level
*
* @global array The storage engines
*
* @return string
*
* @author rabus * @author rabus
* @uses $GLOBALS['mysql_storage_engines']
* @param string $name The name of the select form element
* @param string $id The ID of the form field
* @param boolean $offerUnavailableEngines
* Should unavailable storage engines be offered?
* @param string $selected The selected engine
* @param int $indent The indentation level
* @return string html selectbox
*/ */
function PMA_generateEnginesDropdown($name = 'engine', $id = NULL, $offerUnavailableEngines = FALSE, $selected = NULL, $indent = 0) { function PMA_generateEnginesDropdown($name = 'engine', $id = null,
global $mysql_storage_engines; $offerUnavailableEngines = false, $selected = null, $indent = 0)
{
$selected = strtolower($selected); $selected = strtolower($selected);
$spaces = ''; $spaces = str_repeat( ' ', $indent );
for ($i = 0; $i < $indent; $i++) $spaces .= ' '; $output = $spaces . '<select name="' . $name . '"'
$output = $spaces . '<select name="' . $name . '"' . (empty($id) ? '' : ' id="' . $id . '"') . '>' . "\n"; . (empty($id) ? '' : ' id="' . $id . '"') . '>' . "\n";
foreach ($mysql_storage_engines as $key => $details) {
if (!$offerUnavailableEngines && ($details['Support'] == 'NO' || $details['Support'] == 'DISABLED')) { foreach ($GLOBALS['mysql_storage_engines'] as $key => $details) {
if (!$offerUnavailableEngines
&& ($details['Support'] == 'NO' || $details['Support'] == 'DISABLED')) {
continue; continue;
} }
$output .= $spaces . ' <option value="' . htmlspecialchars($key). '"' $output .= $spaces . ' <option value="' . htmlspecialchars($key). '"'
. (empty($details['Comment']) ? '' : ' title="' . htmlspecialchars($details['Comment']) . '"') . (empty($details['Comment'])
. ($key == $selected || (empty($selected) && $details['Support'] == 'DEFAULT') ? ' selected="selected"' : '') . '>' . "\n" ? '' : ' title="' . htmlspecialchars($details['Comment']) . '"')
. ($key == $selected || (empty($selected) && $details['Support'] == 'DEFAULT')
? ' selected="selected"' : '') . '>' . "\n"
. $spaces . ' ' . htmlspecialchars($details['Engine']) . "\n" . $spaces . ' ' . htmlspecialchars($details['Engine']) . "\n"
. $spaces . ' </option>' . "\n"; . $spaces . ' </option>' . "\n";
} }
@@ -98,30 +101,54 @@ function PMA_generateEnginesDropdown($name = 'engine', $id = NULL, $offerUnavail
} }
/** /**
* Abstract Storage Engine Class * defines
*/ */
define('PMA_ENGINE_SUPPORT_NO', 0); define('PMA_ENGINE_SUPPORT_NO', 0);
define('PMA_ENGINE_SUPPORT_DISABLED', 1); define('PMA_ENGINE_SUPPORT_DISABLED', 1);
define('PMA_ENGINE_SUPPORT_YES', 2); define('PMA_ENGINE_SUPPORT_YES', 2);
define('PMA_ENGINE_SUPPORT_DEFAULT', 3); define('PMA_ENGINE_SUPPORT_DEFAULT', 3);
class PMA_StorageEngine {
/**
* Abstract Storage Engine Class
*/
class PMA_StorageEngine
{
/**
* @var string engine name
*/
var $engine = 'dummy'; var $engine = 'dummy';
/**
* @var string engine title/description
*/
var $title = 'PMA Dummy Engine Class'; var $title = 'PMA Dummy Engine Class';
/**
* @var string engine lang description
*/
var $comment = 'If you read this text inside phpMyAdmin, something went wrong...'; var $comment = 'If you read this text inside phpMyAdmin, something went wrong...';
/**
* @var integer engine supported by current server
*/
var $support = PMA_ENGINE_SUPPORT_NO; var $support = PMA_ENGINE_SUPPORT_NO;
/** /**
* public static final PMA_StorageEngine getEngine () * public static final PMA_StorageEngine getEngine()
* *
* Loads the corresponding engine plugin, if available. * Loads the corresponding engine plugin, if available.
* *
* @param String The engine ID * @uses str_replace()
* * @uses file_exists()
* @return Object The engine plugin * @uses PMA_StorageEngine
* @param string $engine The engine ID
* @return object The engine plugin
*/ */
function getEngine ($engine) { function getEngine($engine)
{
$engine = str_replace('/', '', str_replace('.', '', $engine)); $engine = str_replace('/', '', str_replace('.', '', $engine));
if (file_exists('./libraries/engines/' . $engine . '.lib.php') && include_once('./libraries/engines/' . $engine . '.lib.php')) { if (file_exists('./libraries/engines/' . $engine . '.lib.php')
&& include_once('./libraries/engines/' . $engine . '.lib.php')) {
$class_name = 'PMA_StorageEngine_' . $engine; $class_name = 'PMA_StorageEngine_' . $engine;
$engine_object = new $class_name($engine); $engine_object = new $class_name($engine);
} else { } else {
@@ -133,16 +160,27 @@ class PMA_StorageEngine {
/** /**
* Constructor * Constructor
* *
* @param String The engine ID * @uses $GLOBALS['mysql_storage_engines']
* @uses PMA_ENGINE_SUPPORT_DEFAULT
* @uses PMA_ENGINE_SUPPORT_YES
* @uses PMA_ENGINE_SUPPORT_DISABLED
* @uses PMA_ENGINE_SUPPORT_NO
* @uses $this->engine
* @uses $this->title
* @uses $this->comment
* @uses $this->support
* @param string $engine The engine ID
*/ */
function PMA_StorageEngine ($engine) { function __construct($engine)
global $mysql_storage_engines; {
if (!empty($GLOBALS['mysql_storage_engines'][$engine])) {
if (!empty($mysql_storage_engines[$engine])) {
$this->engine = $engine; $this->engine = $engine;
$this->title = $mysql_storage_engines[$engine]['Engine']; $this->title = $GLOBALS['mysql_storage_engines'][$engine]['Engine'];
$this->comment = (isset($mysql_storage_engines[$engine]['Comment']) ? $mysql_storage_engines[$engine]['Comment'] : ''); $this->comment =
switch ($mysql_storage_engines[$engine]['Support']) { (isset($GLOBALS['mysql_storage_engines'][$engine]['Comment'])
? $GLOBALS['mysql_storage_engines'][$engine]['Comment']
: '');
switch ($GLOBALS['mysql_storage_engines'][$engine]['Support']) {
case 'DEFAULT': case 'DEFAULT':
$this->support = PMA_ENGINE_SUPPORT_DEFAULT; $this->support = PMA_ENGINE_SUPPORT_DEFAULT;
break; break;
@@ -160,33 +198,60 @@ class PMA_StorageEngine {
} }
/** /**
* public String getTitle () * old PHP 4 style constructor
* @deprecated
* @see PMA_StorageEngine::__construct()
* @uses PMA_StorageEngine::__construct()
* @param string $engine engine name
*/
function PMA_StorageEngine($engine)
{
$this->__construct();
}
/**
* public String getTitle()
* *
* Reveals the engine's title * Reveals the engine's title
* * @uses $this->title
* @return String The title * @return string The title
*/ */
function getTitle () { function getTitle()
{
return $this->title; return $this->title;
} }
/** /**
* public String getComment () * public String getComment()
* *
* Fetches the server's comment about this engine * Fetches the server's comment about this engine
* * @uses $this->comment
* @return String The comment * @return string The comment
*/ */
function getComment () { function getComment()
{
return $this->comment; return $this->comment;
} }
/** /**
* public String getSupportInformationMessage () * public String getSupportInformationMessage()
* *
* @return String The localized message. * @uses $GLOBALS['strDefaultEngine']
* @uses $GLOBALS['strEngineAvailable']
* @uses $GLOBALS['strEngineDisabled']
* @uses $GLOBALS['strEngineUnsupported']
* @uses $GLOBALS['strEngineUnsupported']
* @uses PMA_ENGINE_SUPPORT_DEFAULT
* @uses PMA_ENGINE_SUPPORT_YES
* @uses PMA_ENGINE_SUPPORT_DISABLED
* @uses PMA_ENGINE_SUPPORT_NO
* @uses $this->support
* @uses $this->title
* @uses sprintf
* @return string The localized message.
*/ */
function getSupportInformationMessage () { function getSupportInformationMessage()
{
switch ($this->support) { switch ($this->support) {
case PMA_ENGINE_SUPPORT_DEFAULT: case PMA_ENGINE_SUPPORT_DEFAULT:
$message = $GLOBALS['strDefaultEngine']; $message = $GLOBALS['strDefaultEngine'];
@@ -205,48 +270,58 @@ class PMA_StorageEngine {
} }
/** /**
* public String[][] getVariables () * public string[][] getVariables()
* *
* Generates a list of MySQL variables that provide information about this * Generates a list of MySQL variables that provide information about this
* engine. This function should be overridden when extending this class * engine. This function should be overridden when extending this class
* for a particular engine. * for a particular engine.
* *
* @abstract
* @return Array The list of variables. * @return Array The list of variables.
*/ */
function getVariables () { function getVariables()
{
return array(); return array();
} }
/** /**
* public String getVariablesLikePattern () * public string getVariablesLikePattern()
*
* @abstract
* @return string SQL query LIKE pattern
*/ */
function getVariablesLikePattern () { function getVariablesLikePattern()
return FALSE; {
return false;
} }
/** /**
* public String[] getInfoPages () * public String[] getInfoPages()
* *
* Returns a list of available information pages with labels * Returns a list of available information pages with labels
* *
* @return Array The list * @abstract
* @return array The list
*/ */
function getInfoPages () { function getInfoPages()
{
return array(); return array();
} }
/** /**
* public String getPage () * public String getPage()
* *
* Generates the requested information page * Generates the requested information page
* *
* @param String The page ID * @abstract
* @param string $id The page ID
* *
* @return String The page * @return string The page
* boolean or FALSE on error. * boolean or false on error.
*/ */
function getPage($id) { function getPage($id)
return FALSE; {
return false;
} }
} }