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

Fix some phpdoc errors.

Browse Source
This commit is contained in:
Michal Čihař
2008-11-24 09:55:30 +00:00
parent 610cc27c57
commit 9561f56875
19 changed files with 182 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

201
libraries/Index.class.php
View File

@@ -4,11 +4,12 @@
* holds the datasbe index class
*
* @version $Id$
* @package phpMyAdmin
*/
/**
* @since phpMyAdmin 3.0.0
*
*
*/
class PMA_Index
{
@@ -18,29 +19,29 @@ class PMA_Index
* @var array
*/
protected static $_registry = array();
/**
* @var string The name of the schema
*/
protected $_schema = '';
/**
* @var string The name of the table
*/
protected $_table = '';
/**
* @var string The name of the index
*/
protected $_name = '';
/**
* Columns in index
*
* @var array
*/
protected $_columns = array();
/**
* The index method used (BTREE, FULLTEXT, HASH, RTREE).
*
@@ -54,34 +55,34 @@ class PMA_Index
* @var string
*/
protected $_choice = '';
/**
* Various remarks.
*
* @var string
*/
protected $_remarks = '';
/**
* Any comment provided for the index with a COMMENT attribute when the
* Any comment provided for the index with a COMMENT attribute when the
* index was created.
*
* @var string
*/
protected $_comment = '';
/**
* @var integer 0 if the index cannot contain duplicates, 1 if it can.
* @var integer 0 if the index cannot contain duplicates, 1 if it can.
*/
protected $_non_unique = 0;
/**
* Indicates how the key is packed. NULL if it is not.
*
* @var string
*/
protected $_packed = null;
/**
* Constructor
*
@@ -92,7 +93,7 @@ class PMA_Index
{
$this->set($params);
}
static public function singleton($schema, $table, $index_name = '')
{
PMA_Index::_loadIndexes($table, $schema);
@@ -107,7 +108,7 @@ class PMA_Index
return PMA_Index::$_registry[$schema][$table][$index_name];
}
}
/**
* returns an array with all indexes from the given table
*
@@ -120,14 +121,14 @@ class PMA_Index
static public function getFromTable($table, $schema)
{
PMA_Index::_loadIndexes($table, $schema);
if (isset(PMA_Index::$_registry[$schema][$table])) {
return PMA_Index::$_registry[$schema][$table];
} else {
return array();
}
}
/**
* return primary if set, false otherwise
*
@@ -140,14 +141,14 @@ class PMA_Index
static public function getPrimary($table, $schema)
{
PMA_Index::_loadIndexes($table, $schema);
if (isset(PMA_Index::$_registry[$schema][$table]['PRIMARY'])) {
return PMA_Index::$_registry[$schema][$table]['PRIMARY'];
} else {
return false;
}
}
/**
* Load index data for table
*
@@ -165,7 +166,7 @@ class PMA_Index
if (isset(PMA_Index::$_registry[$schema][$table])) {
return true;
}
$_raw_indexes = PMA_DBI_fetch_result('SHOW INDEX FROM ' . PMA_backquote($schema) . '.' . PMA_backquote($table));
foreach ($_raw_indexes as $_each_index) {
$_each_index['Schema'] = $schema;
@@ -175,13 +176,13 @@ class PMA_Index
} else {
$key = PMA_Index::$_registry[$schema][$table][$_each_index['Key_name']];
}
$key->addColumn($_each_index);
}
return true;
}
/**
* Add column to index
*
@@ -195,11 +196,11 @@ class PMA_Index
$this->_columns[$params['Column_name']] = new PMA_Index_Column($params);
}
}
public function addColumns($columns)
{
$_columns = array();
if (isset($columns['names'])) {
// coming from form
// $columns[names][]
@@ -217,12 +218,12 @@ class PMA_Index
// ...
$_columns = $columns;
}
foreach ($_columns as $column) {
$this->addColumn($column);
}
}
/**
* Returns true if $column indexed in this index
*
@@ -234,7 +235,7 @@ class PMA_Index
{
return isset($this->_columns[$column]);
}
public function set($params)
{
if (isset($params['columns'])) {
@@ -274,22 +275,22 @@ class PMA_Index
$this->_choice = 'INDEX';
}
}
public function getColumnCount()
{
return count($this->_columns);
}
public function getComment()
{
return $this->_comment;
}
public function getRemarks()
{
return $this->_remarks;
}
public function getComments()
{
$comments = $this->getRemarks();
@@ -297,19 +298,19 @@ class PMA_Index
$comments .= "\n";
}
$comments .= $this->getComment();
return $comments;
}
public function getType()
{
return $this->_type;
}
/**
* Return a list of all index choices
* Return a list of all index choices
*
* @return array index choices
* @return array index choices
*/
static public function getIndexChoices()
{
@@ -318,13 +319,13 @@ class PMA_Index
'INDEX',
'UNIQUE',
'FULLTEXT',
);
);
}
public function generateIndexSelector()
{
$html_options = '';
foreach (PMA_Index::getIndexChoices() as $each_index_choice) {
if ($each_index_choice === 'PRIMARY'
&& $this->_choice !== 'PRIMARY'
@@ -336,15 +337,15 @@ class PMA_Index
. (($this->_choice == $each_index_choice) ? ' selected="selected"' : '')
. '>'. $each_index_choice . '</option>' . "\n";
}
return $html_options;
}
public function getPacked()
{
return $this->_packed;
}
public function isPacked($as_text = false)
{
if ($as_text) {
@@ -358,19 +359,19 @@ class PMA_Index
'1' => true,
);
}
if (null === $this->_packed) {
return $r[0];
}
return $this->_packed;
}
public function getNonUnique()
{
return $this->_non_unique;
}
public function isUnique($as_text = false)
{
if ($as_text) {
@@ -384,25 +385,25 @@ class PMA_Index
'1' => false,
);
}
return $r[$this->_non_unique];
}
public function getName()
{
return $this->_name;
}
public function setName($name)
{
$this->_name = (string) $name;
}
public function getColumns()
{
return $this->_columns;
}
/**
* Show index data
*
@@ -421,10 +422,10 @@ class PMA_Index
if (count($indexes) < 1) {
return PMA_Message::warning('strNoIndex')->getDisplay();
}
$r = '';
$r .= '<h2>' . $GLOBALS['strIndexes'] . ': ';
$r .= '<h2>' . $GLOBALS['strIndexes'] . ': ';
$r .= PMA_showMySQLDocu('optimization', 'optimizing-database-structure');
$r .= '</h2>';
$r .= '<table>';
@@ -445,13 +446,13 @@ class PMA_Index
$r .= '</tr>';
$r .= '</thead>';
$r .= '<tbody>';
$odd_row = true;
foreach ($indexes as $index) {
$row_span = ' rowspan="' . $index->getColumnCount() . '" ';
$r .= '<tr class="' . ($odd_row ? 'odd' : 'even') . '">';
if (! $print_mode) {
$this_params = $GLOBALS['url_params'];
$this_params['index'] = $index->getName();
@@ -459,7 +460,7 @@ class PMA_Index
. ' <a href="tbl_indexes.php' . PMA_generate_common_url($this_params)
. '">' . PMA_getIcon('b_edit.png', $GLOBALS['strEdit']) . '</a>'
. '</td>' . "\n";
$this_params = $GLOBALS['url_params'];
if ($index->getName() == 'PRIMARY') {
$this_params['sql_query'] = 'ALTER TABLE ' . PMA_backquote($table) . ' DROP PRIMARY KEY';
@@ -470,19 +471,19 @@ class PMA_Index
$this_params['zero_rows'] = sprintf($GLOBALS['strIndexHasBeenDropped'], $index->getName());
$js_msg = PMA_jsFormat('ALTER TABLE ' . $table . ' DROP INDEX ' . $index->getName());
}
$r .= '<td ' . $row_span . '>'
. ' <a href="sql.php' . PMA_generate_common_url($this_params)
. '" onclick="return confirmLink(this, \'' . $js_msg . '\')">'
. '" onclick="return confirmLink(this, \'' . $js_msg . '\')">'
. PMA_getIcon('b_drop.png', $GLOBALS['strDrop']) . '</a>'
. '</td>' . "\n";
}
$r .= '<th ' . $row_span . '>' . htmlspecialchars($index->getName()) . '</th>';
$r .= '<td ' . $row_span . '>' . htmlspecialchars($index->getType()) . '</td>';
$r .= '<td ' . $row_span . '>' . $index->isUnique(true) . '</td>';
$r .= '<td ' . $row_span . '>' . $index->isPacked(true) . '</td>';
foreach ($index->getColumns() as $column) {
if ($column->getSeqInIndex() > 1) {
$r .= '<tr class="' . ($odd_row ? 'odd' : 'even') . '">';
@@ -497,24 +498,24 @@ class PMA_Index
$r .= '<td>' . htmlspecialchars($column->getNull()) . '</td>';
if ($column->getSeqInIndex() == 1) {
$r .= '<td ' . $row_span . '>'
$r .= '<td ' . $row_span . '>'
. htmlspecialchars($index->getComments()) . '</td>';
}
$r .= '</tr>';
} // end foreach $index['Sequences']
$odd_row = ! $odd_row;
} // end while
$r .= '</tbody>';
$r .= '</table>';
if (! $print_mode) {
$r .= PMA_Index::findDuplicates($table, $schema);
}
return $r;
}
public function getCompareData()
{
$data = array(
@@ -522,14 +523,14 @@ class PMA_Index
'Packed' => $this->_packed,
'Index_type' => $this->_type,
);
foreach ($this->_columns as $column) {
$data['columns'][] = $column->getCompareData();
}
return $data;
}
/**
* Function to check over array of indexes and look for common problems
*
@@ -547,15 +548,15 @@ class PMA_Index
static public function findDuplicates($table, $schema)
{
$indexes = PMA_Index::getFromTable($table, $schema);
$output = '';
// count($indexes) < 2:
// there is no need to check if there less than two indexes
if (count($indexes) < 2) {
return $output;
}
// remove last index from stack and ...
while ($while_index = array_pop($indexes)) {
// ... compare with every remaining index in stack
@@ -563,15 +564,15 @@ class PMA_Index
if ($each_index->getCompareData() !== $while_index->getCompareData()) {
continue;
}
// did not find any difference
// so it makes no sense to have this two equal indexes
$message = PMA_Message::warning('strIndexesSeemEqual');
$message->addParam($each_index->getName());
$message->addParam($while_index->getName());
$output .= $message->getDisplay();
// there is no need to check any further indexes if we have already
// found that this one has a duplicate
continue 2;
@@ -587,49 +588,49 @@ class PMA_Index_Column
* @var string The column name
*/
protected $_name = '';
/**
* @var integer The column sequence number in the index, starting with 1.
* @var integer The column sequence number in the index, starting with 1.
*/
protected $_seq_in_index = 1;
/**
* @var string How the column is sorted in the index. “A” (Ascending) or NULL (Not sorted)
* @var string How the column is sorted in the index. “A” (Ascending) or NULL (Not sorted)
*/
protected $_collation = null;
/**
* The number of indexed characters if the column is only partly indexed,
* NULL if the entire column is indexed.
* The number of indexed characters if the column is only partly indexed,
* NULL if the entire column is indexed.
*
* @var integer
*/
protected $_sub_part = null;
/**
* Contains YES if the column may contain NULL.
* If not, the column contains NO.
* Contains YES if the column may contain NULL.
* If not, the column contains NO.
*
* @var string
*/
protected $_null = '';
/**
* An estimate of the number of unique values in the index. This is updated
* by running ANALYZE TABLE or myisamchk -a. Cardinality is counted based on
* statistics stored as integers, so the value is not necessarily exact even
* for small tables. The higher the cardinality, the greater the chance that
* MySQL uses the index when doing joins.
* An estimate of the number of unique values in the index. This is updated
* by running ANALYZE TABLE or myisamchk -a. Cardinality is counted based on
* statistics stored as integers, so the value is not necessarily exact even
* for small tables. The higher the cardinality, the greater the chance that
* MySQL uses the index when doing joins.
*
* @var integer
*/
protected $_cardinality = 0;
public function __construct($params = array())
{
$this->set($params);
}
public function set($params)
{
if (isset($params['Column_name'])) {
@@ -651,32 +652,32 @@ class PMA_Index_Column
$this->_null = $params['Null'];
}
}
public function getName()
{
return $this->_name;
}
public function getCollation()
{
return $this->_collation;
}
public function getCardinality()
{
return $this->_cardinality;
}
public function getNull()
{
return $this->_null;
}
public function getSeqInIndex()
{
return $this->_seq_in_index;
}
public function getSubPart()
{
return $this->_sub_part;