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

Merge pull request #748 from Tithugues/phpdoc

Browse Source 
Huge PHPDoc update
This commit is contained in:
Michal Čihař 2013-11-11 01:21:52 -08:00
commit e6e81ef5c9
51 changed files with 204 additions and 157 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
PMAStandard/Sniffs/Commenting/FileCommentSniff.php
View File

@ -493,7 +493,7 @@ class PMAStandard_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_
* @param PHP_CodeSniffer_CommentParser_DocElement $tagElement The doc comment
* element.
*
* @return void
* @return string|int
*/
protected function getIndentation($tagName, $tagElement)
{

2
gis_data_editor.php
View File

@ -12,7 +12,7 @@
*
* @param string $variable variable to be escaped
*
* @return escaped variable
* @return string escaped variable
*/
function escape($variable)
{

8
libraries/Advisor.class.php
View File

@ -264,7 +264,7 @@ class Advisor
*
* @param array $matches List of matched elements form preg_replace_callback
*
* @return String Replacement value
* @return string Replacement value
*/
private function _replaceLinkURL($matches)
{
@ -276,7 +276,7 @@ class Advisor
*
* @param array $matches List of matched elements form preg_replace_callback
*
* @return String Replacement value
* @return string Replacement value
*/
private function _ruleExprEvaluateFired($matches)
{
@ -300,7 +300,7 @@ class Advisor
*
* @param array $matches List of matched elements form preg_replace_callback
*
* @return String Replacement value
* @return string Replacement value
*/
private function _ruleExprEvaluateVariable($matches)
{
@ -324,6 +324,8 @@ class Advisor
* whole expr
*
* @return string result of evaluated expression
*
* @throws Exception
*/
function ruleExprEvaluate($expr, $ignoreUntil = 0)
{

2
libraries/DatabaseInterface.class.php
View File

@ -41,7 +41,7 @@ class PMA_DatabaseInterface
/**
* Constructor
*
* @param object $ext PMA_DBI_Extension object to be used for database queries
* @param PMA_DBI_Extension $ext Object to be used for database queries
*/
public function __construct(PMA_DBI_Extension $ext)
{

50
libraries/DisplayResults.class.php
View File

@ -274,28 +274,28 @@ class PMA_DisplayResults
/**
* Set properties which were not initialized at the constructor
*
* @param type $unlim_num_rows integer the total number of rows returned by
* @param integer $unlim_num_rows the total number of rows returned by
* the SQL query without any appended
* "LIMIT" clause programmatically
* @param type $fields_meta array meta information about fields
* @param type $is_count boolean
* @param type $is_export integer
* @param type $is_func boolean
* @param type $is_analyse integer
* @param type $num_rows integer total no. of rows returned by SQL query
* @param type $fields_cnt integer total no.of fields returned by SQL query
* @param type $querytime double time taken for execute the SQL query
* @param type $pmaThemeImage string path for theme images directory
* @param type $text_dir string
* @param type $is_maint boolean
* @param type $is_explain boolean
* @param type $is_show boolean
* @param type $showtable array table definitions
* @param type $printview string
* @param type $url_query string URL query
* @param type $editable boolean whether the resutls set is editable
* @param array $fields_meta meta information about fields
* @param boolean $is_count
* @param integer $is_export
* @param boolean $is_func
* @param integer $is_analyse
* @param integer $num_rows total no. of rows returned by SQL query
* @param integer $fields_cnt total no.of fields returned by SQL query
* @param double $querytime time taken for execute the SQL query
* @param string $pmaThemeImage path for theme images directory
* @param string $text_dir
* @param boolean $is_maint
* @param boolean $is_explain
* @param boolean $is_show
* @param array $showtable table definitions
* @param string $printview
* @param string $url_query URL query
* @param boolean $editable whether the results set is editable
*
* @return void
* @return void
*
* @see sql.php
*/
@ -979,12 +979,12 @@ class PMA_DisplayResults
/**
* Get the headers of the results table
*
* @param array &$is_display which elements to display
* @param array $analyzed_sql the analyzed query
* @param string $sort_expression sort expression
* @param string $sort_expression_nodirection sort expression without direction
* @param string $sort_direction sort direction
* @param boolean $is_limited_display with limited operations or not
* @param array &$is_display which elements to display
* @param array|string $analyzed_sql the analyzed query
* @param string $sort_expression sort expression
* @param string $sort_expression_nodirection sort expression without direction
* @param string $sort_direction sort direction
* @param boolean $is_limited_display with limited operations or not
*
* @return string html content
*

1
libraries/PDF.class.php
View File

@ -38,7 +38,6 @@ class PMA_PDF extends TCPDF
* temporary data on filesystem (slower).
* @param boolean $pdfa If TRUE set the document to PDF/A mode.
*
* @return void
* @access public
*/
public function __construct($orientation = 'P', $unit = 'mm', $format = 'A4',

4
libraries/Util.class.php
View File

@ -2914,7 +2914,7 @@ class PMA_Util
* function because in PHP, decbin() supports only 32 bits
* on 32-bit servers
*
* @param numeric $value coming from a BIT field
* @param number $value coming from a BIT field
* @param integer $length length
*
* @return string the printable value
@ -3917,7 +3917,7 @@ class PMA_Util
*
* @param string $limit_clause limit clause
*
* @return array Start and length attributes of the limit clause
* @return array|void Start and length attributes of the limit clause
*/
public static function analyzeLimitClause($limit_clause)
{

8
libraries/bookmark.lib.php
View File

@ -49,7 +49,7 @@ function PMA_Bookmark_getParams()
*
* @access public
*
* @global resource the controluser db connection handle
* @global resource $controllink the controluser db connection handle
*/
function PMA_Bookmark_getList($db)
{
@ -105,7 +105,7 @@ function PMA_Bookmark_getList($db)
*
* @access public
*
* @global resource the controluser db connection handle
* @global resource $controllink the controluser db connection handle
*
*/
function PMA_Bookmark_get($db, $id, $id_field = 'id', $action_bookmark_all = false,
@ -148,7 +148,7 @@ function PMA_Bookmark_get($db, $id, $id_field = 'id', $action_bookmark_all = fal
*
* @access public
*
* @global resource the controluser db connection handle
* @global resource $controllink the controluser db connection handle
*/
function PMA_Bookmark_save($bkm_fields, $all_users = false)
{
@ -186,7 +186,7 @@ function PMA_Bookmark_save($bkm_fields, $all_users = false)
*
* @access public
*
* @global resource the controluser db connection handle
* @global resource $controllink the controluser db connection handle
*/
function PMA_Bookmark_delete($db, $id)
{

2
libraries/core.lib.php
View File

@ -201,7 +201,7 @@ function PMA_securePath($path)
* @param string|array $message_args arguments applied to $error_message
* @param boolean $delete_session whether to delete session cookie
*
* @return exit
* @return void
*/
function PMA_fatalError(
$error_message, $message_args = null, $delete_session = true

2
libraries/dbi/DBIDummy.class.php
View File

@ -693,7 +693,7 @@ class PMA_DBI_Dummy implements PMA_DBI_Extension
*
* @param object $link the connection object
*
* @return bool false
* @return boolean false
*/
public function nextResult($link = null)
{

4
libraries/dbi/DBIExtension.int.php
View File

@ -49,7 +49,7 @@ interface PMA_DBI_Extension
* @param object $link connection object
* @param int $options query options
*
* @return result object|bool
* @return object|bool result
*/
public function realQuery($query, $link, $options);
@ -121,7 +121,7 @@ interface PMA_DBI_Extension
/**
* Prepare next result from multi_query
*
* @param objecy $link the connection object
* @param object $link the connection object
*
* @return bool true or false
*/

2
libraries/dbi/DBIMysql.class.php
View File

@ -315,7 +315,7 @@ class PMA_DBI_Mysql implements PMA_DBI_Extension
*
* @param object $link the connection object
*
* @return bool false
* @return boolean false
*/
public function nextResult($link = null)
{

2
libraries/dbi/drizzle-wrappers.lib.php
View File

@ -133,8 +133,6 @@ class PMA_DrizzleCon
* Constructor
*
* @param DrizzleCon $dcon connection handle
*
* @return void
*/
public function __construct(DrizzleCon $dcon)
{

2
libraries/display_export.lib.php
View File

@ -17,7 +17,7 @@ if (! defined('PHPMYADMIN')) {
*
* @param string $str option name
*
* @return void
* @return string|void
*/
function PMA_exportCheckboxCheck($str)
{

2
libraries/display_select_lang.lib.php
View File

@ -16,7 +16,7 @@ if (! defined('PHPMYADMIN')) {
* @param array $a The first language being compared
* @param array $b The second language being compared
*
* @return the sorted array
* @return int the sorted array
*/
function PMA_languageCmp($a, $b)
{

17
libraries/engines/pbxt.lib.php
View File

@ -106,6 +106,11 @@ class PMA_StorageEngine_pbxt extends PMA_StorageEngine
}
//--------------------
/**
* Get information about pages
*
* @return array Information about pages
*/
function getInfoPages()
{
$pages = array();
@ -114,6 +119,13 @@ class PMA_StorageEngine_pbxt extends PMA_StorageEngine
}
//--------------------
/**
* Get content of a page
*
* @param string $id Id of searched page
*
* @return string
*/
function getPage($id)
{
if (! array_key_exists($id, $this->getInfoPages())) {
@ -125,6 +137,11 @@ class PMA_StorageEngine_pbxt extends PMA_StorageEngine
return $this->$id();
}
/**
* Get content of documentation page
*
* @return string
*/
function getPageDocumentation()
{
$output = '<p>' . sprintf(

2
libraries/file_listing.lib.php
View File

@ -68,7 +68,7 @@ function PMA_getFileSelectOptions($dir, $extensions = '', $active = '')
/**
* Get currently supported decompressions.
*
* @return string | separated list of extensions usable in PMA_getDirContent
* @return string separated list of extensions usable in PMA_getDirContent
*/
function PMA_supportedDecompressions()
{

2
libraries/gis/pma_gis_geometrycollection.php
View File

@ -32,7 +32,7 @@ class PMA_GIS_Geometrycollection extends PMA_GIS_Geometry
/**
* Returns the singleton.
*
* @return the singleton
* @return PMA_GIS_Geometrycollection the singleton
* @access public
*/
public static function singleton()

4
libraries/gis/pma_gis_multilinestring.php
View File

@ -328,8 +328,8 @@ class PMA_GIS_Multilinestring extends PMA_GIS_Geometry
/**
* Generate parameters for the GIS data editor from the value of the GIS column.
*
* @param string $value of the GIS column
* @param index $index of the geometry
* @param string $value Value of the GIS column
* @param int $index Index of the geometry
*
* @return array params for the GIS data editor from the value of the GIS column
* @access public

4
libraries/gis/pma_gis_multipoint.php
View File

@ -281,8 +281,8 @@ class PMA_GIS_Multipoint extends PMA_GIS_Geometry
/**
* Generate parameters for the GIS data editor from the value of the GIS column.
*
* @param string $value of the GIS column
* @param index $index of the geometry
* @param string $value Value of the GIS column
* @param integer $index Index of the geometry
*
* @return array params for the GIS data editor from the value of the GIS column
* @access public

4
libraries/gis/pma_gis_multipolygon.php
View File

@ -464,8 +464,8 @@ class PMA_GIS_Multipolygon extends PMA_GIS_Geometry
/**
* Generate parameters for the GIS data editor from the value of the GIS column.
*
* @param string $value of the GIS column
* @param index $index of the geometry
* @param string $value Value of the GIS column
* @param int $index Index of the geometry
*
* @return array params for the GIS data editor from the value of the GIS column
* @access public

2
libraries/gis/pma_gis_point.php
View File

@ -263,7 +263,7 @@ class PMA_GIS_Point extends PMA_GIS_Geometry
* Generate parameters for the GIS data editor from the value of the GIS column.
*
* @param string $value of the GIS column
* @param index $index of the geometry
* @param int $index of the geometry
*
* @return array params for the GIS data editor from the value of the GIS column
* @access public

6
libraries/gis/pma_gis_polygon.php
View File

@ -445,7 +445,7 @@ class PMA_GIS_Polygon extends PMA_GIS_Geometry
*
* @param array $ring array of points forming the ring
*
* @return array a point on the surface of the ring
* @return array|void a point on the surface of the ring
* @access public
* @static
*/
@ -507,8 +507,8 @@ class PMA_GIS_Polygon extends PMA_GIS_Geometry
/** Generate parameters for the GIS data editor from the value of the GIS column.
*
* @param string $value of the GIS column
* @param index $index of the geometry
* @param string $value Value of the GIS column
* @param int $index Index of the geometry
*
* @return array params for the GIS data editor from the value of the GIS column
* @access public

8
libraries/insert_edit.lib.php
View File

@ -47,7 +47,7 @@ function PMA_getFormParametersForInsertForm($db, $table, $where_clauses,
*
* @param array $where_clause where clause
*
* @return whereClauseArray array of where clauses
* @return array|void whereClauseArray array of where clauses
*/
function PMA_getWhereClauseArray($where_clause)
{
@ -854,7 +854,7 @@ function PMA_getTextarea($column, $backup_field, $column_name_appendix,
* @param type $idindex id index
* @param type $data data to edit
*
* @return type string an html snippet
* @return string an html snippet
*/
function PMA_getPmaTypeEnum($column, $backup_field, $column_name_appendix,
$extracted_columnspec, $unnullify_trigger, $tabindex, $tabindex_for_value,
@ -1220,7 +1220,7 @@ function PMA_getHTMLinput($column, $column_name_appendix, $special_chars,
* @param string $vkey [multi_edit]['row_id']
* @param array $column description of column in given table
*
* @return string an html snippet
* @return string|void an html snippet
*/
function PMA_getSelectOptionForUpload($vkey, $column)
{
@ -1283,7 +1283,7 @@ function PMA_getMaxUploadSize($column, $biggest_max_file_size)
}
/**
* Get HTML for the Value column of other datatypes
* Get HTML for the Value column of other datatypes
* (here, "column" is used in the sense of HTML column in HTML table)
*
* @param array $column description of column in given table

6
libraries/kanji-encoding.lib.php
View File

@ -20,7 +20,7 @@ if (! defined('PHPMYADMIN')) {
* codes list
* 2002/1/4 by Y.Kawada
*
* @global string the available encoding codes list
* @global string $kanji_encoding_list the available encoding codes list
*
* @return boolean always true
*/
@ -43,7 +43,7 @@ function PMA_Kanji_checkEncoding()
* Reverses SJIS & EUC-JP position in the encoding codes list
* 2002/1/4 by Y.Kawada
*
* @global string the available encoding codes list
* @global string $kanji_encoding_list the available encoding codes list
*
* @return boolean always true
*/
@ -70,7 +70,7 @@ function PMA_Kanji_changeOrder()
* @param string $enc the destination encoding code
* @param string $kana set 'kana' convert to JIS-X208-kana
*
* @global string the available encoding codes list
* @global string $kanji_encoding_list the available encoding codes list
*
* @return string the converted string
*/

7
libraries/mysql_charsets.lib.php
View File

@ -69,6 +69,13 @@ function PMA_generateCharsetDropdownBox($type = PMA_CSDROPDOWN_COLLATION,
return $return_str;
}
/**
* Generate the charset query part
*
* @param string $collation Collation
*
* @return string
*/
function PMA_generateCharsetQueryPart($collation)
{
if (!PMA_DRIZZLE) {

2
libraries/plugin_interface.lib.php
View File

@ -15,7 +15,7 @@
* @param mixed $plugin_param parameter to plugin by which they can
* decide whether they can work
*
* @return new plugin instance
* @return object|null new plugin instance
*/
function PMA_getPlugin(
$plugin_type,

2
libraries/plugins/PluginManager.class.php
View File

@ -120,7 +120,7 @@ class PluginManager implements SplSubject
* If a plugin changes its status, this has to be remembered in order to
* notify the rest of the plugins that they should update
*
* @param mixed $_status contains information about the current plugin state
* @param string $_status contains information about the current plugin state
*
* @return void
*/

34
libraries/plugins/auth/AuthenticationHttp.class.php
View File

@ -95,17 +95,19 @@ class AuthenticationHttp extends AuthenticationPlugin
/**
* Gets advanced authentication settings
*
* @global string the username if register_globals is on
* @global string the password if register_globals is on
* @global array the array of server variables if register_globals is
* off
* @global array the array of environment variables if register_globals
* is off
* @global string the username for the ? server
* @global string the password for the ? server
* @global string the username for the WebSite Professional server
* @global string the password for the WebSite Professional server
* @global string the username of the user who logs out
* @global string $PHP_AUTH_USER the username if register_globals is on
* @global string $PHP_AUTH_PW the password if register_globals is on
* @global array the array of server variables if
* register_globals is off
* @global array the array of environment variables if
* register_globals is off
* @global string the username for the ? server
* @global string the password for the ? server
* @global string the username for the WebSite Professional
* server
* @global string the password for the WebSite Professional
* server
* @global string the username of the user who logs out
*
* @return boolean whether we get authentication settings or not
*/
@ -189,11 +191,11 @@ class AuthenticationHttp extends AuthenticationPlugin
/**
* Set the user and password after last checkings if required
*
* @global array the valid servers settings
* @global integer the id of the current server
* @global array the current server settings
* @global string the current username
* @global string the current password
* @global array $cfg the valid servers settings
* @global integer $server the id of the current server
* @global array the current server settings
* @global string $PHP_AUTH_USER the current username
* @global string $PHP_AUTH_PW the current password
*
* @return boolean always true
*/

32
libraries/plugins/auth/AuthenticationSignon.class.php
View File

@ -53,17 +53,17 @@ class AuthenticationSignon extends AuthenticationPlugin
/**
* Gets advanced authentication settings
*
* @global string the username if register_globals is on
* @global string the password if register_globals is on
* @global array the array of server variables if register_globals is
* off
* @global array the array of environment variables if register_globals
* is off
* @global string the username for the ? server
* @global string the password for the ? server
* @global string the username for the WebSite Professional server
* @global string the password for the WebSite Professional server
* @global string the username of the user who logs out
* @global string $PHP_AUTH_USER the username if register_globals is on
* @global string $PHP_AUTH_PW the password if register_globals is on
* @global array the array of server variables if
* register_globals is off
* @global array the array of environment variables if
* register_globals is off
* @global string the username for the ? server
* @global string the password for the ? server
* @global string the username for the WebSite Professional server
* @global string the password for the WebSite Professional server
* @global string the username of the user who logs out
*
* @return boolean whether we get authentication settings or not
*/
@ -215,11 +215,11 @@ class AuthenticationSignon extends AuthenticationPlugin
/**
* Set the user and password after last checkings if required
*
* @global array the valid servers settings
* @global integer the id of the current server
* @global array the current server settings
* @global string the current username
* @global string the current password
* @global array $cfg the valid servers settings
* @global integer the id of the current server
* @global array the current server settings
* @global string $PHP_AUTH_USER the current username
* @global string $PHP_AUTH_PW the current password
*
* @return boolean always true
*/

2
libraries/plugins/export/ExportXml.class.php
View File

@ -502,7 +502,7 @@ class ExportXml extends ExportPlugin
/**
* Gets the table name
*
* @return void
* @return string
*/
private function _getTable()
{

14
libraries/plugins/export/PMA_ExportPdf.class.php
View File

@ -160,6 +160,13 @@ class PMA_ExportPdf extends PMA_PDF
$this->SetAutoPageBreak(true);
}
/**
* Generate table
*
* @param int $lineheight Height of line
*
* @return void
*/
function morepagestable($lineheight = 8)
{
// some things to set and 'remember'
@ -265,6 +272,13 @@ class PMA_ExportPdf extends PMA_PDF
$this->tMargin = $topMargin;
}
/**
* MySQL report
*
* @param string $query Query to execute
*
* @return void
*/
function mysqlReport($query)
{
unset($this->tablewidths);

2
libraries/plugins/export/TableProperty.class.php
View File

@ -64,8 +64,6 @@ class TableProperty
* Constructor
*
* @param array $row table row
*
* @return void
*/
function __construct($row)
{

2
libraries/plugins/import/ShapeFile.class.php
View File

@ -78,7 +78,7 @@ class PMA_ShapeFile extends ShapeFile
/**
* Loads geometry data from the ESRI shape file
*
* @return void
* @return boolean|void
* @see ShapeFile::_loadRecords()
*/
function _loadRecords()

2
libraries/plugins/import/ShapeRecord.class.php
View File

@ -82,7 +82,7 @@ class PMA_ShapeRecord extends ShapeRecord
/**
* Loads data from a point record
*
* @return void
* @return array
* @see ShapeRecord::_loadPoint()
*/
function _loadPoint()

2
libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php
View File

@ -41,7 +41,7 @@ abstract class AppendTransformationsPlugin extends TransformationsPlugin
* @param array $options transformation options
* @param string $meta meta information
*
* @return void
* @return string
*/
public function applyTransformation($buffer, $options = array(), $meta = '')
{

6
libraries/relation.lib.php
View File

@ -344,7 +344,7 @@ function PMA_getDiagMessageForFeature($feature_name,
* @param array $messages utility messages
* @param string $doc_anchor anchor in documentation
*
* @return void
* @return string
*/
function PMA_getDiagMessageForParameter($parameter,
$relation_parameter_set, $messages, $doc_anchor
@ -1364,7 +1364,7 @@ function PMA_REL_renameField($db, $table, $field, $new_name)
* @param string $db_field Name of database field
* @param string $table_field Name of table field
*
* @return nothing.
* @return void
*/
function PMA_REL_renameSingleTable($table,
$source_db, $target_db,
@ -1395,7 +1395,7 @@ function PMA_REL_renameSingleTable($table,
* @param string $source_table Source table name
* @param string $target_table Target table name
*
* @return nothing
* @return void
*/
function PMA_REL_renameTable($source_db, $target_db, $source_table, $target_table)
{

2
libraries/replication.inc.php
View File

@ -215,7 +215,7 @@ function PMA_Replication_Slave_control($action, $control = null, $link = null)
* @param bool $start shall we start slave?
* @param mixed $link mysql link
*
* @return output of CHANGE MASTER mysql command
* @return string output of CHANGE MASTER mysql command
*/
function PMA_Replication_Slave_changeMaster($user, $password, $host, $port,
$pos, $stop = true, $start = true, $link = null

4
libraries/replication_gui.lib.php
View File

@ -472,7 +472,7 @@ function PMA_getHtmlForAddUserInputDiv($label_array, $input_array)
* @param string $type either master or slave
* @param boolean $hidden if true, then default style is set to hidden,
* default value false
* @param boolen $title if true, then title is displayed, default true
* @param boolean $title if true, then title is displayed, default true
*
* @return String HTML code
*/
@ -581,7 +581,7 @@ function PMA_getHtmlForReplicationStatusTable($type, $hidden = false, $title = t
* @param boolean $hidden - if true, then default style is set to hidden,
* - default value false
*
* @return void
* @return string
*/
function PMA_getHtmlForReplicationSlavesTable($hidden = false)
{

8
libraries/rte/rte_routines.lib.php
View File

@ -12,7 +12,7 @@ if (! defined('PHPMYADMIN')) {
/**
* Sets required globals
*
* @return nothing
* @return void
*/
function PMA_RTN_setGlobals()
{
@ -37,7 +37,7 @@ function PMA_RTN_setGlobals()
* 'PROCEDURE' for procedures,
* null for both
*
* @return nothing
* @return void
*/
function PMA_RTN_main($type)
{
@ -266,7 +266,7 @@ function PMA_RTN_parseRoutineDefiner($parsed_query)
/**
* Handles editor requests for adding or editing an item
*
* @return Does not return
* @return void
*/
function PMA_RTN_handleEditor()
{
@ -1302,7 +1302,7 @@ function PMA_RTN_getQueryFromRequest()
/**
* Handles requests for executing a routine
*
* @return Does not return
* @return void
*/
function PMA_RTN_handleExecute()
{

16
libraries/server_privileges.lib.php
View File

@ -409,7 +409,7 @@ function PMA_getGrantsArray()
* @param string $name_for_dfn name for dfn
* @param string $name_for_current name for current
*
* @return $html_output html snippet
* @return string $html_output html snippet
*/
function PMA_getHtmlForDisplayColumnPrivileges($columns, $row, $name_for_select,
$priv_for_header, $name, $name_for_dfn, $name_for_current
@ -2160,7 +2160,7 @@ function PMA_getHtmlTableBodyForSpecificDbOrTablePrivs($privMap, $db, $table = n
* @param string $dbname Database name
* @param string $tablename Table name
*
* @return HTML code with link
* @return string HTML code with link
*/
function PMA_getUserEditLink($username, $hostname, $dbname = '', $tablename = '')
{
@ -2187,7 +2187,7 @@ function PMA_getUserEditLink($username, $hostname, $dbname = '', $tablename = ''
* @param string $dbname Database name
* @param string $tablename Table name
*
* @return HTML code with link
* @return string HTML code with link
*/
function PMA_getUserRevokeLink($username, $hostname, $dbname = '', $tablename = '')
{
@ -2234,9 +2234,9 @@ function PMA_getUserExportLink($username, $hostname, $initial = '')
/**
* Returns user group edit link
*
*
* @param string $username User name
*
*
* @return HTML code with link
*/
function PMA_getUserGroupEditLink($username)
@ -2308,7 +2308,7 @@ function PMA_getExtraDataForAjaxBehavior(
$new_user_string .= '<td>'
. '<code>' . join(', ', PMA_extractPrivInfo('', true)) . '</code>'
. '</td>'; //Fill in privileges here
// if $cfg['Servers'][$i]['users'] and $cfg['Servers'][$i]['usergroups'] are
// enabled
$cfgRelation = PMA_getRelationsParam();
@ -2329,13 +2329,13 @@ function PMA_getExtraDataForAjaxBehavior(
$new_user_string .= '<td>'
. PMA_getUserEditLink($username, $hostname)
. '</td>' . "\n";
if (isset($cfgRelation['users']) && isset($cfgRelation['usergroups'])) {
$new_user_string .= '<td>'
. PMA_getUserGroupEditLink($username)
. '</td>' . "\n";
}
$new_user_string .= '<td>'
. PMA_getUserExportLink(
$username,

2
libraries/server_user_groups.lib.php
View File

@ -15,7 +15,7 @@ if (! defined('PHPMYADMIN')) {
*
* @param string $userGroup user group name
*
* @return HTML to list the users belonging to a given user group
* @return string HTML to list the users belonging to a given user group
*/
function PMA_getHtmlForListingUsersofAGroup($userGroup)
{

8
libraries/server_variables.lib.php
View File

@ -119,11 +119,11 @@ function PMA_getAjaxReturnForSetVal($variable_doc_links)
/**
* Format Variable
*
* @param string $name variable name
* @param numeric $value variable value
* @param Array $variable_doc_links documentation links
* @param string $name variable name
* @param number $value variable value
* @param array $variable_doc_links documentation links
*
* @return formatted string
* @return string formatted string
*/
function PMA_formatVariable($name, $value, $variable_doc_links)
{

2
libraries/sql_query_form.lib.php
View File

@ -388,7 +388,7 @@ function PMA_getHtmlForSqlQueryFormInsert(
/**
* return HTML for sql Query Form Bookmark
*
* @return string
* @return string|void
*
* @usedby PMA_getHtmlForSqlQueryForm()
*/

8
libraries/sqlparser.lib.php
View File

@ -64,7 +64,7 @@ if (! isset($mysql_charsets)) {
* @param int &$arrsize Size of array
* @param int $pos Position of an element
*
* @return nothing
* @return void
*/
function PMA_SQP_arrayAdd(&$arr, $type, $data, &$arrsize, $pos = 0)
{
@ -77,7 +77,7 @@ function PMA_SQP_arrayAdd(&$arr, $type, $data, &$arrsize, $pos = 0)
*
* @access public
*
* @return nothing
* @return void
*/
function PMA_SQP_resetError()
{
@ -118,7 +118,7 @@ function PMA_SQP_isError()
* @param string $message The error message
* @param string $sql The failing SQL query
*
* @return nothing
* @return void
*
* @access private
* @scope SQL Parser internal
@ -147,7 +147,7 @@ function PMA_SQP_throwError($message, $sql)
* @param string $message The error message
* @param string $sql The failing SQL query
*
* @return nothing
* @return void
*
* @access public
*/

18
libraries/structure.lib.php
View File

@ -439,7 +439,7 @@ function PMA_getTimeForCreateUpdateCheck($current_table, $time_label, $time_all)
* @param boolean $is_show_stats whether stats is show or not
* @param boolean $ignored ignored
* @param boolean $do do
* @param intger $colspan_for_structure colspan for structure
* @param integer $colspan_for_structure colspan for structure
*
* @return array $html_output, $odd_row
*/
@ -738,7 +738,7 @@ function PMA_getHtmlForRepairtable(
* @param boolean $db_is_information_schema whether db is information schema or not
* @param boolean $replication whether to sho replication status
*
* @return html data
* @return string html data
*/
function PMA_tableHeader($db_is_information_schema = false, $replication = false)
{
@ -1085,6 +1085,10 @@ function PMA_getStuffForEngineTypeTable($current_table, $db_is_information_schem
* @param boolean $is_show_stats whether stats show or not
* @param double $sum_size sum size
* @param double $overhead_size overhead size
* @param number $formatted_size formatted size
* @param string $unit unit
* @param number $formatted_overhead overhead formatted
* @param string $overhead_unit overhead unit
*
* @return array
*/
@ -1626,7 +1630,7 @@ function PMA_getHtmlForSpaceUsageTableRow($odd_row, $name, $value, $unit)
/**
* Get HTML for Optimize link if overhead in Information fieldset
*
* @param type $url_query URL query
* @param string $url_query URL query
*
* @return string $html_output
*/
@ -1650,9 +1654,9 @@ function PMA_getHtmlForOptimizeLink($url_query)
/**
* Get HTML for 'Row statistics' table row
*
* @param type $odd_row whether current row is odd or even
* @param type $name statement name
* @param type $value value
* @param boolean $odd_row whether current row is odd or even
* @param string $name statement name
* @param mixed $value value
*
* @return string $html_output
*/
@ -1864,7 +1868,7 @@ function PMA_getHtmlForActionRowInStructureTable($type, $tbl_storage_engine,
* @param array $row current row
* @param array $titles titles array
*
* @return type array $html_output, $fulltext_enabled
* @return array $html_output, $fulltext_enabled
*/
function PMA_getHtmlForFullTextAction($tbl_storage_engine, $type, $url_query,
$row, $titles

4
libraries/sysinfo.lib.php
View File

@ -41,7 +41,7 @@ function PMA_getSysInfoOs($php_os = PHP_OS)
/**
* Gets sysinfo class mathing current OS
*
* @return sysinfo class
* @return PMA_SysInfo|mixed sysinfo class
*/
function PMA_getSysInfo()
{
@ -160,7 +160,7 @@ class PMA_SysInfoWinnt extends PMA_SysInfo
* @param string $strClass Class to read
* @param array $strValue Values to read
*
* @return arrray with results
* @return array with results
*/
private function _getWMI($strClass, $strValue = array())
{

8
libraries/tbl_gis_visualization.lib.php
View File

@ -18,7 +18,7 @@ require_once 'libraries/sql.lib.php';
* @param string $sql_query original sql query
* @param array $visualizationSettings settings for the visualization
*
* @return the modified sql query.
* @return string the modified sql query.
*/
function PMA_GIS_modifyQuery($sql_query, $visualizationSettings)
{
@ -104,9 +104,9 @@ function PMA_GIS_modifyQuery($sql_query, $visualizationSettings)
* Local function to sanitize the expression taken
* from the results of PMA_SQP_analyze function.
*
* @param aray $select Select to sanitize.
* @param array $select Select to sanitize.
*
* @return Sanitized string.
* @return string Sanitized string.
*/
function sanitize($select)
{
@ -132,7 +132,7 @@ function sanitize($select)
* @param array &$visualizationSettings Settings used to generate the chart
* @param string $format Format of the visulaization
*
* @return string HTML and JS code for the GIS visualization
* @return string|void HTML and JS code for the GIS visualization
*/
function PMA_GIS_visualizationResults($data, &$visualizationSettings, $format)
{

8
libraries/tbl_relation.lib.php
View File

@ -125,10 +125,10 @@ function PMA_getSQLToCreateForeignKey($table, $field, $foreignDb, $foreignTable,
/**
* Creates and populates dropdowns to select foreign db/table/column
*
* @param string $name name of the dropdowns
* @param array $values dropdown values
* @param string $foreign value of the item to be selected
* @param string $title title to show on hovering the dropdown
* @param string $name name of the dropdowns
* @param array $values dropdown values
* @param string|boolean $foreign value of the item to be selected
* @param string $title title to show on hovering the dropdown
*
* @return string HTML for the dropdown
*/

12
libraries/url_generating.lib.php
View File

@ -12,12 +12,12 @@ if (! defined('PHPMYADMIN')) {
/**
* Generates text with hidden inputs.
*
* @param string $db optional database name
* (can also be an array of parameters)
* @param string $table optional table name
* @param int $indent indenting level
* @param string $skip do not generate a hidden field for this parameter
* (can be an array of strings)
* @param string $db optional database name
* (can also be an array of parameters)
* @param string $table optional table name
* @param int $indent indenting level
* @param string|array $skip do not generate a hidden field for this parameter
* (can be an array of strings)
*
* @see PMA_URL_getCommon()
*

6
pmd_relation_new.php
View File

@ -104,6 +104,12 @@ if (PMA_Util::isForeignKeySupported($type_T1)
}
}
/**
* Send xml
*
* @param string $b Value of attribute "b"
* @param string $ret Value of attribute "return"
*/
function PMD_return_new($b,$ret)
{
global $db,$T1,$F1,$T2,$F2;