Skip to content

Commit

Permalink
improve docblocks
Browse files Browse the repository at this point in the history
  • Loading branch information
ruleant committed Apr 28, 2012
1 parent b14acc2 commit f793655
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions libraries/List_Database.class.php
Expand Up @@ -31,16 +31,19 @@ class PMA_List_Database extends PMA_List
{
/**
* @var mixed database link resource|object to be used
* @access protected
*/
protected $_db_link = null;

/**
* @var mixed user database link resource|object
* @access protected
*/
protected $_db_link_user = null;

/**
* @var mixed controluser database link resource|object
* @access protected
*/
protected $_db_link_control = null;

Expand All @@ -52,6 +55,7 @@ class PMA_List_Database extends PMA_List

/**
* @var string command to retrieve databases from server
* @access protected
*/
protected $_command = null;

Expand All @@ -60,6 +64,8 @@ class PMA_List_Database extends PMA_List
*
* @param mixed $db_link_user user database link resource|object
* @param mixed $db_link_control control database link resource|object
*
* @return void
*/
public function __construct($db_link_user = null, $db_link_control = null)
{
Expand All @@ -73,6 +79,8 @@ public function __construct($db_link_user = null, $db_link_control = null)

/**
* checks if the configuration wants to hide some databases
*
* @return void
*/
protected function _checkHideDatabase()
{
Expand Down Expand Up @@ -147,6 +155,7 @@ protected function _retrieve($like_db_name = null)
/**
* builds up the list
*
* @return void
*/
public function build()
{
Expand Down Expand Up @@ -213,7 +222,7 @@ protected function _checkOnlyDatabase()
/**
* returns default item
*
* @return string default item
* @return string default item
*/
public function getDefault()
{
Expand All @@ -230,7 +239,7 @@ public function getDefault()
* @param integer $offset
* @param integer $count
*
* @return array db list
* @return array db list
*/
public function getGroupedDetails($offset, $count)
{
Expand Down Expand Up @@ -319,7 +328,7 @@ public function getLimitedItems($offset, $count)
/**
* returns html code for list with dbs
*
* @return string html code list
* @return string html code list
*/
public function getHtmlListGrouped($selected = '', $offset, $count)
{
Expand Down Expand Up @@ -375,7 +384,7 @@ public function getHtmlListGrouped($selected = '', $offset, $count)
* as mostly names will be in english, we set the whole selectbox to LTR
* and EN
*
* @return string html code select
* @return string html code select
*/
public function getHtmlSelectGrouped($selected = '', $offset, $count)
{
Expand Down Expand Up @@ -422,6 +431,7 @@ public function getHtmlSelectGrouped($selected = '', $offset, $count)
* this is just a backup, if all is fine this can be deleted later
*
* @deprecated
* @return void
*/
protected function _checkAgainstPrivTables()
{
Expand Down

0 comments on commit f793655

Please sign in to comment.