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

Fix spacing after @param

Browse Source
This commit is contained in:
Michal Čihař 2011-07-22 09:21:55 +02:00
parent 25bda8e991
commit 9405dbb82a
75 changed files with 1147 additions and 1147 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
db_search.php
View File

@ -113,10 +113,10 @@ if (isset($_REQUEST['submit_search'])) {
* explode
* count
* strlen
* @param string the table name
* @param string restrict the search to this field
* @param string the string to search
* @param integer type of search (1 -> 1 word at least, 2 -> all words,
* @param string the table name
* @param string restrict the search to this field
* @param string the string to search
* @param integer type of search (1 -> 1 word at least, 2 -> all words,
* 3 -> exact string, 4 -> regexp)
*
* @return array 3 SQL querys (for count, display and delete results)

2
export.php
View File

@ -129,7 +129,7 @@ $time_start = time();
* Output handler for all exports, if needed buffering, it stores data into
* $dump_buffer, otherwise it prints thems out.
*
* @param string $line the insert statement
* @param string $line the insert statement
* @return bool Whether output suceeded
*/
function PMA_exportOutputHandler($line)

30
libraries/Config.class.php
View File

@ -75,7 +75,7 @@ class PMA_Config
/**
* constructor
*
* @param string source to read config from
* @param string source to read config from
*/
function __construct($source = null)
{
@ -333,7 +333,7 @@ class PMA_Config
* loads configuration from $source, usally the config file
* should be called on object creation
*
* @param string $source config file
* @param string $source config file
*/
function load($source = null)
{
@ -563,7 +563,7 @@ class PMA_Config
/**
* set source
* @param string $source
* @param string $source
*/
function setSource($source)
{
@ -635,7 +635,7 @@ class PMA_Config
/**
* returns specific config setting
* @param string $setting
* @param string $setting
* @return mixed value
*/
function get($setting)
@ -649,8 +649,8 @@ class PMA_Config
/**
* sets configuration variable
*
* @param string $setting configuration option
* @param string $value new value for configuration option
* @param string $setting configuration option
* @param string $value new value for configuration option
*/
function set($setting, $value)
{
@ -1075,7 +1075,7 @@ class PMA_Config
* returns options for font size selection
*
* @static
* @param string $current_size current selected font size with unit
* @param string $current_size current selected font size with unit
* @return array selectable font sizes
*/
static protected function _getFontsizeOptions($current_size = '82%')
@ -1135,7 +1135,7 @@ class PMA_Config
* returns html selectbox for font sizes
*
* @static
* @param string $current_size currently slected font size with unit
* @param string $current_size currently slected font size with unit
* @return string html selectbox
*/
static protected function _getFontsizeSelection()
@ -1169,7 +1169,7 @@ class PMA_Config
* return complete font size selection form
*
* @static
* @param string $current_size currently slected font size with unit
* @param string $current_size currently slected font size with unit
* @return string html selectbox
*/
static public function getFontsizeForm()
@ -1187,7 +1187,7 @@ class PMA_Config
/**
* removes cookie
*
* @param string $cookie name of cookie to remove
* @param string $cookie name of cookie to remove
* @return boolean result of setcookie()
*/
function removeCookie($cookie)
@ -1200,11 +1200,11 @@ class PMA_Config
* sets cookie if value is different from current cokkie value,
* or removes if value is equal to default
*
* @param string $cookie name of cookie to remove
* @param mixed $value new cookie value
* @param string $default default value
* @param int $validity validity of cookie in seconds (default is one month)
* @param bool $httponlt whether cookie is only for HTTP (and not for scripts)
* @param string $cookie name of cookie to remove
* @param mixed $value new cookie value
* @param string $default default value
* @param int $validity validity of cookie in seconds (default is one month)
* @param bool $httponlt whether cookie is only for HTTP (and not for scripts)
* @return boolean result of setcookie()
*/
function setCookie($cookie, $value, $default = null, $validity = null, $httponly = true)

18
libraries/Error.class.php
View File

@ -93,10 +93,10 @@ class PMA_Error extends PMA_Message
/**
* Constructor
*
* @param integer $errno
* @param string $errstr
* @param string $errfile
* @param integer $errline
* @param integer $errno
* @param string $errstr
* @param string $errfile
* @param integer $errline
*/
public function __construct($errno, $errstr, $errfile, $errline)
{
@ -116,7 +116,7 @@ class PMA_Error extends PMA_Message
/**
* sets PMA_Error::$_backtrace
*
* @param array $backtrace
* @param array $backtrace
*/
public function setBacktrace($backtrace)
{
@ -126,7 +126,7 @@ class PMA_Error extends PMA_Message
/**
* sets PMA_Error::$_line
*
* @param integer $line
* @param integer $line
*/
public function setLine($line)
{
@ -136,7 +136,7 @@ class PMA_Error extends PMA_Message
/**
* sets PMA_Error::$_file
*
* @param string $file
* @param string $file
*/
public function setFile($file)
{
@ -147,7 +147,7 @@ class PMA_Error extends PMA_Message
/**
* returns unique PMA_Error::$_hash, if not exists it will be created
*
* @param string $file
* @param string $file
* @return string PMA_Error::$_hash
*/
public function getHash()
@ -329,7 +329,7 @@ class PMA_Error extends PMA_Message
* and make users feel save to submit error reports
*
* @static
* @param string $dest path to be shorten
* @param string $dest path to be shorten
* @return string shortened path
*/
static function relPath($dest)

22
libraries/Error_Handler.class.php
View File

@ -83,10 +83,10 @@ class PMA_Error_Handler
* Do not use the context parameter as we want to avoid storing the
* complete $GLOBALS inside $_SESSION['errors']
*
* @param integer $errno
* @param string $errstr
* @param string $errfile
* @param integer $errline
* @param integer $errno
* @param string $errstr
* @param string $errfile
* @param integer $errline
*/
public function handleError($errno, $errstr, $errfile, $errline)
{
@ -126,7 +126,7 @@ class PMA_Error_Handler
* log error to configured log facility
*
* @todo finish!
* @param PMA_Error $error
* @param PMA_Error $error
*/
protected function _logError($error)
{
@ -136,10 +136,10 @@ class PMA_Error_Handler
/**
* trigger a custom error
*
* @param string $errorInfo
* @param integer $errorNumber
* @param string $file
* @param integer $line
* @param string $errorInfo
* @param integer $errorNumber
* @param string $file
* @param integer $line
*/
public function triggerError($errorInfo, $errorNumber = null, $file = null, $line = null)
{
@ -150,7 +150,7 @@ class PMA_Error_Handler
/**
* display fatal error and exit
*
* @param PMA_Error $error
* @param PMA_Error $error
*/
protected function _dispFatalError($error)
{
@ -191,7 +191,7 @@ class PMA_Error_Handler
/**
* display HTML header
*
* @param PMA_error $error
* @param PMA_error $error
*/
protected function _dispPageStart($error = null)
{

32
libraries/File.class.php
View File

@ -78,7 +78,7 @@ class PMA_File
* constructor
*
* @access public
* @param string $name file name
* @param string $name file name
*/
function __construct($name = false)
{
@ -129,7 +129,7 @@ class PMA_File
* file objects with temp flags are deleted with object destruction
*
* @access public
* @param boolean sets the temp flag
* @param boolean sets the temp flag
* @return boolean PMA_File::$_is_temp
*/
function isTemp($is_temp = null)
@ -145,7 +145,7 @@ class PMA_File
* accessor
*
* @access public
* @param string $name file name
* @param string $name file name
*/
function setName($name)
{
@ -208,7 +208,7 @@ class PMA_File
/**
* @access public
* @param string name of file uploaded
* @param string name of file uploaded
* @return boolean success
*/
function setUploadedFile($name)
@ -226,8 +226,8 @@ class PMA_File
/**
* @access public
* @param string $key the md5 hash of the column name
* @param string $rownumber
* @param string $key the md5 hash of the column name
* @param string $rownumber
* @return boolean success
*/
function setUploadedFromTblChangeRequest($key, $rownumber)
@ -319,9 +319,9 @@ class PMA_File
*
* @access public
* @static
* @param array $file the array
* @param string $rownumber
* @param string $key
* @param array $file the array
* @param string $rownumber
* @param string $key
* @return array
*/
function fetchUploadedFromTblChangeRequestMultiple($file, $rownumber, $key)
@ -341,8 +341,8 @@ class PMA_File
* sets the name if the file to the one selected in the tbl_change form
*
* @access public
* @param string $key the md5 hash of the column name
* @param string $rownumber
* @param string $key the md5 hash of the column name
* @param string $rownumber
* @return boolean success
*/
function setSelectedFromTblChangeRequest($key, $rownumber = null)
@ -421,8 +421,8 @@ class PMA_File
* and uses the submitted/selected file
*
* @access public
* @param string $key the md5 hash of the column name
* @param string $rownumber
* @param string $key the md5 hash of the column name
* @param string $rownumber
* @return boolean success
*/
function checkTblChangeForm($key, $rownumber)
@ -444,7 +444,7 @@ class PMA_File
/**
*
* @access public
* @param string $name
* @param string $name
* @return boolean success
*/
function setLocalSelectedFile($name)
@ -672,7 +672,7 @@ class PMA_File
/**
* advances the file pointer in the file handle by $length bytes/chars
*
* @param integer $length numbers of chars/bytes to skip
* @param integer $length numbers of chars/bytes to skip
* @return boolean
* @todo this function is unused
*/
@ -808,7 +808,7 @@ class PMA_File
* sets reference to most recent BLOB repository reference
*
* @access public
* @param string - BLOB repository reference
* @param string - BLOB repository reference
*/
static function setRecentBLOBReference($ref)
{

28
libraries/Index.class.php
View File

@ -86,7 +86,7 @@ class PMA_Index
/**
* Constructor
*
* @param array $params
* @param array $params
*/
public function __construct($params = array())
{
@ -111,8 +111,8 @@ class PMA_Index
/**
* returns an array with all indexes from the given table
*
* @param string $table
* @param string $schema
* @param string $table
* @param string $schema
* @return array
*/
static public function getFromTable($table, $schema)
@ -129,8 +129,8 @@ class PMA_Index
/**
* return primary if set, false otherwise
*
* @param string $table
* @param string $schema
* @param string $table
* @param string $schema
* @return mixed primary index or false if no one exists
*/
static public function getPrimary($table, $schema)
@ -147,8 +147,8 @@ class PMA_Index
/**
* Load index data for table
*
* @param string $table
* @param string $schema
* @param string $table
* @param string $schema
* @return boolean
*/
static protected function _loadIndexes($table, $schema)
@ -176,7 +176,7 @@ class PMA_Index
/**
* Add column to index
*
* @param array $params column params
* @param array $params column params
*/
public function addColumn($params)
{
@ -216,7 +216,7 @@ class PMA_Index
/**
* Returns true if $column indexed in this index
*
* @param string $column
* @param string $column
* @return boolean
*/
public function hasColumn($column)
@ -403,10 +403,10 @@ class PMA_Index
/**
* Show index data
*
* @param string $table The tablename
* @param array $indexes_info Referenced info array
* @param array $indexes_data Referenced data array
* @param boolean $print_mode
* @param string $table The tablename
* @param array $indexes_info Referenced info array
* @param array $indexes_data Referenced data array
* @param boolean $print_mode
* @access public
* @return array Index collection array
*/
@ -539,7 +539,7 @@ class PMA_Index
* Function to check over array of indexes and look for common problems
*
* @access public
* @param string name of table
* @param string name of table
* @return string Output HTML
*/
static public function findDuplicates($table, $schema)

6
libraries/List.class.php
View File

@ -52,7 +52,7 @@ abstract class PMA_List extends ArrayObject
* checks if the given db names exists in the current list, if there is
* missing at least one item it returns false otherwise true
*
* @param string $db_name,.. one or more mysql result resources
* @param string $db_name,.. one or more mysql result resources
* @return boolean true if all items exists, otheriwse false
*/
public function exists()
@ -70,8 +70,8 @@ abstract class PMA_List extends ArrayObject
/**
* returns HTML <option>-tags to be used inside <select></select>
*
* @param mixed $selected the selected db or true for selecting current db
* @param boolean $include_information_schema
* @param mixed $selected the selected db or true for selecting current db
* @param boolean $include_information_schema
* @return string HTML option tags
*/
public function getHtmlOptions($selected = '', $include_information_schema = true)

14
libraries/List_Database.class.php
View File

@ -56,8 +56,8 @@ require_once './libraries/List.class.php';
/**
* Constructor
*
* @param mixed $db_link_user user database link resource|object
* @param mixed $db_link_control control database link resource|object
* @param mixed $db_link_user user database link resource|object
* @param mixed $db_link_control control database link resource|object
*/
public function __construct($db_link_user = null, $db_link_control = null)
{
@ -89,7 +89,7 @@ require_once './libraries/List.class.php';
* retrieves database list from server
*
* @todo we could also search mysql tables if all fail?
* @param string $like_db_name usally a db_name containing wildcards
* @param string $like_db_name usally a db_name containing wildcards
*/
protected function _retrieve($like_db_name = null)
{
@ -219,8 +219,8 @@ require_once './libraries/List.class.php';
/**
* returns array with dbs grouped with extended infos
*
* @param integer $offset
* @param integer $count
* @param integer $offset
* @param integer $count
* @return array db list
*/
public function getGroupedDetails($offset, $count)
@ -297,8 +297,8 @@ require_once './libraries/List.class.php';
/**
* returns a part of the items
*
* @param integer $offset
* @param integer $count
* @param integer $offset
* @param integer $count
* @return array some items
*/
public function getLimitedItems($offset, $count)

72
libraries/Message.class.php
View File

@ -137,10 +137,10 @@ class PMA_Message
/**
* Constructor
*
* @param string $string
* @param integer $number
* @param array $params
* @param integer $sanitize
* @param string $string
* @param integer $number
* @param array $params
* @param integer $sanitize
*/
public function __construct($string = '', $number = PMA_Message::NOTICE,
$params = array(), $sanitize = PMA_Message::SANITIZE_NONE)
@ -166,7 +166,7 @@ class PMA_Message
* shorthand for getting a simple success message
*
* @static
* @param string $string a localized string e.g. __('Your SQL query has been executed successfully')
* @param string $string a localized string e.g. __('Your SQL query has been executed successfully')
* @return PMA_Message
*/
static public function success($string = '')
@ -184,7 +184,7 @@ class PMA_Message
* shorthand for getting a simple error message
*
* @static
* @param string $string a localized string e.g. __('Error')
* @param string $string a localized string e.g. __('Error')
* @return PMA_Message
*/
static public function error($string = '')
@ -202,7 +202,7 @@ class PMA_Message
* shorthand for getting a simple notice message
*
* @static
* @param string $string a localized string e.g. __('The additional features for working with linked tables have been deactivated. To find out why click %shere%s.')
* @param string $string a localized string e.g. __('The additional features for working with linked tables have been deactivated. To find out why click %shere%s.')
* @return PMA_Message
*/
static public function notice($string)
@ -216,8 +216,8 @@ class PMA_Message
* shorthand for getting a customized message
*
* @static
* @param string $message
* @param integer $type
* @param string $message
* @param integer $type
* @return PMA_Message
*/
static public function raw($message, $type = PMA_Message::NOTICE)
@ -233,7 +233,7 @@ class PMA_Message
* shorthand for getting a customized message
*
* @static
* @param integer $rows Number of rows
* @param integer $rows Number of rows
* @return PMA_Message
*/
static public function affected_rows($rows)
@ -249,7 +249,7 @@ class PMA_Message
* shorthand for getting a customized message
*
* @static
* @param integer $rows Number of rows
* @param integer $rows Number of rows
* @return PMA_Message
*/
static public function deleted_rows($rows)
@ -265,7 +265,7 @@ class PMA_Message
* shorthand for getting a customized message
*
* @static
* @param integer $rows Number of rows
* @param integer $rows Number of rows
* @return PMA_Message
*/
static public function inserted_rows($rows)
@ -281,7 +281,7 @@ class PMA_Message
* shorthand for getting a customized error message
*
* @static
* @param string $message
* @param string $message
* @return PMA_Message
*/
static public function rawError($message)
@ -295,7 +295,7 @@ class PMA_Message
* shorthand for getting a customized notice message
*
* @static
* @param string $message
* @param string $message
* @return PMA_Message
*/
static public function rawNotice($message)
@ -309,7 +309,7 @@ class PMA_Message
* shorthand for getting a customized success message
*
* @static
* @param string $message
* @param string $message
* @return PMA_Message
*/
static public function rawSuccess($message)
@ -321,7 +321,7 @@ class PMA_Message
* returns whether this message is a success message or not
* and optionaly makes this message a success message
*
* @param boolean $set
* @param boolean $set
* @return boolean whether this is a success message or not
*/
public function isSuccess($set = false)
@ -337,7 +337,7 @@ class PMA_Message
* returns whether this message is a notice message or not
* and optionally makes this message a notice message
*
* @param boolean $set
* @param boolean $set
* @return boolean whether this is a notice message or not
*/
public function isNotice($set = false)
@ -353,7 +353,7 @@ class PMA_Message
* returns whether this message is an error message or not
* and optionally makes this message an error message
*
* @param boolean $set
* @param boolean $set
* @return boolean whether this is an error message or not
*/
public function isError($set = false)
@ -368,8 +368,8 @@ class PMA_Message
/**
* set raw message (overrides string)
*
* @param string $message
* @param boolean $sanitize whether to sanitize $message or not
* @param string $message
* @param boolean $sanitize whether to sanitize $message or not
*/
public function setMessage($message, $sanitize = false)
{
@ -382,8 +382,8 @@ class PMA_Message
/**
* set string (does not take effect if raw message is set)
*
* @param string $_string
* @param boolean $sanitize whether to sanitize $string or not
* @param string $_string
* @param boolean $sanitize whether to sanitize $string or not
*/
public function setString($_string, $sanitize = true)
{
@ -396,7 +396,7 @@ class PMA_Message
/**
* set message type number
*
* @param integer $number
* @param integer $number
*/
public function setNumber($number)
{
@ -413,8 +413,8 @@ class PMA_Message
* $message->addParam('<img src="img" />', false);
* </code>
*
* @param mixed $param
* @param boolean $raw
* @param mixed $param
* @param boolean $raw
*/
public function addParam($param, $raw = true)
{
@ -430,8 +430,8 @@ class PMA_Message
/**
* add another string to be concatenated on displaying
*
* @param string $string to be added
* @param string $separator to use between this and previous string/message
* @param string $string to be added
* @param string $separator to use between this and previous string/message
*/
public function addString($string, $separator = ' ')
{
@ -442,8 +442,8 @@ class PMA_Message
/**
* add a bunch of messages at once
*
* @param array $messages to be added
* @param string $separator to use between this and previous string/message
* @param array $messages to be added
* @param string $separator to use between this and previous string/message
*/
public function addMessages($messages, $separator = ' ')
{
@ -455,8 +455,8 @@ class PMA_Message
/**
* add another raw message to be concatenated on displaying
*
* @param mixed $message to be added
* @param string $separator to use between this and previous string/message
* @param mixed $message to be added
* @param string $separator to use between this and previous string/message
*/
public function addMessage($message, $separator = ' ')
{
@ -474,8 +474,8 @@ class PMA_Message
/**
* set all params at once, usually used in conjunction with string
*
* @param array $params
* @param boolean $sanitize
* @param array $params
* @param boolean $sanitize
*/
public function setParams($params, $sanitize = false)
{
@ -509,7 +509,7 @@ class PMA_Message
* Sanitizes $message
*
* @static
* @param mixed $message the message(s)
* @param mixed $message the message(s)
* @return mixed the sanitized message(s)
* @access public
*/
@ -531,7 +531,7 @@ class PMA_Message
* for formatting
*
* @static
* @param string $message the message
* @param string $message the message
* @return string the decoded message
* @access public
*/
@ -662,7 +662,7 @@ class PMA_Message
/**
* sets and returns whether the message was displayed or not
*
* @param boolean $is_displayed
* @param boolean $is_displayed
* @return boolean PMA_Message::$_is_displayed
*/
public function isDisplayed($is_displayed = false)

16
libraries/StorageEngine.class.php
View File

@ -68,10 +68,10 @@ class PMA_StorageEngine
* returns HTML code for storage engine select box
*
* @static
* @param string $name The name of the select form element
* @param string $id The ID of the form field
* @param string $selected The selected engine
* @param boolean $offerUnavailableEngines
* @param string $name The name of the select form element
* @param string $id The ID of the form field
* @param string $selected The selected engine
* @param boolean $offerUnavailableEngines
* Should unavailable storage engines be offered?
* @return string html selectbox
*/
@ -106,7 +106,7 @@ class PMA_StorageEngine
*
* Loads the corresponding engine plugin, if available.
*
* @param string $engine The engine ID
* @param string $engine The engine ID
* @return object The engine plugin
*/
static public function getEngine($engine)
@ -127,7 +127,7 @@ class PMA_StorageEngine
* return true if given engine name is supported/valid, otherwise false
*
* @static
* @param string $engine name of engine
* @param string $engine name of engine
* @return boolean whether $engine is valid or not
*/
static public function isValid($engine)
@ -248,7 +248,7 @@ class PMA_StorageEngine
/**
* Constructor
*
* @param string $engine The engine ID
* @param string $engine The engine ID
*/
function __construct($engine)
{
@ -381,7 +381,7 @@ class PMA_StorageEngine
* Generates the requested information page
*
* @abstract
* @param string $id The page ID
* @param string $id The page ID
*
* @return string The page
* boolean or false on error.

108
libraries/Table.class.php
View File

@ -63,8 +63,8 @@ class PMA_Table
/**
* Constructor
*
* @param string $table_name table name
* @param string $db_name database name
* @param string $table_name table name
* @param string $db_name database name
*/
function __construct($table_name, $db_name)
{
@ -96,7 +96,7 @@ class PMA_Table
/**
* sets table name
*
* @param string $table_name new table name
* @param string $table_name new table name
*/
function setName($table_name)
{
@ -106,7 +106,7 @@ class PMA_Table
/**
* returns table name
*
* @param boolean $backquoted whether to quote name with backticks ``
* @param boolean $backquoted whether to quote name with backticks ``
* @return string table name
*/
function getName($backquoted = false)
@ -120,7 +120,7 @@ class PMA_Table
/**
* sets database name for this table
*
* @param string $db_name
* @param string $db_name
*/
function setDbName($db_name)
{
@ -130,7 +130,7 @@ class PMA_Table
/**
* returns database name for this table
*
* @param boolean $backquoted whether to quote name with backticks ``
* @param boolean $backquoted whether to quote name with backticks ``
* @return string database name for this table
*/
function getDbName($backquoted = false)
@ -144,7 +144,7 @@ class PMA_Table
/**
* returns full name for table, including database name
*
* @param boolean $backquoted whether to quote name with backticks ``
* @param boolean $backquoted whether to quote name with backticks ``
* @return string
*/
function getFullName($backquoted = false)
@ -175,7 +175,7 @@ class PMA_Table
/**
* returns value for given setting/param
*
* @param string $param name for value to return
* @param string $param name for value to return
* @return mixed value for $param
*/
function get($param)
@ -226,8 +226,8 @@ class PMA_Table
*
* @deprecated
* @todo see what we could do with the possible existence of $table_is_view
* @param string $db the database name
* @param string $table the table name
* @param string $db the database name
* @param string $table the table name
* @return boolean whether this is a view
*/
static protected function _isView($db, $table)
@ -247,8 +247,8 @@ class PMA_Table
*
* If the ENGINE of the table is MERGE or MRG_MYISAM (alias), this is a merge table.
*
* @param string $db the database name
* @param string $table the table name
* @param string $db the database name
* @param string $table the table name
* @return boolean true if it is a merge table
*/
static public function isMerge($db = null, $table = null)
@ -313,19 +313,19 @@ class PMA_Table
*
* @todo move into class PMA_Column
* @todo on the interface, some js to clear the default value when the default current_timestamp is checked
* @param string $name name
* @param string $type type ('INT', 'VARCHAR', 'BIT', ...)
* @param string $length length ('2', '5,2', '', ...)
* @param string $attribute
* @param string $collation
* @param bool|string $null with 'NULL' or 'NOT NULL'
* @param string $default_type whether default is CURRENT_TIMESTAMP,
* @param string $name name
* @param string $type type ('INT', 'VARCHAR', 'BIT', ...)
* @param string $length length ('2', '5,2', '', ...)
* @param string $attribute
* @param string $collation
* @param bool|string $null with 'NULL' or 'NOT NULL'
* @param string $default_type whether default is CURRENT_TIMESTAMP,
* NULL, NONE, USER_DEFINED
* @param string $default_value default value for USER_DEFINED default type
* @param string $extra 'AUTO_INCREMENT'
* @param string $comment field comment
* @param array &$field_primary list of fields for PRIMARY KEY
* @param string $index
* @param string $default_value default value for USER_DEFINED default type
* @param string $extra 'AUTO_INCREMENT'
* @param string $comment field comment
* @param array &$field_primary list of fields for PRIMARY KEY
* @param string $index
* @return string field specification
*/
static function generateFieldSpec($name, $type, $length = '', $attribute = '',
@ -424,10 +424,10 @@ class PMA_Table
* Revision 13 July 2001: Patch for limiting dump size from
* vinay@sanisoft.com & girish@sanisoft.com
*
* @param string $db the current database name
* @param string $table the current table name
* @param bool $force_exact whether to force an exact count
* @param bool $is_view
* @param string $db the current database name
* @param string $table the current table name
* @param bool $force_exact whether to force an exact count
* @param bool $is_view
*
* @return mixed the number of records if "retain" param is true,
* otherwise true
@ -498,21 +498,21 @@ class PMA_Table
* Generates column specification for ALTER syntax
*
* @see PMA_Table::generateFieldSpec()
* @param string $oldcol old column name
* @param string $newcol new column name
* @param string $type type ('INT', 'VARCHAR', 'BIT', ...)
* @param string $length length ('2', '5,2', '', ...)
* @param string $attribute
* @param string $collation
* @param bool|string $null with 'NULL' or 'NOT NULL'
* @param string $default_type whether default is CURRENT_TIMESTAMP,
* @param string $oldcol old column name
* @param string $newcol new column name
* @param string $type type ('INT', 'VARCHAR', 'BIT', ...)
* @param string $length length ('2', '5,2', '', ...)
* @param string $attribute
* @param string $collation
* @param bool|string $null with 'NULL' or 'NOT NULL'
* @param string $default_type whether default is CURRENT_TIMESTAMP,
* NULL, NONE, USER_DEFINED
* @param string $default_value default value for USER_DEFINED default type
* @param string $extra 'AUTO_INCREMENT'
* @param string $comment field comment
* @param array &$field_primary list of fields for PRIMARY KEY
* @param string $index
* @param mixed $default_orig
* @param string $default_value default value for USER_DEFINED default type
* @param string $extra 'AUTO_INCREMENT'
* @param string $comment field comment
* @param array &$field_primary list of fields for PRIMARY KEY
* @param string $index
* @param mixed $default_orig
* @return string field specification
*/
static public function generateAlter($oldcol, $newcol, $type, $length,
@ -529,11 +529,11 @@ class PMA_Table
* Inserts existing entries in a PMA_* table by reading a value from an old entry
*
* @global relation variable
* @param string $work The array index, which Relation feature to check ('relwork', 'commwork', ...)
* @param string $pma_table The array index, which PMA-table to update ('bookmark', 'relation', ...)
* @param array $get_fields Which fields will be SELECT'ed from the old entry
* @param array $where_fields Which fields will be used for the WHERE query (array('FIELDNAME' => 'FIELDVALUE'))
* @param array $new_fields Which fields will be used as new VALUES. These are the important
* @param string $work The array index, which Relation feature to check ('relwork', 'commwork', ...)
* @param string $pma_table The array index, which PMA-table to update ('bookmark', 'relation', ...)
* @param array $get_fields Which fields will be SELECT'ed from the old entry
* @param array $where_fields Which fields will be used for the WHERE query (array('FIELDNAME' => 'FIELDVALUE'))
* @param array $new_fields Which fields will be used as new VALUES. These are the important
* keys which differ from the old entry.
* (array('FIELDNAME' => 'NEW FIELDVALUE'))
* @return int|true
@ -995,7 +995,7 @@ class PMA_Table
*
* @todo add check for valid chars in filename on current system/os
* @see http://dev.mysql.com/doc/refman/5.0/en/legal-names.html
* @param string $table_name name to check
* @param string $table_name name to check
* @return boolean whether the string is valid or not
*/
function isValidName($table_name)
@ -1021,9 +1021,9 @@ class PMA_Table
/**
* renames table
*
* @param string $new_name new table name
* @param string $new_db new database name
* @param bool $is_view is this for a VIEW rename?
* @param string $new_name new table name
* @param string $new_db new database name
* @param bool $is_view is this for a VIEW rename?
* @return bool success
*/
function rename($new_name, $new_db = null, $is_view = false)
@ -1161,7 +1161,7 @@ class PMA_Table
* - UNIQUE(x,y) // NONE
*
*
* @param bool $backquoted whether to quote name with backticks ``
* @param bool $backquoted whether to quote name with backticks ``
* @return array
*/
public function getUniqueColumns($backquoted = true)
@ -1188,7 +1188,7 @@ class PMA_Table
*
* e.g. index(col1, col2) would only return col1
*
* @param bool $backquoted whether to quote name with backticks ``
* @param bool $backquoted whether to quote name with backticks ``
* @return array
*/
public function getIndexedColumns($backquoted = true)
@ -1209,7 +1209,7 @@ class PMA_Table
*
* returns an array with all columns
*
* @param bool $backquoted whether to quote name with backticks ``
* @param bool $backquoted whether to quote name with backticks ``
* @return array
*/
public function getColumns($backquoted = true)

16
libraries/Theme.class.php
View File

@ -107,7 +107,7 @@ class PMA_Theme {
*
* @static
* @access public
* @param string $folder path to theme
* @param string $folder path to theme
* @return object PMA_Theme
*/
static public function load($folder)
@ -172,7 +172,7 @@ class PMA_Theme {
* set path to theme
*
* @access public
* @param string $path path to theme
* @param string $path path to theme
*/
function setPath($path)
{
@ -183,7 +183,7 @@ class PMA_Theme {
* sets version
*
* @access public
* @param string new version
* @param string new version
*/
function setVersion($version)
{
@ -206,7 +206,7 @@ class PMA_Theme {
* returns true if theme version is equal or higher to $version
*
* @access public
* @param string $version version to compare to
* @param string $version version to compare to
* @return boolean
*/
function checkVersion($version)
@ -218,7 +218,7 @@ class PMA_Theme {
* sets name
*
* @access public
* @param string $name new name
* @param string $name new name
*/
function setName($name)
{
@ -240,7 +240,7 @@ class PMA_Theme {
* sets id
*
* @access public
* @param string $id new id
* @param string $id new id
*/
function setId($id)
{
@ -260,7 +260,7 @@ class PMA_Theme {
/**
* @access public
* @param string path to images for this theme
* @param string path to images for this theme
*/
function setImgPath($path)
{
@ -280,7 +280,7 @@ class PMA_Theme {
* load css (send to stdout, normally the browser)
*
* @access public
* @param string $type left, right or print
* @param string $type left, right or print
*/
function loadCss(&$type)
{

10
libraries/Theme_Manager.class.php
View File

@ -55,7 +55,7 @@ class PMA_Theme_Manager
/**
* sets path to folder containing the themes
*
* @param string $path path to themes folder
* @param string $path path to themes folder
* @return boolean success
*/
function setThemesPath($path)
@ -80,7 +80,7 @@ class PMA_Theme_Manager
/**
* sets if there are different themes per server
*
* @param boolean $per_server
* @param boolean $per_server
*/
function setThemePerServer($per_server)
{
@ -200,7 +200,7 @@ class PMA_Theme_Manager
/**
* @private
* @param string $folder
* @param string $folder
* @return boolean
*/
/*private*/ function _checkThemeFolder($folder)
@ -252,7 +252,7 @@ class PMA_Theme_Manager
/**
* checks if given theme name is a known theme
*
* @param string $theme name fo theme to check for
* @param string $theme name fo theme to check for
*/
function checkTheme($theme)
{
@ -266,7 +266,7 @@ class PMA_Theme_Manager
/**
* returns HTML selectbox, with or without form enclosed
*
* @param boolean $form whether enclosed by from tags or not
* @param boolean $form whether enclosed by from tags or not
*/
function getHtmlSelectBox($form = true)
{

72
libraries/Tracker.class.php
View File

@ -168,7 +168,7 @@ class PMA_Tracker
*
* @static
*
* @param string $string part of SQL statement
* @param string $string part of SQL statement
*
* @return string the name of table
*/
@ -198,8 +198,8 @@ class PMA_Tracker
*
* @static
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $dbname name of database
* @param string $tablename name of table
*
* @return boolean true or false
*/
@ -250,11 +250,11 @@ class PMA_Tracker
*
* @static
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
* @param string $tracking_set set of tracking statements
* @param string $is_view if table is a view
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
* @param string $tracking_set set of tracking statements
* @param string $is_view if table is a view
*
* @return int result of version insertion
*/
@ -357,8 +357,8 @@ class PMA_Tracker
*
* @static
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $dbname name of database
* @param string $tablename name of table
*
* @return int result of version insertion
*/
@ -378,10 +378,10 @@ class PMA_Tracker
*
* @static
*
* @param string $dbname name of database
* @param string $version version
* @param string $query query
* @param string $tracking_set set of tracking statements
* @param string $dbname name of database
* @param string $version version
* @param string $query query
* @param string $tracking_set set of tracking statements
*
* @return int result of version insertion
*/
@ -443,10 +443,10 @@ class PMA_Tracker
*
* @static
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
* @param integer $new_state the new state of tracking
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
* @param integer $new_state the new state of tracking
*
* @return int result of SQL query
*/
@ -469,11 +469,11 @@ class PMA_Tracker
*
* @static
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
* @param string $type type of data(DDL || DML)
* @param string || array $new_data the new tracking data
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
* @param string $type type of data(DDL || DML)
* @param string || array $new_data the new tracking data
*
* @return bool result of change
*/
@ -514,9 +514,9 @@ class PMA_Tracker
*
* @static
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
*
* @return int result of SQL query
*/
@ -531,9 +531,9 @@ class PMA_Tracker
*
* @static
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
*
* @return int result of SQL query
*/
@ -549,9 +549,9 @@ class PMA_Tracker
*
* @static
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $statement tracked statement
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $statement tracked statement
*
* @return int (-1 if no version exists | > 0 if a version exists)
*/
@ -581,9 +581,9 @@ class PMA_Tracker
*
* @static
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version number
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version number
*
* @return mixed record DDM log, DDL log, structure snapshot, tracked statements.
*/
@ -892,7 +892,7 @@ class PMA_Tracker
*
*
* @static
* @param string $query a SQL query
* @param string $query a SQL query
*/
static public function handleQuery($query)
{

8
libraries/blowfish.php
View File

@ -483,8 +483,8 @@ class Horde_Cipher_blowfish
/**
* Encryption using blowfish algorithm
*
* @param string original data
* @param string the secret
* @param string original data
* @param string the secret
*
* @return string the encrypted result
*
@ -511,8 +511,8 @@ function PMA_blowfish_encrypt($data, $secret)
/**
* Decryption using blowfish algorithm
*
* @param string encrypted data
* @param string the secret
* @param string encrypted data
* @param string the secret
*
* @return string original data
*

20
libraries/bookmark.lib.php
View File

@ -41,7 +41,7 @@ function PMA_Bookmark_getParams()
*
* @global resource the controluser db connection handle
*
* @param string the current database name
* @param string the current database name
*
* @return array the bookmarks list (key as index, label as value)
*
@ -86,11 +86,11 @@ function PMA_Bookmark_getList($db)
*
* @global resource the controluser db connection handle
*
* @param string the current database name
* @param mixed the id of the bookmark to get
* @param string which field to look up the $id
* @param boolean true: get all bookmarks regardless of the owning user
* @param boolean whether to ignore bookmarks with no user
* @param string the current database name
* @param mixed the id of the bookmark to get
* @param string which field to look up the $id
* @param boolean true: get all bookmarks regardless of the owning user
* @param boolean whether to ignore bookmarks with no user
*
* @return string the sql query
*
@ -127,9 +127,9 @@ function PMA_Bookmark_get($db, $id, $id_field = 'id', $action_bookmark_all = fal
*
* @global resource the controluser db connection handle
*
* @param array the properties of the bookmark to add; here,
* @param array the properties of the bookmark to add; here,
* $fields['query'] is urlencoded
* @param boolean whether to make the bookmark available for all users
* @param boolean whether to make the bookmark available for all users
*
* @return boolean whether the INSERT succeeds or not
*
@ -156,8 +156,8 @@ function PMA_Bookmark_save($fields, $all_users = false)
*
* @global resource the controluser db connection handle
*
* @param string the current database name
* @param integer the id of the bookmark to get
* @param string the current database name
* @param integer the id of the bookmark to get
*
* @access public
*/

6
libraries/charset_conversion.lib.php
View File

@ -58,9 +58,9 @@ if ($PMA_recoding_engine == PMA_CHARSET_ICONV_AIX) {
* Converts encoding of text according to parameters with detected
* conversion function.
*
* @param string source charset
* @param string target charset
* @param string what to convert
* @param string source charset
* @param string target charset
* @param string what to convert
*
* @return string converted text
*

222
libraries/common.lib.php
View File

@ -207,7 +207,7 @@ function PMA_escape_mysql_wildcards($name)
* removes slashes before "_" and "%" characters
* Note: This function does not unescape backslashes!
*
* @param string $name the string to escape
* @param string $name the string to escape
* @return string the escaped string
* @access public
*/
@ -439,9 +439,9 @@ function PMA_showPHPDocu($target) {
/**
* returns HTML for a footnote marker and add the messsage to the footnotes
*
* @param string $message the error message
* @param bool $bbcode
* @param string $type
* @param string $message the error message
* @param bool $bbcode
* @param string $type
* @return string html code for a footnote marker
* @access public
*/
@ -480,11 +480,11 @@ function PMA_showHint($message, $bbcode = false, $type = 'notice')
/**
* Displays a MySQL error message in the right frame.
*
* @param string $error_message the error message
* @param string $the_query the sql query that failed
* @param bool $is_modify_link whether to show a "modify" link or not
* @param string $back_url the "back" link url (full path is not required)
* @param bool $exit EXIT the page?
* @param string $error_message the error message
* @param string $the_query the sql query that failed
* @param bool $is_modify_link whether to show a "modify" link or not
* @param string $back_url the "back" link url (full path is not required)
* @param bool $exit EXIT the page?
*
* @global string the curent table
* @global string the current db
@ -630,10 +630,10 @@ function PMA_mysqlDie($error_message = '', $the_query = '',
/**
* returns array with tables of given db with extended information and grouped
*
* @param string $db name of db
* @param string $tables name of tables
* @param integer $limit_offset list offset
* @param int|bool $limit_count max tables to return
* @param string $db name of db
* @param string $tables name of tables
* @param integer $limit_offset list offset
* @param int|bool $limit_count max tables to return
* @return array (recursive) grouped table list
*/
function PMA_getTableList($db, $tables = null, $limit_offset = 0, $limit_count = false)
@ -760,9 +760,9 @@ function PMA_getTableList($db, $tables = null, $limit_offset = 0, $limit_count =
*
* </code>
*
* @param mixed $a_name the database, table or field name to "backquote"
* @param mixed $a_name the database, table or field name to "backquote"
* or array of it
* @param boolean $do_it a flag to bypass this function (used by dump
* @param boolean $do_it a flag to bypass this function (used by dump
* functions)
* @return mixed the "backquoted" database, table or field name
* @access public
@ -854,10 +854,10 @@ if (!$jsonly)
* displays the message and the query
* usually the message is the result of the query executed
*
* @param string $message the message to display
* @param string $sql_query the query to display
* @param string $type the type (level) of the message
* @param boolean $is_view is this a message after a VIEW operation?
* @param string $message the message to display
* @param string $sql_query the query to display
* @param string $type the type (level) of the message
* @param boolean $is_view is this a message after a VIEW operation?
* @return string
* @access public
*/
@ -1237,7 +1237,7 @@ function PMA_profilingSupported()
/**
* Displays a form with the Profiling checkbox
*
* @param string $sql_query
* @param string $sql_query
* @access public
*/
function PMA_profilingCheckbox($sql_query)
@ -1329,11 +1329,11 @@ function PMA_localizeNumber($value)
* echo PMA_formatNumber(0, 6); // 0
*
* </code>
* @param double $value the value to format
* @param integer $digits_left number of digits left of the comma
* @param integer $digits_right number of digits right of the comma
* @param boolean $only_down do not reformat numbers below 1
* @param boolean $noTrailingZero removes trailing zeros right of the comma (default: true)
* @param double $value the value to format
* @param integer $digits_left number of digits left of the comma
* @param integer $digits_right number of digits right of the comma
* @param boolean $only_down do not reformat numbers below 1
* @param boolean $noTrailingZero removes trailing zeros right of the comma (default: true)
*
* @return string the formatted value and its unit
*
@ -1411,7 +1411,7 @@ function PMA_formatNumber($value, $digits_left = 3, $digits_right = 0, $only_dow
/**
* Returns the number of bytes when a formatted size is given
*
* @param string $formatted_size the size expression (for example 8MB)
* @param string $formatted_size the size expression (for example 8MB)
* @return integer The numerical part of the expression (for example 8)
*/
function PMA_extractValueFromFormattedSize($formatted_size)
@ -1500,8 +1500,8 @@ function PMA_localisedDate($timestamp = -1, $format = '')
* returns a tab for tabbed navigation.
* If the variables $link and $args ar left empty, an inactive tab is created
*
* @param array $tab array with all options
* @param array $url_params
* @param array $tab array with all options
* @param array $url_params
* @return string html code for one tab, a link if valid otherwise a span
* @access public
*/
@ -1599,8 +1599,8 @@ function PMA_generate_html_tab($tab, $url_params = array(), $base_dir='')
/**
* returns html-code for a tab navigation
*
* @param array $tabs one element per tab
* @param string $url_params
* @param array $tabs one element per tab
* @param string $url_params
* @return string html-code for tab-navigation
*/
function PMA_generate_html_tabs($tabs, $url_params, $base_dir='')
@ -1627,14 +1627,14 @@ function PMA_generate_html_tabs($tabs, $url_params, $base_dir='')
* Displays a link, or a button if the link's URL is too large, to
* accommodate some browsers' limitations
*
* @param string $url the URL
* @param string $message the link message
* @param mixed $tag_params string: js confirmation
* @param string $url the URL
* @param string $message the link message
* @param mixed $tag_params string: js confirmation
* array: additional tag params (f.e. style="")
* @param boolean $new_form we set this to false when we are already in
* @param boolean $new_form we set this to false when we are already in
* a form, to avoid generating nested forms
* @param boolean $strip_img
* @param string $target
* @param boolean $strip_img
* @param string $target
*
* @return string the results to be echoed or saved in an array
*/
@ -1762,7 +1762,7 @@ function PMA_linkOrButton($url, $message, $tag_params = array(),
/**
* Returns a given timespan value in a readable format.
*
* @param int $seconds the timespan
* @param int $seconds the timespan
*
* @return string the formatted value
*/
@ -1791,8 +1791,8 @@ function PMA_timespanFormat($seconds)
* http://sf.net/tracker/?func=detail&aid=544361&group_id=23067&atid=377411
*
* @todo add a multibyte safe function PMA_STR_split()
* @param string $string The string
* @param string $Separator The Separator (defaults to "<br />\n")
* @param string $string The string
* @param string $Separator The Separator (defaults to "<br />\n")
*
* @access public
* @return string The flipped string
@ -1838,11 +1838,11 @@ function PMA_flipstring($string, $Separator = "<br />\n")
* would have to check if the error message file is always available
*
* @todo use PMA_fatalError() if $die === true?
* @param array $params The names of the parameters needed by the calling script.
* @param bool $die Stop the execution?
* @param array $params The names of the parameters needed by the calling script.
* @param bool $die Stop the execution?
* (Set this manually to false in the calling script
* until you know all needed parameters to check).
* @param bool $request Whether to include this list in checking for special params.
* @param bool $request Whether to include this list in checking for special params.
* @global string path to current script
* @global boolean flag whether any special variable was required
*
@ -1889,11 +1889,11 @@ function PMA_checkParameters($params, $die = true, $request = true)
/**
* Function to generate unique condition for specified row.
*
* @param resource $handle current query result
* @param integer $fields_cnt number of fields
* @param array $fields_meta meta information about fields
* @param array $row current row
* @param boolean $force_unique generate condition only on pk or unique
* @param resource $handle current query result
* @param integer $fields_cnt number of fields
* @param array $fields_meta meta information about fields
* @param array $row current row
* @param boolean $force_unique generate condition only on pk or unique
*
* @access public
* @return array the calculated condition and whether condition is unique
@ -2011,12 +2011,12 @@ function PMA_getUniqueCondition($handle, $fields_cnt, $fields_meta, $row, $force
/**
* Generate a button or image tag
*
* @param string $button_name name of button element
* @param string $button_class class of button element
* @param string $image_name name of image element
* @param string $text text to display
* @param string $image image to display
* @param string $value
* @param string $button_name name of button element
* @param string $button_class class of button element
* @param string $image_name name of image element
* @param string $text text to display
* @param string $image image to display
* @param string $value
*
* @access public
*/
@ -2052,17 +2052,17 @@ function PMA_buttonOrImage($button_name, $button_class, $image_name, $text,
/**
* Generate a pagination selector for browsing resultsets
*
* @param int $rows Number of rows in the pagination set
* @param int $pageNow current page number
* @param int $nbTotalPage number of total pages
* @param int $showAll If the number of pages is lower than this
* @param int $rows Number of rows in the pagination set
* @param int $pageNow current page number
* @param int $nbTotalPage number of total pages
* @param int $showAll If the number of pages is lower than this
* variable, no pages will be omitted in pagination
* @param int $sliceStart How many rows at the beginning should always be shown?
* @param int $sliceEnd How many rows at the end should always be shown?
* @param int $percent Percentage of calculation page offsets to hop to a next page
* @param int $range Near the current page, how many pages should
* @param int $sliceStart How many rows at the beginning should always be shown?
* @param int $sliceEnd How many rows at the end should always be shown?
* @param int $percent Percentage of calculation page offsets to hop to a next page
* @param int $range Near the current page, how many pages should
* be considered "nearby" and displayed as well?
* @param string $prompt The prompt to display (sometimes empty)
* @param string $prompt The prompt to display (sometimes empty)
*
* @return string
* @access public
@ -2151,12 +2151,12 @@ function PMA_pageselector($rows, $pageNow = 1, $nbTotalPage = 1,
* Generate navigation for a list
*
* @todo use $pos from $_url_params
* @param int $count number of elements in the list
* @param int $pos current position in the list
* @param array $_url_params url parameters
* @param string $script script name for form target
* @param string $frame target frame
* @param int $max_count maximum number of elements to display from the list
* @param int $count number of elements in the list
* @param int $pos current position in the list
* @param array $_url_params url parameters
* @param string $script script name for form target
* @param string $frame target frame
* @param int $max_count maximum number of elements to display from the list
*
* @access public
*/
@ -2238,7 +2238,7 @@ function PMA_listNavigator($count, $pos, $_url_params, $script, $frame, $max_cou
* $user_dir = PMA_userDir('/var/pma_tmp/%u/'); // '/var/pma_tmp/root/'
*
* </code>
* @param string $dir with wildcard for user
* @param string $dir with wildcard for user
* @return string per user directory
*/
function PMA_userDir($dir)
@ -2254,7 +2254,7 @@ function PMA_userDir($dir)
/**
* returns html code for db link to default db page
*
* @param string $database
* @param string $database
* @return string html link to default db page
*/
function PMA_getDbLink($database = null)
@ -2277,10 +2277,10 @@ function PMA_getDbLink($database = null)
* Displays a lightbulb hint explaining a known external bug
* that affects a functionality
*
* @param string $functionality localized message explaining the func.
* @param string $component 'mysql' (eventually, 'php')
* @param string $minimum_version of this component
* @param string $bugref bug reference for this component
* @param string $functionality localized message explaining the func.
* @param string $component 'mysql' (eventually, 'php')
* @param string $minimum_version of this component
* @param string $bugref bug reference for this component
*/
function PMA_externalBug($functionality, $component, $minimum_version, $bugref)
{
@ -2292,10 +2292,10 @@ function PMA_externalBug($functionality, $component, $minimum_version, $bugref)
/**
* Generates and echoes an HTML checkbox
*
* @param string $html_field_name the checkbox HTML field
* @param string $label
* @param boolean $checked is it initially checked?
* @param boolean $onclick should it submit the form on click?
* @param string $html_field_name the checkbox HTML field
* @param string $label
* @param boolean $checked is it initially checked?
* @param boolean $onclick should it submit the form on click?
*/
function PMA_display_html_checkbox($html_field_name, $label, $checked, $onclick) {
@ -2305,12 +2305,12 @@ function PMA_display_html_checkbox($html_field_name, $label, $checked, $onclick)
/**
* Generates and echoes a set of radio HTML fields
*
* @param string $html_field_name the radio HTML field
* @param array $choices the choices values and labels
* @param string $checked_choice the choice to check by default
* @param boolean $line_break whether to add an HTML line break after a choice
* @param boolean $escape_label whether to use htmlspecialchars() on label
* @param string $class enclose each choice with a div of this class
* @param string $html_field_name the radio HTML field
* @param array $choices the choices values and labels
* @param string $checked_choice the choice to check by default
* @param boolean $line_break whether to add an HTML line break after a choice
* @param boolean $escape_label whether to use htmlspecialchars() on label
* @param string $class enclose each choice with a div of this class
*/
function PMA_display_html_radio($html_field_name, $choices, $checked_choice = '', $line_break = true, $escape_label = true, $class='') {
foreach ($choices as $choice_value => $choice_label) {
@ -2337,10 +2337,10 @@ function PMA_display_html_radio($html_field_name, $choices, $checked_choice = ''
/**
* Generates and returns an HTML dropdown
*
* @param string $select_name
* @param array $choices choices values
* @param string $active_choice the choice to select by default
* @param string $id id of the select element; can be different in case
* @param string $select_name
* @param array $choices choices values
* @param string $active_choice the choice to select by default
* @param string $id id of the select element; can be different in case
* the dropdown is present more than once on the page
* @return string
* @todo support titles
@ -2365,8 +2365,8 @@ function PMA_generate_html_dropdown($select_name, $choices, $active_choice, $id)
* controlling the slider; you have to generate the </div> yourself
* after the sliding section.
*
* @param string $id the id of the <div> on which to apply the effect
* @param string $message the message to show as a link
* @param string $id the id of the <div> on which to apply the effect
* @param string $message the message to show as a link
*/
function PMA_generate_slider_effect($id, $message)
{
@ -2389,10 +2389,10 @@ function PMA_generate_slider_effect($id, $message)
/**
* Creates an AJAX sliding toggle button (or and equivalent form when AJAX is disabled)
*
* @param string $action The URL for the request to be executed
* @param string $select_name The name for the dropdown box
* @param array $options An array of options (see rte_footer.lib.php)
* @param string $callback A JS snippet to execute when the request is
* @param string $action The URL for the request to be executed
* @param string $select_name The name for the dropdown box
* @param array $options An array of options (see rte_footer.lib.php)
* @param string $callback A JS snippet to execute when the request is
* successfully processed
*
* @return string HTML code for the toggle button
@ -2543,8 +2543,8 @@ function PMA_cacheUnset($var, $server = 0)
* in MySQL a BIT field can be from 1 to 64 bits so we need this
* function because in PHP, decbin() supports only 32 bits
*
* @param numeric $value coming from a BIT field
* @param integer $length
* @param numeric $value coming from a BIT field
* @param integer $length
* @return string the printable value
*/
function PMA_printable_bit_value($value, $length) {
@ -2559,7 +2559,7 @@ function PMA_printable_bit_value($value, $length) {
/**
* Verifies whether the value contains a non-printable character
*
* @param string $value
* @param string $value
* @return boolean
*/
function PMA_contains_nonprintable_ascii($value) {
@ -2570,7 +2570,7 @@ function PMA_contains_nonprintable_ascii($value) {
* Converts a BIT type default value
* for example, b'010' becomes 010
*
* @param string $bit_default_value
* @param string $bit_default_value
* @return string the converted value
*/
function PMA_convert_bit_default_value($bit_default_value) {
@ -2580,7 +2580,7 @@ function PMA_convert_bit_default_value($bit_default_value) {
/**
* Extracts the various parts from a field type spec
*
* @param string $fieldspec
* @param string $fieldspec
* @return array associative array containing type, spec_in_brackets
* and possibly enum_set_values (another array)
*/
@ -2656,7 +2656,7 @@ function PMA_extractFieldSpec($fieldspec) {
/**
* Verifies if this table's engine supports foreign keys
*
* @param string $engine
* @param string $engine
* @return boolean
*/
function PMA_foreignkey_supported($engine) {
@ -2671,7 +2671,7 @@ function PMA_foreignkey_supported($engine) {
/**
* Replaces some characters by a displayable equivalent
*
* @param string $content
* @param string $content
* @return string the content with characters replaced
*/
function PMA_replace_binary_contents($content) {
@ -2798,9 +2798,9 @@ function PMA_expandUserString($string, $escape = null, $updates = array()) {
* function that generates a json output for an ajax request and ends script
* execution
*
* @param bool $message message string containing the html of the message
* @param bool $success success whether the ajax request was successfull
* @param array $extra_data extra_data optional - any other data as part of the json request
* @param bool $message message string containing the html of the message
* @param bool $success success whether the ajax request was successfull
* @param array $extra_data extra_data optional - any other data as part of the json request
*
*/
function PMA_ajaxResponse($message, $success = true, $extra_data = array())
@ -2924,8 +2924,8 @@ function PMA_buildActionTitles() {
* $cfg['ColumnTypes'] and either returns an array (useful for quickly checking
* if a datatype is supported) or an HTML snippet that creates a drop-down list.
*
* @param bool $html Whether to generate an html snippet or an array
* @param string $selected The value to mark as selected in HTML mode
* @param bool $html Whether to generate an html snippet or an array
* @param string $selected The value to mark as selected in HTML mode
*
* @return mixed An HTML snippet or an array of datatypes.
*
@ -3007,9 +3007,9 @@ function PMA_unsupportedDatatypes() {
/**
* Creates a dropdown box with MySQL functions for a particular column.
*
* @param array $field Data about the column for which
* @param array $field Data about the column for which
* to generate the dropdown
* @param bool $insert_mode Whether the operation is 'insert'
* @param bool $insert_mode Whether the operation is 'insert'
*
* @global array $cfg PMA configuration
* @global array $analyzed_sql Analyzed SQL query
@ -3112,10 +3112,10 @@ function PMA_getFunctionsForField($field, $insert_mode)
* // user has this privilege on database 'mydb'.
*
*
* @param string $priv The privilege to check
* @param mixed $db null, to only check global privileges
* @param string $priv The privilege to check
* @param mixed $db null, to only check global privileges
* string, db name where to also check for privileges
* @param mixed $tbl null, to only check global privileges
* @param mixed $tbl null, to only check global privileges
* string, db name where to also check for privileges
* @return bool
*/

58
libraries/core.lib.php
View File

@ -30,9 +30,9 @@
* </code>
*
* @see PMA_isValid()
* @param mixed $var param to check
* @param mixed $default default value
* @param mixed $type var type or array of values to check against $var
* @param mixed $var param to check
* @param mixed $default default value
* @param mixed $type var type or array of values to check against $var
* @return mixed $var or $default
*/
function PMA_ifSetOr(&$var, $default = null, $type = 'similar')
@ -80,9 +80,9 @@ function PMA_ifSetOr(&$var, $default = null, $type = 'similar')
* @todo create some testsuites
* @todo add some more var types like hex, bin, ...?
* @see http://php.net/gettype
* @param mixed $var variable to check
* @param mixed $type var type or array of valid values to check against $var
* @param mixed $compare var to compare with $var
* @param mixed $var variable to check
* @param mixed $type var type or array of valid values to check against $var
* @param mixed $compare var to compare with $var
* @return boolean whether valid or not
*/
function PMA_isValid(&$var, $type = 'length', $compare = null)
@ -171,7 +171,7 @@ function PMA_isValid(&$var, $type = 'length', $compare = null)
* require() when a part of the path comes from an insecure source
* like a cookie or form.
*
* @param string The path to check
* @param string The path to check
*
* @return string The secured path
*
@ -192,8 +192,8 @@ function PMA_securePath($path)
* loads language file if not loaded already
*
* @todo use detected argument separator (PMA_Config)
* @param string $error_message the error message or named error message
* @param string|array $message_args arguments applied to $error_message
* @param string $error_message the error message or named error message
* @param string|array $message_args arguments applied to $error_message
* @return exit
*/
function PMA_fatalError($error_message, $message_args = null)
@ -276,7 +276,7 @@ function PMA_warnMissingExtension($extension, $fatal = false, $extra = '')
/**
* returns count of tables in given db
*
* @param string $db database to count tables for
* @param string $db database to count tables for
* @return integer count of tables in $db
*/
function PMA_getTableCount($db)
@ -308,7 +308,7 @@ function PMA_getTableCount($db)
* (renamed with PMA prefix to avoid double definition when embedded
* in Moodle)
*
* @param string $size
* @param string $size
* @return integer $size
*/
function PMA_get_real_size($size = 0)
@ -343,9 +343,9 @@ function PMA_get_real_size($size = 0)
*
* @see http://php.net/array_merge
* @see http://php.net/array_merge_recursive
* @param array array to merge
* @param array array to merge
* @param array ...
* @param array array to merge
* @param array array to merge
* @param array ...
* @return array merged array
*/
function PMA_array_merge_recursive()
@ -398,8 +398,8 @@ function PMA_array_merge_recursive()
* @see http://www.php-security.org/MOPB/MOPB-02-2007.html
* @see http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2006-1549
*
* @param array $array array to walk
* @param string $function function to call for every array element
* @param array $array array to walk
* @param string $function function to call for every array element
*/
function PMA_arrayWalkRecursive(&$array, $function, $apply_to_keys_also = false)
{
@ -431,8 +431,8 @@ function PMA_arrayWalkRecursive(&$array, $function, $apply_to_keys_also = false)
* checks given given $page against given $whitelist and returns true if valid
* it ignores optionaly query paramters in $page (script.php?ignored)
*
* @param string &$page page to check
* @param array $whitelist whitelist to check page against
* @param string &$page page to check
* @param array $whitelist whitelist to check page against
* @return boolean whether $page is valid or not (in $whitelist or not)
*/
function PMA_checkPageValidity(&$page, $whitelist)
@ -460,7 +460,7 @@ function PMA_checkPageValidity(&$page, $whitelist)
* searchs in $_SERVER, $_ENV than trys getenv() and apache_getenv()
* in this order
*
* @param string $var_name variable name
* @param string $var_name variable name
* @return string value of $var or empty string
*/
function PMA_getenv($var_name) {
@ -481,7 +481,7 @@ function PMA_getenv($var_name) {
/**
* Send HTTP header, taking IIS limits into account (600 seems ok)
*
* @param string $uri the header to send
* @param string $uri the header to send
* @return boolean always true
*/
function PMA_sendHeaderLocation($uri)
@ -542,9 +542,9 @@ function PMA_sendHeaderLocation($uri)
* $path is a string describing position of an element in an associative array,
* eg. Servers/1/host refers to $array[Servers][1][host]
*
* @param string $path
* @param array $array
* @param mixed $default
* @param string $path
* @param array $array
* @param mixed $default
* @return mixed array element or $default
*/
function PMA_array_read($path, $array, $default = null)
@ -563,9 +563,9 @@ function PMA_array_read($path, $array, $default = null)
/**
* Stores value in an array
*
* @param string $path
* @param array &$array
* @param mixed $value
* @param string $path
* @param array &$array
* @param mixed $value
*/
function PMA_array_write($path, &$array, $value)
{
@ -584,9 +584,9 @@ function PMA_array_write($path, &$array, $value)
/**
* Removes value from an array
*
* @param string $path
* @param array &$array
* @param mixed $value
* @param string $path
* @param array &$array
* @param mixed $value
*/
function PMA_array_remove($path, &$array)
{

122
libraries/database_interface.lib.php
View File

@ -22,7 +22,7 @@ define('PMA_DBI_GETVAR_GLOBAL', 2);
/**
* Checks one of the mysql extensions
*
* @param string $extension mysql extension to check
* @param string $extension mysql extension to check
*/
function PMA_DBI_checkMysqlExtension($extension = 'mysql') {
if (! function_exists($extension . '_connect')) {
@ -145,7 +145,7 @@ function PMA_DBI_try_query($query, $link = null, $options = 0, $cache_affected_r
* uses language to charset mapping from mysql/share/errmsg.txt
* and charset names to ISO charset from information_schema.CHARACTER_SETS
*
* @param string $message
* @param string $message
* @return string $message
*/
function PMA_DBI_convert_message($message) {
@ -218,8 +218,8 @@ function PMA_DBI_convert_message($message) {
/**
* returns array with table names for given db
*
* @param string $database name of database
* @param mixed $link mysql link resource|object
* @param string $database name of database
* @param mixed $link mysql link resource|object
* @return array tables names
*/
function PMA_DBI_get_tables($database, $link = null)
@ -231,8 +231,8 @@ function PMA_DBI_get_tables($database, $link = null)
/**
* usort comparison callback
*
* @param string $a first argument to sort
* @param string $b second argument to sort
* @param string $a first argument to sort
* @param string $b second argument to sort
*
* @return integer a value representing whether $a should be before $b in the
* sorted array or not
@ -275,14 +275,14 @@ function PMA_usort_comparison_callback($a, $b)
* </code>
*
* @todo move into PMA_Table
* @param string $database database
* @param string|false $table table
* @param boolean|string $tbl_is_group $table is a table group
* @param resource $link mysql link
* @param integer $limit_offset zero-based offset for the count
* @param boolean|integer $limit_count number of tables to return
* @param string $sort_by table attribute to sort by
* @param string $sort_order direction to sort (ASC or DESC)
* @param string $database database
* @param string|false $table table
* @param boolean|string $tbl_is_group $table is a table group
* @param resource $link mysql link
* @param integer $limit_offset zero-based offset for the count
* @param boolean|integer $limit_count number of tables to return
* @param string $sort_by table attribute to sort by
* @param string $sort_order direction to sort (ASC or DESC)
* @return array list of tables in given db(s)
*/
function PMA_DBI_get_tables_full($database, $table = false, $tbl_is_group = false, $link = null,
@ -526,13 +526,13 @@ function PMA_DBI_get_tables_full($database, $table = false, $tbl_is_group = fals
* returns array with databases containing extended infos about them
*
* @todo move into PMA_List_Database?
* @param string $database database
* @param boolean $force_stats retrieve stats also for MySQL < 5
* @param resource $link mysql link
* @param string $sort_by column to order by
* @param string $sort_order ASC or DESC
* @param integer $limit_offset starting offset for LIMIT
* @param bool|int $limit_count row count for LIMIT or true for $GLOBALS['cfg']['MaxDbList']
* @param string $database database
* @param boolean $force_stats retrieve stats also for MySQL < 5
* @param resource $link mysql link
* @param string $sort_by column to order by
* @param string $sort_order ASC or DESC
* @param integer $limit_offset starting offset for LIMIT
* @param bool|int $limit_count row count for LIMIT or true for $GLOBALS['cfg']['MaxDbList']
* @return array $databases
*/
function PMA_DBI_get_databases_full($database = null, $force_stats = false,
@ -698,10 +698,10 @@ function PMA_DBI_get_databases_full($database = null, $force_stats = false,
* returns detailed array with all columns for given table in database,
* or all tables/databases
*
* @param string $database name of database
* @param string $table name of table to retrieve columns from
* @param string $column name of specific column
* @param mixed $link mysql link resource
* @param string $database name of database
* @param string $table name of table to retrieve columns from
* @param string $column name of specific column
* @param mixed $link mysql link resource
* @return array
*/
function PMA_DBI_get_columns_full($database = null, $table = null,
@ -825,10 +825,10 @@ function PMA_DBI_get_columns_full($database = null, $table = null,
/**
* array PMA_DBI_get_columns(string $database, string $table, bool $full = false, mysql db link $link = null)
*
* @param string $database name of database
* @param string $table name of table to retrieve columns from
* @param boolean $full whether to return full info or only column names
* @param mixed $link mysql link resource
* @param string $database name of database
* @param string $table name of table to retrieve columns from
* @param boolean $full whether to return full info or only column names
* @param mixed $link mysql link resource
* @return array column names
*/
function PMA_DBI_get_columns($database, $table, $full = false, $link = null)
@ -846,9 +846,9 @@ function PMA_DBI_get_columns($database, $table, $full = false, $link = null)
/**
* returns value of given mysql server variable
*
* @param string $var mysql server variable name
* @param int $type PMA_DBI_GETVAR_SESSION|PMA_DBI_GETVAR_GLOBAL
* @param mixed $link mysql link resource|object
* @param string $var mysql server variable name
* @param int $type PMA_DBI_GETVAR_SESSION|PMA_DBI_GETVAR_GLOBAL
* @param mixed $link mysql link resource|object
* @return mixed value for mysql server variable
*/
@ -881,8 +881,8 @@ function PMA_DBI_get_variable($var, $type = PMA_DBI_GETVAR_SESSION, $link = null
* Function called just after a connection to the MySQL database server has been established
* It sets the connection collation, and determins the version of MySQL which is running.
*
* @param mixed $link mysql link resource|object
* @param boolean $is_controluser
* @param mixed $link mysql link resource|object
* @param boolean $is_controluser
*/
function PMA_DBI_postConnect($link, $is_controluser = false)
{
@ -938,13 +938,13 @@ function PMA_DBI_postConnect($link, $is_controluser = false)
* // $user_name = 'John Doe'
* </code>
*
* @param string|mysql_result $result query or mysql result
* @param integer $row_number row to fetch the value from,
* @param string|mysql_result $result query or mysql result
* @param integer $row_number row to fetch the value from,
* starting at 0, with 0 beeing default
* @param integer|string $field field to fetch the value from,
* @param integer|string $field field to fetch the value from,
* starting at 0, with 0 beeing default
* @param resource $link mysql link
* @param mixed $options
* @param resource $link mysql link
* @param mixed $options
* @return mixed value of first field in first row from result
* or false if not found
*/
@ -993,12 +993,12 @@ function PMA_DBI_fetch_value($result, $row_number = 0, $field = 0, $link = null,
* // $user = array('id' => 123, 'name' => 'John Doe')
* </code>
*
* @param string|mysql_result $result query or mysql result
* @param string $type NUM|ASSOC|BOTH
* @param string|mysql_result $result query or mysql result
* @param string $type NUM|ASSOC|BOTH
* returned array should either numeric
* associativ or booth
* @param resource $link mysql link
* @param mixed $options
* @param resource $link mysql link
* @param mixed $options
* @return array|boolean first row from result
* or false if result is empty
*/
@ -1072,13 +1072,13 @@ function PMA_DBI_fetch_single_row($result, $type = 'ASSOC', $link = null, $optio
* // $users['admin']['John Doe'] = '123'
* </code>
*
* @param string|mysql_result $result query or mysql result
* @param string|integer $key field-name or offset
* @param string|mysql_result $result query or mysql result
* @param string|integer $key field-name or offset
* used as key for array
* @param string|integer $value value-name or offset
* @param string|integer $value value-name or offset
* used as value for array
* @param resource $link mysql link
* @param mixed $options
* @param resource $link mysql link
* @param mixed $options
* @return array resultrows or values indexed by $key
*/
function PMA_DBI_fetch_result($result, $key = null, $value = null,
@ -1202,7 +1202,7 @@ function PMA_DBI_getCompatibilities()
/**
* returns warnings for last query
*
* @param resource $link mysql link resource
* @param resource $link mysql link resource
* @return array warnings
*/
function PMA_DBI_get_warnings($link = null)
@ -1245,9 +1245,9 @@ function PMA_isSuperuser()
/**
* returns an array of PROCEDURE or FUNCTION names for a db
*
* @param string $db db name
* @param string $which PROCEDURE | FUNCTION
* @param resource $link mysql link
* @param string $db db name
* @param string $which PROCEDURE | FUNCTION
* @param resource $link mysql link
*
* @return array the procedure names or function names
*/
@ -1266,10 +1266,10 @@ function PMA_DBI_get_procedures_or_functions($db, $which, $link = null)
/**
* returns the definition of a specific PROCEDURE, FUNCTION or EVENT
*
* @param string $db db name
* @param string $which PROCEDURE | FUNCTION | EVENT
* @param string $name the procedure|function|event name
* @param resource $link mysql link
* @param string $db db name
* @param string $which PROCEDURE | FUNCTION | EVENT
* @param string $name the procedure|function|event name
* @param resource $link mysql link
*
* @return string the definition
*/
@ -1287,9 +1287,9 @@ function PMA_DBI_get_definition($db, $which, $name, $link = null)
/**
* returns details about the TRIGGERs for a specific table or database
*
* @param string $db db name
* @param string $table table name
* @param string $delimiter the delimiter to use (may be empty)
* @param string $db db name
* @param string $table table name
* @param string $delimiter the delimiter to use (may be empty)
*
* @return array information about triggers (may be empty)
*/
@ -1352,8 +1352,8 @@ function PMA_DBI_get_triggers($db, $table = '', $delimiter = '//')
/**
* Returns true if $db.$view_name is a view, false if not
*
* @param string $db database name
* @param string $view_name view/table name
* @param string $db database name
* @param string $view_name view/table name
*
* @return bool true if $db.$view_name is a view, false if not
*/

6
libraries/db_info.inc.php
View File

@ -35,9 +35,9 @@ $pos = $_SESSION['tmp_user_values']['table_limit_offset'];
/**
* fills given tooltip arrays
*
* @param array $tooltip_truename tooltip data
* @param array $tooltip_aliasname tooltip data
* @param array $table tabledata
* @param array $tooltip_truename tooltip data
* @param array $tooltip_aliasname tooltip data
* @param array $table tabledata
*/
function PMA_fillTooltip(&$tooltip_truename, &$tooltip_aliasname, $table)
{

10
libraries/db_structure.lib.php
View File

@ -13,8 +13,8 @@ if (! defined('PHPMYADMIN')) {
* void PMA_TableHeader([bool $db_is_information_schema = false])
* display table header (<table><thead>...</thead><tbody>)
*
* @param boolean $db_is_information_schema
* @param boolean $replication
* @param boolean $db_is_information_schema
* @param boolean $replication
*/
function PMA_TableHeader($db_is_information_schema = false, $replication = false)
{
@ -65,9 +65,9 @@ function PMA_TableHeader($db_is_information_schema = false, $replication = false
/**
* Creates a clickable column header for table information
*
* @param string title to use for the link
* @param string corresponds to sortable data name mapped in libraries/db_info.inc.php
* @param string initial sort order
* @param string title to use for the link
* @param string corresponds to sortable data name mapped in libraries/db_info.inc.php
* @param string initial sort order
* @returns string link to be displayed in the table header
*/
function PMA_SortableTableHeader($title, $sort, $initial_sort_order = 'ASC')

4
libraries/display_select_lang.lib.php
View File

@ -12,8 +12,8 @@ if (! defined('PHPMYADMIN')) {
/**
* Sorts available languages by their true english names
*
* @param array the array to be sorted
* @param mixed a required parameter
* @param array the array to be sorted
* @param mixed a required parameter
* @return the sorted array
* @access private
*/

148
libraries/display_tbl.lib.php
View File

@ -28,9 +28,9 @@ require_once './libraries/Index.class.php';
* the "display printable view" option.
* Of course '0'/'1' means the feature won't/will be enabled.
*
* @param string &$the_disp_mode the synthetic value for display_mode (see a few
* @param string &$the_disp_mode the synthetic value for display_mode (see a few
* lines above for explanations)
* @param integer &$the_total the total number of rows returned by the SQL query
* @param integer &$the_total the total number of rows returned by the SQL query
* without any programmatically appended "LIMIT" clause
* (just a copy of $unlim_num_rows if it exists, else
* computed inside this function)
@ -463,10 +463,10 @@ function PMA_displayTableNavigation($pos_next, $pos_prev, $sql_query, $id_for_di
/**
* Displays the headers of the results table
*
* @param array which elements to display
* @param array the list of fields properties
* @param integer the total number of fields returned by the SQL query
* @param array the analyzed query
* @param array which elements to display
* @param array the list of fields properties
* @param integer the total number of fields returned by the SQL query
* @param array the analyzed query
*
* @return boolean $clause_is_unique
*
@ -1060,9 +1060,9 @@ function PMA_displayTableHeaders(&$is_display, &$fields_meta, $fields_cnt = 0, $
/**
* Prepares the display for a value
*
* @param string $class
* @param string $condition_field
* @param string $value
* @param string $class
* @param string $condition_field
* @param string $value
*
* @return string the td
*/
@ -1073,8 +1073,8 @@ function PMA_buildValueDisplay($class, $condition_field, $value) {
/**
* Prepares the display for a null value
*
* @param string $class
* @param string $condition_field
* @param string $class
* @param string $condition_field
*
* @return string the td
*/
@ -1086,9 +1086,9 @@ function PMA_buildNullDisplay($class, $condition_field) {
/**
* Prepares the display for an empty value
*
* @param string $class
* @param string $condition_field
* @param string $align
* @param string $class
* @param string $condition_field
* @param string $align
*
* @return string the td
*/
@ -1142,11 +1142,11 @@ function PMA_addClass($class, $condition_field, $meta, $nowrap, $is_field_trunca
/**
* Displays the body of the results table
*
* @param integer the link id associated to the query which results have
* @param integer the link id associated to the query which results have
* to be displayed
* @param array which elements to display
* @param array the list of relations
* @param array the analyzed query
* @param array which elements to display
* @param array the list of relations
* @param array the analyzed query
*
* @return boolean always true
*
@ -2026,10 +2026,10 @@ function PMA_displayTable_checkConfigParams()
* Displays a table of results returned by a SQL query.
* This function is called by the "sql.php" script.
*
* @param integer the link id associated to the query which results have
* @param integer the link id associated to the query which results have
* to be displayed
* @param array the display mode
* @param array the analyzed query
* @param array the display mode
* @param array the analyzed query
*
* @global string $db the database name
* @global string $table the table name
@ -2392,8 +2392,8 @@ function default_function($buffer) {
/**
* Displays operations that are available on results.
*
* @param array the display mode
* @param array the analyzed query
* @param array the display mode
* @param array the analyzed query
*
* @global string $db the database name
* @global string $table the table name
@ -2535,12 +2535,12 @@ function PMA_displayResultsOperations($the_disp_mode, $analyzed_sql) {
* Verifies what to do with non-printable contents (binary or BLOB)
* in Browse mode.
*
* @param string $category BLOB|BINARY|GEOMETRY
* @param string $content the binary content
* @param string $transform_function
* @param string $transform_options
* @param string $default_function
* @param object $meta the meta-information about this field
* @param string $category BLOB|BINARY|GEOMETRY
* @param string $content the binary content
* @param string $transform_function
* @param string $transform_options
* @param string $default_function
* @param object $meta the meta-information about this field
* @return mixed string or float
*/
function PMA_handle_non_printable_contents($category, $content, $transform_function, $transform_options, $default_function, $meta, $url_params = array()) {
@ -2580,17 +2580,17 @@ function PMA_handle_non_printable_contents($category, $content, $transform_funct
* Prepares the displayable content of a data cell in Browse mode,
* taking into account foreign key description field and transformations
*
* @param string $class
* @param string $condition_field
* @param string $analyzed_sql
* @param object $meta the meta-information about this field
* @param string $map
* @param string $data
* @param string $transform_function
* @param string $default_function
* @param string $nowrap
* @param string $where_comparison
* @param bool $is_field_truncated
* @param string $class
* @param string $condition_field
* @param string $analyzed_sql
* @param object $meta the meta-information about this field
* @param string $map
* @param string $data
* @param string $transform_function
* @param string $default_function
* @param string $nowrap
* @param string $where_comparison
* @param bool $is_field_truncated
* @return string formatted data
*/
function PMA_prepare_row_data($class, $condition_field, $analyzed_sql, $meta, $map, $data, $transform_function, $default_function, $nowrap, $where_comparison, $transform_options, $is_field_truncated ) {
@ -2681,13 +2681,13 @@ function PMA_prepare_row_data($class, $condition_field, $analyzed_sql, $meta, $m
/**
* Generates a checkbox for multi-row submits
*
* @param string $del_url
* @param array $is_display
* @param string $row_no
* @param string $where_clause_html
* @param string $del_query
* @param string $id_suffix
* @param string $class
* @param string $del_url
* @param array $is_display
* @param string $row_no
* @param string $where_clause_html
* @param string $del_query
* @param string $id_suffix
* @param string $class
* @return string the generated HTML
*/
@ -2710,11 +2710,11 @@ function PMA_generateCheckboxForMulti($del_url, $is_display, $row_no, $where_cla
/**
* Generates an Edit link
*
* @param string $edit_url
* @param string $class
* @param string $edit_str
* @param string $where_clause
* @param string $where_clause_html
* @param string $edit_url
* @param string $class
* @param string $edit_str
* @param string $where_clause
* @param string $where_clause_html
* @return string the generated HTML
*/
function PMA_generateEditLink($edit_url, $class, $edit_str, $where_clause, $where_clause_html) {
@ -2737,10 +2737,10 @@ function PMA_generateEditLink($edit_url, $class, $edit_str, $where_clause, $wher
/**
* Generates an Copy link
*
* @param string $copy_url
* @param string $copy_str
* @param string $where_clause
* @param string $where_clause_html
* @param string $copy_url
* @param string $copy_str
* @param string $where_clause
* @param string $where_clause_html
* @return string the generated HTML
*/
function PMA_generateCopyLink($copy_url, $copy_str, $where_clause, $where_clause_html, $class) {
@ -2767,10 +2767,10 @@ function PMA_generateCopyLink($copy_url, $copy_str, $where_clause, $where_clause
/**
* Generates a Delete link
*
* @param string $del_url
* @param string $del_str
* @param string $js_conf
* @param string $class
* @param string $del_url
* @param string $del_str
* @param string $js_conf
* @param string $class
* @return string the generated HTML
*/
function PMA_generateDeleteLink($del_url, $del_str, $js_conf, $class) {
@ -2791,20 +2791,20 @@ function PMA_generateDeleteLink($del_url, $del_str, $js_conf, $class) {
* Generates checkbox and links at some position (left or right)
* (only called for horizontal mode)
*
* @param string $position
* @param string $del_url
* @param array $is_display
* @param string $row_no
* @param string $where_clause
* @param string $where_clause_html
* @param string $del_query
* @param string $id_suffix
* @param string $edit_url
* @param string $copy_url
* @param string $class
* @param string $edit_str
* @param string $del_str
* @param string $js_conf
* @param string $position
* @param string $del_url
* @param array $is_display
* @param string $row_no
* @param string $where_clause
* @param string $where_clause_html
* @param string $del_query
* @param string $id_suffix
* @param string $edit_url
* @param string $copy_url
* @param string $class
* @param string $edit_str
* @param string $del_str
* @param string $js_conf
* @return string the generated HTML
*/
function PMA_generateCheckboxAndLinks($position, $del_url, $is_display, $row_no, $where_clause, $where_clause_html, $del_query, $id_suffix, $edit_url, $copy_url, $class, $edit_str, $copy_str, $del_str, $js_conf) {

16
libraries/export/codegen.php
View File

@ -73,7 +73,7 @@ function PMA_exportHeader()
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -86,7 +86,7 @@ function PMA_exportDBHeader($db)
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -99,7 +99,7 @@ function PMA_exportDBFooter($db)
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -112,11 +112,11 @@ function PMA_exportDBCreate($db)
/**
* Outputs the content of a table in NHibernate format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

16
libraries/export/csv.php
View File

@ -96,7 +96,7 @@ function PMA_exportHeader() {
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -108,7 +108,7 @@ function PMA_exportDBHeader($db) {
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -120,7 +120,7 @@ function PMA_exportDBFooter($db) {
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -132,11 +132,11 @@ function PMA_exportDBCreate($db) {
/**
* Outputs the content of a table in CSV format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

36
libraries/export/htmlword.php
View File

@ -69,7 +69,7 @@ xmlns="http://www.w3.org/TR/REC-html40">
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -81,7 +81,7 @@ function PMA_exportDBHeader($db) {
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -93,7 +93,7 @@ function PMA_exportDBFooter($db) {
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -105,11 +105,11 @@ function PMA_exportDBCreate($db) {
/**
* Outputs the content of a table in HTML (Microsoft Word) format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public
@ -170,20 +170,20 @@ function PMA_exportData($db, $table, $crlf, $error_url, $sql_query)
/**
* Outputs table's structure
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $do_relation whether to include relation comments
* @param bool $do_comments whether to include the pmadb-style column comments
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $do_relation whether to include relation comments
* @param bool $do_comments whether to include the pmadb-style column comments
* as comments in the structure; this is deprecated
* but the parameter is left here because export.php
* calls PMA_exportStructure() also for other export
* types which use this parameter
* @param bool $do_mime whether to include mime comments
* @param bool $dates whether to include creation/update/check dates
* @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in'
* @param string $export_type 'server', 'database', 'table'
* @param bool $do_mime whether to include mime comments
* @param bool $dates whether to include creation/update/check dates
* @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in'
* @param string $export_type 'server', 'database', 'table'
* @return bool Whether it suceeded
*
* @access public

16
libraries/export/json.php
View File

@ -67,7 +67,7 @@ function PMA_exportHeader()
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -81,7 +81,7 @@ function PMA_exportDBHeader($db)
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -94,7 +94,7 @@ function PMA_exportDBFooter($db)
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -107,11 +107,11 @@ function PMA_exportDBCreate($db)
/**
* Outputs the content of a table in JSON format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

38
libraries/export/latex.php
View File

@ -85,7 +85,7 @@ if (isset($plugin_list)) {
/**
* Escapes some special characters for use in TeX/LaTeX
*
* @param string the string to convert
* @param string the string to convert
*
* @return string the converted string with escape codes
*
@ -140,7 +140,7 @@ function PMA_exportHeader() {
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -156,7 +156,7 @@ function PMA_exportDBHeader($db) {
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -168,7 +168,7 @@ function PMA_exportDBFooter($db) {
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -180,11 +180,11 @@ function PMA_exportDBCreate($db) {
/**
* Outputs the content of a table in LaTeX table/sideways table environment
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public
@ -277,20 +277,20 @@ function PMA_exportData($db, $table, $crlf, $error_url, $sql_query) {
/**
* Outputs table's structure
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $do_relation whether to include relation comments
* @param bool $do_comments whether to include the pmadb-style column comments
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $do_relation whether to include relation comments
* @param bool $do_comments whether to include the pmadb-style column comments
* as comments in the structure; this is deprecated
* but the parameter is left here because export.php
* calls PMA_exportStructure() also for other export
* types which use this parameter
* @param bool $do_mime whether to include mime comments
* @param bool $dates whether to include creation/update/check dates
* @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in'
* @param string $export_type 'server', 'database', 'table'
* @param bool $do_mime whether to include mime comments
* @param bool $dates whether to include creation/update/check dates
* @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in'
* @param string $export_type 'server', 'database', 'table'
* @return bool Whether it suceeded
*
* @access public

16
libraries/export/mediawiki.php
View File

@ -49,7 +49,7 @@ function PMA_exportHeader() {
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -61,7 +61,7 @@ function PMA_exportDBHeader($db) {
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -73,7 +73,7 @@ function PMA_exportDBFooter($db) {
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -85,11 +85,11 @@ function PMA_exportDBCreate($db) {
/**
* Outputs the content of a table in MediaWiki format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

16
libraries/export/ods.php
View File

@ -102,7 +102,7 @@ function PMA_exportHeader() {
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -114,7 +114,7 @@ function PMA_exportDBHeader($db) {
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -126,7 +126,7 @@ function PMA_exportDBFooter($db) {
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -138,11 +138,11 @@ function PMA_exportDBCreate($db) {
/**
* Outputs the content of a table in ODS format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

36
libraries/export/odt.php
View File

@ -100,7 +100,7 @@ function PMA_exportHeader() {
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -113,7 +113,7 @@ function PMA_exportDBHeader($db) {
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -125,7 +125,7 @@ function PMA_exportDBFooter($db) {
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -137,11 +137,11 @@ function PMA_exportDBCreate($db) {
/**
* Outputs the content of a table in ODT format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public
@ -209,20 +209,20 @@ function PMA_exportData($db, $table, $crlf, $error_url, $sql_query) {
/**
* Outputs table's structure
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $do_relation whether to include relation comments
* @param bool $do_comments whether to include the pmadb-style column comments
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $do_relation whether to include relation comments
* @param bool $do_comments whether to include the pmadb-style column comments
* as comments in the structure; this is deprecated
* but the parameter is left here because export.php
* calls PMA_exportStructure() also for other export
* types which use this parameter
* @param bool $do_mime whether to include mime comments
* @param bool $dates whether to include creation/update/check dates
* @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in'
* @param string $export_type 'server', 'database', 'table'
* @param bool $do_mime whether to include mime comments
* @param bool $dates whether to include creation/update/check dates
* @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in'
* @param string $export_type 'server', 'database', 'table'
* @return bool Whether it suceeded
*
* @access public

16
libraries/export/pdf.php
View File

@ -408,7 +408,7 @@ function PMA_exportHeader()
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -421,7 +421,7 @@ function PMA_exportDBHeader($db)
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -434,7 +434,7 @@ function PMA_exportDBFooter($db)
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -447,11 +447,11 @@ function PMA_exportDBCreate($db)
/**
* Outputs the content of a table in PDF format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

16
libraries/export/php_array.php
View File

@ -68,7 +68,7 @@ function PMA_exportHeader()
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -82,7 +82,7 @@ function PMA_exportDBHeader($db)
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -95,7 +95,7 @@ function PMA_exportDBFooter($db)
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -108,11 +108,11 @@ function PMA_exportDBCreate($db)
/**
* Outputs the content of a table as a fragment of PHP code
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

70
libraries/export/sql.php
View File

@ -304,7 +304,7 @@ if (! isset($sql_backquotes)) {
/**
* Exports routines (procedures and functions)
*
* @param string $db
* @param string $db
* @return bool Whether it suceeded
*
* @access public
@ -371,7 +371,7 @@ function PMA_exportRoutines($db) {
/**
* Possibly outputs comment
*
* @param string $text Text of comment
* @param string $text Text of comment
* @return string The formatted comment
*
* @access private
@ -536,7 +536,7 @@ function PMA_exportHeader()
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -572,7 +572,7 @@ function PMA_exportDBCreate($db)
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -588,7 +588,7 @@ function PMA_exportDBHeader($db)
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -642,9 +642,9 @@ function PMA_exportDBFooter($db)
/**
* Returns a stand-in CREATE definition to resolve view dependencies
*
* @param string $db the database name
* @param string $view the view name
* @param string $crlf the end of line sequence
* @param string $db the database name
* @param string $view the view name
* @param string $crlf the end of line sequence
* @return string resulting definition
*
* @access public
@ -673,13 +673,13 @@ function PMA_getTableDefStandIn($db, $view, $crlf) {
/**
* Returns $table's CREATE definition
*
* @param string $db the database name
* @param string $table the table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $show_dates whether to include creation/update/check dates
* @param bool $add_semicolon whether to add semicolon and end-of-line at the end
* @param bool $view whether we're handling a view
* @param string $db the database name
* @param string $table the table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $show_dates whether to include creation/update/check dates
* @param bool $add_semicolon whether to add semicolon and end-of-line at the end
* @param bool $view whether we're handling a view
* @return string resulting schema
*
* @access public
@ -878,11 +878,11 @@ function PMA_getTableDef($db, $table, $crlf, $error_url, $show_dates = false, $a
/**
* Returns $table's comments, relations etc.
*
* @param string $db database name
* @param string $table table name
* @param string $crlf end of line sequence
* @param bool $do_relation whether to include relation comments
* @param bool $do_mime whether to include mime comments
* @param string $db database name
* @param string $table table name
* @param string $crlf end of line sequence
* @param bool $do_relation whether to include relation comments
* @param bool $do_mime whether to include mime comments
* @return string resulting comments
*
* @access private
@ -947,20 +947,20 @@ function PMA_getTableComments($db, $table, $crlf, $do_relation = false, $do_mime
/**
* Outputs table's structure
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $relation whether to include relation comments
* @param bool $comments whether to include the pmadb-style column comments
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $relation whether to include relation comments
* @param bool $comments whether to include the pmadb-style column comments
* as comments in the structure; this is deprecated
* but the parameter is left here because export.php
* calls PMA_exportStructure() also for other export
* types which use this parameter
* @param bool $mime whether to include mime comments
* @param bool $dates whether to include creation/update/check dates
* @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in'
* @param string $export_type 'server', 'database', 'table'
* @param bool $mime whether to include mime comments
* @param bool $dates whether to include creation/update/check dates
* @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in'
* @param string $export_type 'server', 'database', 'table'
* @return bool Whether it suceeded
*
* @access public
@ -1025,11 +1025,11 @@ function PMA_exportStructure($db, $table, $crlf, $error_url, $relation = false,
/**
* Outputs the content of a table in SQL format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

36
libraries/export/texytext.php
View File

@ -57,7 +57,7 @@ function PMA_exportHeader() {
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -69,7 +69,7 @@ function PMA_exportDBHeader($db) {
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -81,7 +81,7 @@ function PMA_exportDBFooter($db) {
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -93,11 +93,11 @@ function PMA_exportDBCreate($db) {
/**
* Outputs the content of a table in Texy format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public
@ -152,20 +152,20 @@ function PMA_exportData($db, $table, $crlf, $error_url, $sql_query)
/**
* Outputs table's structure
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $do_relation whether to include relation comments
* @param bool $do_comments whether to include the pmadb-style column comments
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param bool $do_relation whether to include relation comments
* @param bool $do_comments whether to include the pmadb-style column comments
* as comments in the structure; this is deprecated
* but the parameter is left here because export.php
* calls PMA_exportStructure() also for other export
* types which use this parameter
* @param bool $do_mime whether to include mime comments
* @param bool $dates whether to include creation/update/check dates
* @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in'
* @param string $export_type 'server', 'database', 'table'
* @param bool $do_mime whether to include mime comments
* @param bool $dates whether to include creation/update/check dates
* @param string $export_mode 'create_table', 'triggers', 'create_view', 'stand_in'
* @param string $export_type 'server', 'database', 'table'
* @return bool Whether it suceeded
*
* @access public

16
libraries/export/xls.php
View File

@ -91,7 +91,7 @@ function PMA_exportHeader() {
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -105,7 +105,7 @@ function PMA_exportDBHeader($db) {
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -117,7 +117,7 @@ function PMA_exportDBFooter($db) {
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -129,11 +129,11 @@ function PMA_exportDBCreate($db) {
/**
* Outputs the content of a table in XLS format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

16
libraries/export/xlsx.php
View File

@ -90,7 +90,7 @@ function PMA_exportHeader() {
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -104,7 +104,7 @@ function PMA_exportDBHeader($db) {
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -116,7 +116,7 @@ function PMA_exportDBFooter($db) {
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -128,11 +128,11 @@ function PMA_exportDBCreate($db) {
/**
* Outputs the content of a table in XLSX format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

16
libraries/export/xml.php
View File

@ -233,7 +233,7 @@ function PMA_exportHeader() {
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -258,7 +258,7 @@ function PMA_exportDBHeader($db) {
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -278,7 +278,7 @@ function PMA_exportDBFooter($db) {
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -290,11 +290,11 @@ function PMA_exportDBCreate($db) {
/**
* Outputs the content of a table in XML format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

16
libraries/export/yaml.php
View File

@ -64,7 +64,7 @@ function PMA_exportHeader()
/**
* Outputs database header
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -77,7 +77,7 @@ function PMA_exportDBHeader($db)
/**
* Outputs database footer
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -90,7 +90,7 @@ function PMA_exportDBFooter($db)
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $db Database name
* @return bool Whether it suceeded
*
* @access public
@ -103,11 +103,11 @@ function PMA_exportDBCreate($db)
/**
* Outputs the content of a table in YAML format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
* @return bool Whether it suceeded
*
* @access public

10
libraries/file_listing.php
View File

@ -10,8 +10,8 @@
/**
* Returns array of filtered file names
*
* @param string directory to list
* @param string regular expression to match files
* @param string directory to list
* @param string regular expression to match files
* @returns array sorted file list on success, false on failure
*/
function PMA_getDirContent($dir, $expression = '')
@ -39,9 +39,9 @@ function PMA_getDirContent($dir, $expression = '')
/**
* Returns options of filtered file names
*
* @param string directory to list
* @param string regullar expression to match files
* @param string currently active choice
* @param string directory to list
* @param string regullar expression to match files
* @param string currently active choice
* @returns array sorted file list on success, false on failure
*/
function PMA_getFileSelectOptions($dir, $extensions = '', $active = '')

6
libraries/grab_globals.lib.php
View File

@ -15,9 +15,9 @@ if (! defined('PHPMYADMIN')) {
/**
* copy values from one array to another, usually from a superglobal into $GLOBALS
*
* @param array $array values from
* @param array $target values to
* @param boolean $sanitize prevent importing key names in $_import_blacklist
* @param array $array values from
* @param array $target values to
* @param boolean $sanitize prevent importing key names in $_import_blacklist
*/
function PMA_recursive_extract($array, &$target, $sanitize = true)
{

6
libraries/iconv_wrapper.lib.php
View File

@ -40,9 +40,9 @@ $gnu_iconv_to_aix_iconv_codepage_map = array (
* Wrapper around IBM AIX iconv(), whose character set naming differs
* from the GNU version of iconv().
*
* @param string input character set
* @param string output character set
* @param string the string to convert
* @param string input character set
* @param string output character set
* @param string the string to convert
*
* @return mixed converted string or false on failure
*

50
libraries/import.lib.php
View File

@ -44,7 +44,7 @@ function PMA_checkTimeout()
/**
* Detects what compression filse uses
*
* @param string $filepath filename to check
* @param string $filepath filename to check
* @return string MIME type of compression, none for none
* @access public
*/
@ -73,9 +73,9 @@ function PMA_detectCompression($filepath)
* Runs query inside import buffer. This is needed to allow displaying
* of last SELECT, SHOW or HANDLER results and similar nice stuff.
*
* @param string $sql query to run
* @param string $full query to display, this might be commented
* @param bool $controluser whether to use control user for queries
* @param string $sql query to run
* @param string $full query to display, this might be commented
* @param bool $controluser whether to use control user for queries
* @access public
*/
function PMA_importRunQuery($sql = '', $full = '', $controluser = false)
@ -207,9 +207,9 @@ function PMA_importRunQuery($sql = '', $full = '', $controluser = false)
/**
* Looks for the presence of USE to possibly change current db
*
* @param string $buffer buffer to examine
* @param string $db current db
* @param bool $reload reload
* @param string $buffer buffer to examine
* @param string $db current db
* @param bool $reload reload
* @return array (current or new db, whether to reload)
* @access public
*/
@ -227,7 +227,7 @@ function PMA_lookForUse($buffer, $db, $reload)
/**
* Returns next part of imported file/buffer
*
* @param int $size size of buffer to read (this is maximal size function will return)
* @param int $size size of buffer to read (this is maximal size function will return)
* @return string part of file/buffer
* @access public
*/
@ -331,7 +331,7 @@ function PMA_importGetNextChunk($size = 32768)
*
* @access public
*
* @param int $num
* @param int $num
* @return string The column's "Excel" name
*/
function PMA_getColumnAlphaName($num)
@ -378,7 +378,7 @@ function PMA_getColumnAlphaName($num)
*
* @access public
*
* @param string $name (i.e. "A", or "BC", etc.)
* @param string $name (i.e. "A", or "BC", etc.)
* @return int The column number
*/
function PMA_getColumnNumberFromName($name) {
@ -437,7 +437,7 @@ define("SIZES", 1);
*
* @access public
*
* @param string $last_cumulative_size
* @param string $last_cumulative_size
* @return int Precision of the given decimal size notation
*/
function PMA_getM($last_cumulative_size) {
@ -449,7 +449,7 @@ function PMA_getM($last_cumulative_size) {
*
* @access public
*
* @param string $last_cumulative_size
* @param string $last_cumulative_size
* @return int Scale of the given decimal size notation
*/
function PMA_getD($last_cumulative_size) {
@ -461,7 +461,7 @@ function PMA_getD($last_cumulative_size) {
*
* @access public
*
* @param string &$cell
* @param string &$cell
* @return array Contains the precision, scale, and full size representation of the given decimal cell
*/
function PMA_getDecimalSize(&$cell) {
@ -482,10 +482,10 @@ function PMA_getDecimalSize(&$cell) {
*
* @access public
*
* @param string $last_cumulative_size Last cumulative column size
* @param int $last_cumulative_type Last cumulative column type (NONE or VARCHAR or DECIMAL or INT or BIGINT)
* @param int $curr_type Type of the current cell (NONE or VARCHAR or DECIMAL or INT or BIGINT)
* @param string &$cell The current cell
* @param string $last_cumulative_size Last cumulative column size
* @param int $last_cumulative_type Last cumulative column type (NONE or VARCHAR or DECIMAL or INT or BIGINT)
* @param int $curr_type Type of the current cell (NONE or VARCHAR or DECIMAL or INT or BIGINT)
* @param string &$cell The current cell
* @return string Size of the given cell in the type-appropriate format
*/
function PMA_detectSize($last_cumulative_size, $last_cumulative_type, $curr_type, &$cell) {
@ -693,8 +693,8 @@ function PMA_detectSize($last_cumulative_size, $last_cumulative_type, $curr_type
*
* @access public
*
* @param int $last_cumulative_type Last cumulative column type (VARCHAR or INT or BIGINT or DECIMAL or NONE)
* @param string &$cell String representation of the cell for which a best-fit type is to be determined
* @param int $last_cumulative_type Last cumulative column type (VARCHAR or INT or BIGINT or DECIMAL or NONE)
* @param string &$cell String representation of the cell for which a best-fit type is to be determined
* @return int The MySQL type representation (VARCHAR or INT or BIGINT or DECIMAL or NONE)
*/
function PMA_detectType($last_cumulative_type, &$cell) {
@ -733,7 +733,7 @@ function PMA_detectType($last_cumulative_type, &$cell) {
*
* @access public
*
* @param &$table array(string $table_name, array $col_names, array $rows)
* @param &$table array(string $table_name, array $col_names, array $rows)
* @return array array(array $types, array $sizes)
*/
function PMA_analyzeTable(&$table) {
@ -826,11 +826,11 @@ $import_notice = null;
*
* @access public
*
* @param string $db_name Name of the database
* @param array &$tables Array of tables for the specified database
* @param array &$analyses Analyses of the tables
* @param array &$additional_sql Additional SQL statements to be executed
* @param array $options Associative array of options
* @param string $db_name Name of the database
* @param array &$tables Array of tables for the specified database
* @param array &$analyses Analyses of the tables
* @param array &$additional_sql Additional SQL statements to be executed
* @param array $options Associative array of options
* @return void
*/
function PMA_buildSQL($db_name, &$tables, &$analyses = null, &$additional_sql = null, $options = null) {

6
libraries/ip_allow_deny.lib.php
View File

@ -56,8 +56,8 @@ function PMA_getIp()
* Does not match:
* xxx.xxx.xxx.xx[yyy-zzz] (range, partial octets not supported)
*
* @param string string of IP range to match
* @param string string of IP to test against range
* @param string string of IP range to match
* @param string string of IP to test against range
*
* @return boolean always true
*
@ -112,7 +112,7 @@ function PMA_ipMaskTest($testRange, $ipToTest)
/**
* Runs through IP Allow/Deny rules the use of it below for more information
*
* @param string 'allow' | 'deny' type of rule to match
* @param string 'allow' | 'deny' type of rule to match
*
* @return bool Matched a rule ?
*

6
libraries/js_escape.lib.php
View File

@ -13,8 +13,8 @@
* This function is used to displays a javascript confirmation box for
* "DROP/DELETE/ALTER" queries.
*
* @param string $a_string the string to format
* @param boolean $add_backquotes whether to add backquotes to the string or not
* @param string $a_string the string to format
* @param boolean $add_backquotes whether to add backquotes to the string or not
*
* @return string the formatted string
*
@ -42,7 +42,7 @@ function PMA_jsFormat($a_string = '', $add_backquotes = true)
* We also remove NUL byte as some browsers (namely MSIE) ignore it and
* inserting it anywhere inside </script would allow to bypass this check.
*
* @param string $string the string to be escaped
* @param string $string the string to be escaped
* @return string the escaped string
*/
function PMA_escapeJsString($string)

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

@ -65,9 +65,9 @@ function PMA_change_enc_order() {
* Kanji string encoding convert
* 2002/1/4 by Y.Kawada
*
* @param string the string to convert
* @param string the destination encoding code
* @param string set 'kana' convert to JIS-X208-kana
* @param string the string to convert
* @param string the destination encoding code
* @param string set 'kana' convert to JIS-X208-kana
*
* @global string the available encoding codes list
*
@ -98,9 +98,9 @@ function PMA_kanji_str_conv($str, $enc, $kana) {
* Kanji file encoding convert
* 2002/1/4 by Y.Kawada
*
* @param string the name of the file to convert
* @param string the destination encoding code
* @param string set 'kana' convert to JIS-X208-kana
* @param string the name of the file to convert
* @param string the destination encoding code
* @param string set 'kana' convert to JIS-X208-kana
*
* @return string the name of the converted file
*/
@ -131,7 +131,7 @@ function PMA_kanji_file_conv($file, $enc, $kana) {
* Defines radio form fields to switch between encoding modes
* 2002/1/4 by Y.Kawada
*
* @param string spaces character to prepend the output with
* @param string spaces character to prepend the output with
*
* @return string xhtml code for the radio controls
*/

4
libraries/mysql_charsets.lib.php
View File

@ -153,7 +153,7 @@ function PMA_generateCharsetQueryPart($collation) {
/**
* returns collation of given db
*
* @param string $db name of db
* @param string $db name of db
* @return string collation of $db
*/
function PMA_getDbCollation($db) {
@ -190,7 +190,7 @@ function PMA_getServerCollation() {
* returns description for given collation
*
*
* @param string $collation MySQL collation string
* @param string $collation MySQL collation string
* @return string collation description
*/
function PMA_getCollationDescr($collation) {

4
libraries/opendocument.lib.php
View File

@ -23,8 +23,8 @@ $GLOBALS['OpenDocumentNS'] = 'xmlns:office="urn:oasis:names:tc:opendocument:xmln
/**
* Minimalistic creator of OASIS OpenDocument
*
* @param string desired MIME type
* @param string document content
* @param string desired MIME type
* @param string document content
*
* @return string OASIS OpenDocument data
*

40
libraries/plugin_interface.lib.php
View File

@ -11,8 +11,8 @@
*
* Reads all plugin information from directory $plugins_dir.
*
* @param string $plugins_dir directrory with plugins
* @param mixed $plugin_param parameter to plugin by which they can decide whether they can work
* @param string $plugins_dir directrory with plugins
* @param mixed $plugin_param parameter to plugin by which they can decide whether they can work
* @return array list of plugins
*/
function PMA_getPlugins($plugins_dir, $plugin_param)
@ -40,7 +40,7 @@ function PMA_getPlugins($plugins_dir, $plugin_param)
*
* returns locale string for $name or $name if no locale is found
*
* @param string $name for local string
* @param string $name for local string
* @return string locale string for $name
*/
function PMA_getString($name)
@ -53,9 +53,9 @@ function PMA_getString($name)
*
* returns html input tag option 'checked' if plugin $opt should be set by config or request
*
* @param string $section name of config section in
* @param string $section name of config section in
* $GLOBALS['cfg'][$section] for plugin
* @param string $opt name of option
* @param string $opt name of option
* @return string hmtl input tag option 'checked'
*/
function PMA_pluginCheckboxCheck($section, $opt)
@ -73,9 +73,9 @@ function PMA_pluginCheckboxCheck($section, $opt)
*
* returns default value for option $opt
*
* @param string $section name of config section in
* @param string $section name of config section in
* $GLOBALS['cfg'][$section] for plugin
* @param string $opt name of option
* @param string $opt name of option
* @return string default value for option $opt
*/
function PMA_pluginGetDefault($section, $opt)
@ -107,10 +107,10 @@ function PMA_pluginGetDefault($section, $opt)
*
* returns html input tag option 'checked' if option $opt should be set by config or request
*
* @param string $section name of config section in
* @param string $section name of config section in
* $GLOBALS['cfg'][$section] for plugin
* @param string $opt name of option
* @param string $val value of option to check against
* @param string $opt name of option
* @param string $val value of option to check against
* @return string html input tag option 'checked'
*/
function PMA_pluginIsActive($section, $opt, $val)
@ -131,11 +131,11 @@ function PMA_pluginIsActive($section, $opt, $val)
* returns html select form element for plugin choice
* and hidden fields denoting whether each plugin must be exported as a file
*
* @param string $section name of config section in
* @param string $section name of config section in
* $GLOBALS['cfg'][$section] for plugin
* @param string $name name of select element
* @param array &$list array with plugin configuration defined in plugin file
* @param string $cfgname name of config value, if none same as $name
* @param string $name name of select element
* @param array &$list array with plugin configuration defined in plugin file
* @param string $cfgname name of config value, if none same as $name
* @return string html select tag
*/
function PMA_pluginGetChoice($section, $name, &$list, $cfgname = null)
@ -173,11 +173,11 @@ function PMA_pluginGetChoice($section, $name, &$list, $cfgname = null)
*
* returns single option in a list element
*
* @param string $section name of config section in
* @param string $section name of config section in
* $GLOBALS['cfg'][$section] for plugin
* @param string $plugin_name unique plugin name
* @param string $id option id
* @param array &$opt plugin option details
* @param string $plugin_name unique plugin name
* @param string $id option id
* @param array &$opt plugin option details
* @return string table row with option
*/
function PMA_pluginGetOneOption($section, $plugin_name, $id, &$opt)
@ -285,8 +285,8 @@ function PMA_pluginGetOneOption($section, $plugin_name, $id, &$opt)
*
* return html div with editable options for plugin
*
* @param string $section name of config section in $GLOBALS['cfg'][$section]
* @param array &$list array with plugin configuration defined in plugin file
* @param string $section name of config section in $GLOBALS['cfg'][$section]
* @param array &$list array with plugin configuration defined in plugin file
* @return string html fieldset with plugin options
*/
function PMA_pluginGetOptions($section, &$list)

86
libraries/relation.lib.php
View File

@ -12,8 +12,8 @@ if (! defined('PHPMYADMIN')) {
/**
* Executes a query as controluser if possible, otherwise as normal user
*
* @param string the query to execute
* @param boolean whether to display SQL error messages or not
* @param string the query to execute
* @param boolean whether to display SQL error messages or not
*
* @return integer the result set, or false if no result set
*
@ -42,7 +42,7 @@ function PMA_query_as_controluser($sql, $show_error = true, $options = 0)
} // end of the "PMA_query_as_controluser()" function
/**
* @param bool $verbose whether to print diagnostic info
* @param bool $verbose whether to print diagnostic info
* @return array $cfgRelation
*/
function PMA_getRelationsParam($verbose = false)
@ -65,7 +65,7 @@ function PMA_getRelationsParam($verbose = false)
/**
* prints out diagnostic info for pma relation feature
*
* @param array $cfgRelation
* @param array $cfgRelation
*/
function PMA_printRelationsParamDiagnostic($cfgRelation)
{
@ -157,10 +157,10 @@ function PMA_printRelationsParamDiagnostic($cfgRelation)
/**
* prints out one diagnostic message for a feature
*
* @param string feature name in a message string
* @param string the $GLOBALS['cfgRelation'] parameter to check
* @param array utility messages
* @param boolean whether to skip a line after the message
* @param string feature name in a message string
* @param string the $GLOBALS['cfgRelation'] parameter to check
* @param array utility messages
* @param boolean whether to skip a line after the message
*/
function PMA_printDiagMessageForFeature($feature_name, $relation_parameter, $messages, $skip_line=true)
{
@ -175,10 +175,10 @@ function PMA_printDiagMessageForFeature($feature_name, $relation_parameter, $mes
/**
* prints out one diagnostic message for a configuration parameter
*
* @param string config parameter name to display
* @param boolean whether this parameter is set
* @param array utility messages
* @param string anchor in Documentation.html
* @param string config parameter name to display
* @param boolean whether this parameter is set
* @param array utility messages
* @param string anchor in Documentation.html
*/
function PMA_printDiagMessageForParameter($parameter, $relation_parameter_set, $messages, $doc_anchor)
{
@ -362,10 +362,10 @@ function PMA__getRelationsParam()
* optionally a given column in a table
*
* @access public
* @param string $db the name of the db to check for
* @param string $table the name of the table to check for
* @param string $column the name of the column to check for
* @param string $source the source for foreign key information
* @param string $db the name of the db to check for
* @param string $table the name of the table to check for
* @param string $column the name of the column to check for
* @param string $source the source for foreign key information
* @return array db,table,column
*/
function PMA_getForeigners($db, $table, $column = '', $source = 'both')
@ -458,8 +458,8 @@ function PMA_getForeigners($db, $table, $column = '', $source = 'both')
* Gets the display field of a table
*
* @access public
* @param string $db the name of the db to check for
* @param string $table the name of the table to check for
* @param string $db the name of the db to check for
* @param string $table the name of the table to check for
* @return string field name
*/
function PMA_getDisplayField($db, $table)
@ -503,8 +503,8 @@ function PMA_getDisplayField($db, $table)
* Gets the comments for all rows of a table or the db itself
*
* @access public
* @param string the name of the db to check for
* @param string the name of the table to check for
* @param string the name of the db to check for
* @param string the name of the table to check for
* @return array [field_name] = comment
*/
function PMA_getComments($db, $table = '')
@ -532,7 +532,7 @@ function PMA_getComments($db, $table = '')
* Gets the comment for a db
*
* @access public
* @param string the name of the db to check for
* @param string the name of the db to check for
* @return string comment
*/
function PMA_getDbComment($db)
@ -564,7 +564,7 @@ function PMA_getDbComment($db)
* Gets the comment for a db
*
* @access public
* @param string the name of the db to check for
* @param string the name of the db to check for
* @return string comment
*/
function PMA_getDbComments()
@ -595,8 +595,8 @@ function PMA_getDbComments()
* Set a database comment to a certain value.
*
* @access public
* @param string $db the name of the db
* @param string $comment the value of the column
* @param string $db the name of the db
* @param string $comment the value of the column
* @return boolean true, if comment-query was made.
*/
function PMA_setDbComment($db, $comment = '')
@ -638,10 +638,10 @@ function PMA_setDbComment($db, $comment = '')
/**
* Set a SQL history entry
*
* @param string $db the name of the db
* @param string $table the name of the table
* @param string $username the username
* @param string $sqlquery the sql query
* @param string $db the name of the db
* @param string $table the name of the table
* @param string $username the username
* @param string $sqlquery the sql query
* @access public
*/
function PMA_setHistory($db, $table, $username, $sqlquery)
@ -696,7 +696,7 @@ function PMA_setHistory($db, $table, $username, $sqlquery)
/**
* Gets a SQL history entry
*
* @param string $username the username
* @param string $username the username
* @return array list of history items
* @access public
*/
@ -725,7 +725,7 @@ function PMA_getHistory($username)
* deletes entries that exceeds $cfg['QueryHistoryMax'], oldest first, for the
* given user
*
* @param string $username the username
* @param string $username the username
* @access public
*/
function PMA_purgeHistory($username)
@ -758,9 +758,9 @@ function PMA_purgeHistory($username)
/**
* Prepares the dropdown for one mode
*
* @param array $foreign the keys and values for foreigns
* @param string $data the current data of the dropdown
* @param string $mode the needed mode
* @param array $foreign the keys and values for foreigns
* @param string $data the current data of the dropdown
* @param string $mode the needed mode
*
* @return array the <option value=""><option>s
*
@ -821,10 +821,10 @@ function PMA__foreignDropdownBuild($foreign, $data, $mode)
/**
* Outputs dropdown with values of foreign fields
*
* @param array array of the displayed row
* @param string the foreign field
* @param string the foreign field to display
* @param string the current data of the dropdown (field in row)
* @param array array of the displayed row
* @param string the foreign field
* @param string the foreign field to display
* @param string the current data of the dropdown (field in row)
* @return string the <option value=""><option>s
* @access public
*/
@ -893,11 +893,11 @@ function PMA_foreignDropdown($disp_row, $foreign_field, $foreign_display, $data,
/**
* Gets foreign keys in preparation for a drop-down selector
*
* @param array array of the foreign keys
* @param string the foreign field name
* @param bool whether to override the total
* @param string a possible filter
* @param string a possible LIMIT clause
* @param array array of the foreign keys
* @param string the foreign field name
* @param bool whether to override the total
* @param string a possible filter
* @param string a possible LIMIT clause
* @return array data about the foreign keys
* @access public
*/
@ -976,7 +976,7 @@ function PMA_getForeignData($foreigners, $field, $override_total, $foreign_filte
/**
* Finds all related tables
*
* @param string whether to go from master to foreign or vice versa
* @param string whether to go from master to foreign or vice versa
* @return boolean always true
* @global array $tab_left the list of tables that we still couldn't connect
* @global array $tab_know the list of allready connected tables

4
libraries/sanitizing.lib.php
View File

@ -18,8 +18,8 @@
*
* <a title="<?php echo PMA_sanitize($foo, true); ?>">bar</a>
*
* @param string the message
* @param boolean whether to escape html in result
* @param string the message
* @param boolean whether to escape html in result
*
* @return string the sanitized message
*

6
libraries/select_lang.lib.php
View File

@ -102,7 +102,7 @@ function PMA_langCheck()
* checks given lang and sets it if valid
* returns true on success, otherwise flase
*
* @param string $lang language to set
* @param string $lang language to set
* @return bool success
*/
function PMA_langSet(&$lang)
@ -121,8 +121,8 @@ function PMA_langSet(&$lang)
* Analyzes some PHP environment variables to find the most probable language
* that should be used
*
* @param string string to analyze
* @param integer type of the PHP environment variable which value is $str
* @param string string to analyze
* @param integer type of the PHP environment variable which value is $str
*
* @return bool true on success, otherwise false
*

4
libraries/select_server.lib.php
View File

@ -9,8 +9,8 @@
/**
* display server selection in list or selectbox form, or option tags only
*
* @param boolean $not_only_options whether to include form tags or not
* @param boolean $ommit_fieldset whether to ommit fieldset tag or not
* @param boolean $not_only_options whether to include form tags or not
* @param boolean $ommit_fieldset whether to ommit fieldset tag or not
*/
function PMA_select_server($not_only_options, $ommit_fieldset)
{

294
libraries/server_synchronize.lib.php
View File

@ -372,11 +372,11 @@ function PMA_findDeleteRowsFromTargetTables(&$delete_array, $matching_table, $ma
/**
* PMA_dataDiffInUncommonTables() finds the data difference in $source_tables_uncommon
*
* @param $source_tables_uncommon array of table names; containing table names that are in source db and not in target db
* @param $src_db name of source database
* @param $src_link connection established with source server
* @param $index index of a table from $matching_table array
* @param $row_count number of rows
* @param $source_tables_uncommon array of table names; containing table names that are in source db and not in target db
* @param $src_db name of source database
* @param $src_link connection established with source server
* @param $index index of a table from $matching_table array
* @param $row_count number of rows
* @return nothing
*/
function PMA_dataDiffInUncommonTables($source_tables_uncommon, $src_db, $src_link, $index, &$row_count)
@ -390,15 +390,15 @@ function PMA_dataDiffInUncommonTables($source_tables_uncommon, $src_db, $src_lin
* PMA_updateTargetTables() sets the updated field values to target table rows using $update_array[$matching_table_index]
*
*
* @param $table Array containing matching tables' names
* @param $update_array A three dimensional array containing field
* @param $table Array containing matching tables' names
* @param $update_array A three dimensional array containing field
* value updates required for each matching table
* @param $src_db Name of source database
* @param $trg_db Name of target database
* @param $trg_link Connection established with target server
* @param $matching_table_index index of matching table in matching_table_array
* @param $matching_table_keys
* @param $display true/false value
* @param $src_db Name of source database
* @param $trg_db Name of target database
* @param $trg_link Connection established with target server
* @param $matching_table_index index of matching table in matching_table_array
* @param $matching_table_keys
* @param $display true/false value
* @return nothing
*/
function PMA_updateTargetTables($table, $update_array, $src_db, $trg_db, $trg_link, $matching_table_index, $matching_table_keys, $display)
@ -447,30 +447,30 @@ function PMA_updateTargetTables($table, $update_array, $src_db, $trg_db, $trg_li
/**
* PMA_insertIntoTargetTable() inserts missing rows in the target table using $array_insert[$matching_table_index]
*
* @param $matching_table array containing matching table names
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $table_fields array containing field names of a table
* @param $array_insert
* @param $matching_table_index index of matching table in matching_table_array
* @param $matching_tables_keys array containing field names that are keys in the matching table
* @param $source_columns array containing source column information
* @param $add_column_array array containing column names that are to be added in target table
* @param $criteria array containing criterias like type, null, collation, default etc
* @param $target_tables_keys array containing field names that are keys in the target table
* @param $uncommon_tables array containing table names that are present in source db but not in targt db
* @param $uncommon_tables_fields array containing field names of the uncommon tables
* @param $uncommon_cols column names that are present in target table and not in source table
* @param $alter_str_array array containing column names that are to be altered
* @param $source_indexes column names on which indexes are made in source table
* @param $target_indexes column names on which indexes are made in target table
* @param $add_indexes_array array containing column names on which index is to be added in target table
* @param $alter_indexes_array array containing column names whose indexes are to be altered. Only index name and uniqueness of an index can be changed
* @param $delete_array array containing rows that are to be deleted
* @param $update_array array containing rows that are to be updated in target
* @param $display true/false value
* @param $matching_table array containing matching table names
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $table_fields array containing field names of a table
* @param $array_insert
* @param $matching_table_index index of matching table in matching_table_array
* @param $matching_tables_keys array containing field names that are keys in the matching table
* @param $source_columns array containing source column information
* @param $add_column_array array containing column names that are to be added in target table
* @param $criteria array containing criterias like type, null, collation, default etc
* @param $target_tables_keys array containing field names that are keys in the target table
* @param $uncommon_tables array containing table names that are present in source db but not in targt db
* @param $uncommon_tables_fields array containing field names of the uncommon tables
* @param $uncommon_cols column names that are present in target table and not in source table
* @param $alter_str_array array containing column names that are to be altered
* @param $source_indexes column names on which indexes are made in source table
* @param $target_indexes column names on which indexes are made in target table
* @param $add_indexes_array array containing column names on which index is to be added in target table
* @param $alter_indexes_array array containing column names whose indexes are to be altered. Only index name and uniqueness of an index can be changed
* @param $delete_array array containing rows that are to be deleted
* @param $update_array array containing rows that are to be updated in target
* @param $display true/false value
* @return nothing
*/
function PMA_insertIntoTargetTable($matching_table, $src_db, $trg_db, $src_link, $trg_link, $table_fields, &$array_insert, $matching_table_index,
@ -587,14 +587,14 @@ function PMA_insertIntoTargetTable($matching_table, $src_db, $trg_db, $src_link,
/**
* PMA_createTargetTables() Create the missing table $uncommon_table in target database
*
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $uncommon_tables names of tables present in source but not in target
* @param $table_index index of table in $uncommon_tables array
* @param $uncommon_tables_fields field names of the uncommon table
* @param $display true/false value
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $uncommon_tables names of tables present in source but not in target
* @param $table_index index of table in $uncommon_tables array
* @param $uncommon_tables_fields field names of the uncommon table
* @param $display true/false value
* @return nothing
*/
function PMA_createTargetTables($src_db, $trg_db, $src_link, $trg_link, &$uncommon_tables, $table_index, &$uncommon_tables_fields, $display)
@ -640,14 +640,14 @@ function PMA_createTargetTables($src_db, $trg_db, $src_link, $trg_link, &$uncomm
/**
* PMA_populateTargetTables() inserts data into uncommon tables after they have been created
*
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $uncommon_tables array containing uncommon table names (table names that are present in source but not in target db)
* @param $table_index index of table in matching_table_array
* @param $uncommon_tables_fields field names of the uncommon table
* @param $display true/false value
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $uncommon_tables array containing uncommon table names (table names that are present in source but not in target db)
* @param $table_index index of table in matching_table_array
* @param $uncommon_tables_fields field names of the uncommon table
* @param $display true/false value
*
* @return nothing
*
@ -682,13 +682,13 @@ function PMA_populateTargetTables($src_db, $trg_db, $src_link, $trg_link, $uncom
/**
* PMA_deleteFromTargetTable() delete rows from target table
*
* @param $trg_db name of target database
* @param $trg_link connection established with target server
* @param $matching_tables array containing matching table names
* @param $table_index index of table in matching_table_array
* @param $target_tables_keys primary key names of the target tables
* @param $delete_array array containing the key values of rows that are to be deleted
* @param $display true/false value
* @param $trg_db name of target database
* @param $trg_link connection established with target server
* @param $matching_tables array containing matching table names
* @param $table_index index of table in matching_table_array
* @param $target_tables_keys primary key names of the target tables
* @param $delete_array array containing the key values of rows that are to be deleted
* @param $display true/false value
* @return nothing
*/
function PMA_deleteFromTargetTable($trg_db, $trg_link, $matching_tables, $table_index, $target_tables_keys, $delete_array, $display)
@ -739,21 +739,21 @@ function PMA_deleteFromTargetTable($trg_db, $trg_link, $matching_tables, $table_
* Keys for all the source tables that have a corresponding target table are placed in $matching_tables_keys.
* Keys for all the target tables that have a corresponding source table are placed in $target_tables_keys.
*
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $matching_tables array containing names of matching tables
* @param $source_columns array containing columns information of the source tables
* @param $target_columns array containing columns information of the target tables
* @param $alter_str_array three dimensional associative array first index being the matching table index, second index being column name for which target
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $matching_tables array containing names of matching tables
* @param $source_columns array containing columns information of the source tables
* @param $target_columns array containing columns information of the target tables
* @param $alter_str_array three dimensional associative array first index being the matching table index, second index being column name for which target
* column have some criteria different and third index containing the criteria which is different.
* @param $add_column_array two dimensional associative array, first index of the array contain the matching table number and second index contain the
* @param $add_column_array two dimensional associative array, first index of the array contain the matching table number and second index contain the
* column name which is to be added in the target table
* @param $uncommon_columns array containing the columns that are present in the target table but not in the source table
* @param $criteria array containing the criterias which are to be checked for field that is present in source table and target table
* @param $target_tables_keys array containing the field names which is key in the target table
* @param $matching_table_index integer number of the matching table
* @param $uncommon_columns array containing the columns that are present in the target table but not in the source table
* @param $criteria array containing the criterias which are to be checked for field that is present in source table and target table
* @param $target_tables_keys array containing the field names which is key in the target table
* @param $matching_table_index integer number of the matching table
* @return nothing
*/
function PMA_structureDiffInTables($src_db, $trg_db, $src_link, $trg_link, $matching_tables, &$source_columns, &$target_columns, &$alter_str_array,
@ -802,22 +802,22 @@ function PMA_structureDiffInTables($src_db, $trg_db, $src_link, $trg_link, $matc
/**
* PMA_addColumnsInTargetTable() adds column that are present in source table but not in target table
*
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $matching_tables array containing names of matching tables
* @param $source_columns array containing columns information of the source tables
* @param $add_column_array array containing the names of the column(field) that are to be added in the target
* @param $matching_tables_fields
* @param $criteria array containing the criterias
* @param $matching_tables_keys array containing the field names which is key in the source table
* @param $target_tables_keys array containing the field names which is key in the target table
* @param $uncommon_tables array containing the table names that are present in source db and not in target db
* @param $uncommon_tables_fields array containing the names of the fields of the uncommon tables
* @param $table_counter integer number of the matching table
* @param $uncommon_cols
* @param $display true/false value
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $matching_tables array containing names of matching tables
* @param $source_columns array containing columns information of the source tables
* @param $add_column_array array containing the names of the column(field) that are to be added in the target
* @param $matching_tables_fields
* @param $criteria array containing the criterias
* @param $matching_tables_keys array containing the field names which is key in the source table
* @param $target_tables_keys array containing the field names which is key in the target table
* @param $uncommon_tables array containing the table names that are present in source db and not in target db
* @param $uncommon_tables_fields array containing the names of the fields of the uncommon tables
* @param $table_counter integer number of the matching table
* @param $uncommon_cols
* @param $display true/false value
* @return nothing
*/
function PMA_addColumnsInTargetTable($src_db, $trg_db, $src_link, $trg_link, $matching_tables, $source_columns, &$add_column_array, $matching_tables_fields,
@ -901,14 +901,14 @@ function PMA_addColumnsInTargetTable($src_db, $trg_db, $src_link, $trg_link, $ma
* PMA_checkForeignKeys() checks if the referenced table have foreign keys.
* uses PMA_createTargetTables()
*
* @param $src_db name of source database
* @param $src_link connection established with source server
* @param $trg_db name of target database
* @param $trg_link connection established with target server
* @param $referenced_table table whose column is a foreign key in another table
* @param $uncommon_tables array containing names that are uncommon
* @param $uncommon_tables_fields field names of the uncommon table
* @param $display true/false value
* @param $src_db name of source database
* @param $src_link connection established with source server
* @param $trg_db name of target database
* @param $trg_link connection established with target server
* @param $referenced_table table whose column is a foreign key in another table
* @param $uncommon_tables array containing names that are uncommon
* @param $uncommon_tables_fields field names of the uncommon table
* @param $display true/false value
* @return nothing
*/
function PMA_checkForeignKeys($src_db, $src_link, $trg_db, $trg_link ,$referenced_table, &$uncommon_tables, &$uncommon_tables_fields, $display)
@ -932,17 +932,17 @@ function PMA_checkForeignKeys($src_db, $src_link, $trg_db, $trg_link ,$reference
/**
* PMA_alterTargetTableStructure() alters structure of the target table using $alter_str_array
*
* @param $trg_db name of target database
* @param $trg_link connection established with target server
* @param $matching_tables array containing names of matching tables
* @param $source_columns array containing columns information of the source table
* @param $alter_str_array array containing the column name and criteria which is to be altered for the targert table
* @param $matching_tables_fields array containing the name of the fields for the matching table
* @param $criteria array containing the criterias
* @param $matching_tables_keys array containing the field names which is key in the source table
* @param $target_tables_keys array containing the field names which is key in the target table
* @param $matching_table_index integer number of the matching table
* @param $display true/false value
* @param $trg_db name of target database
* @param $trg_link connection established with target server
* @param $matching_tables array containing names of matching tables
* @param $source_columns array containing columns information of the source table
* @param $alter_str_array array containing the column name and criteria which is to be altered for the targert table
* @param $matching_tables_fields array containing the name of the fields for the matching table
* @param $criteria array containing the criterias
* @param $matching_tables_keys array containing the field names which is key in the source table
* @param $target_tables_keys array containing the field names which is key in the target table
* @param $matching_table_index integer number of the matching table
* @param $display true/false value
* @return nothing
*/
function PMA_alterTargetTableStructure($trg_db, $trg_link, $matching_tables, &$source_columns, &$alter_str_array, $matching_tables_fields, $criteria,
@ -1067,12 +1067,12 @@ function PMA_alterTargetTableStructure($trg_db, $trg_link, $matching_tables, &$s
/**
* PMA_removeColumnsFromTargetTable() removes the columns which are present in target table but not in source table.
*
* @param $trg_db name of target database
* @param $trg_link connection established with target server
* @param $matching_tables array containing names of matching tables
* @param $uncommon_columns array containing the names of the column which are to be dropped from the target table
* @param $table_counter index of the matching table as in $matchiing_tables array
* @param $display true/false value
* @param $trg_db name of target database
* @param $trg_link connection established with target server
* @param $matching_tables array containing names of matching tables
* @param $uncommon_columns array containing the names of the column which are to be dropped from the target table
* @param $table_counter index of the matching table as in $matchiing_tables array
* @param $display true/false value
* @return nothing
*/
function PMA_removeColumnsFromTargetTable($trg_db, $trg_link, $matching_tables, $uncommon_columns, $table_counter, $display)
@ -1123,17 +1123,17 @@ function PMA_removeColumnsFromTargetTable($trg_db, $trg_link, $matching_tables,
* indexes to be altered in $alter_indexes_array and indexes to be removed from target table in $remove_indexes_array.
* Only keyname and uniqueness characteristic of the indexes are altered.
*
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $matching_tables array containing the matching tables name
* @param $source_indexes array containing the indexes of the source table
* @param $target_indexes array containing the indexes of the target table
* @param $add_indexes_array array containing the name of the column on which the index is to be added in the target table
* @param $alter_indexes_array array containing the key name which needs to be altered
* @param $remove_indexes_array array containing the key name of the index which is to be removed from the target table
* @param $table_counter number of the matching table
* @param $src_db name of source database
* @param $trg_db name of target database
* @param $src_link connection established with source server
* @param $trg_link connection established with target server
* @param $matching_tables array containing the matching tables name
* @param $source_indexes array containing the indexes of the source table
* @param $target_indexes array containing the indexes of the target table
* @param $add_indexes_array array containing the name of the column on which the index is to be added in the target table
* @param $alter_indexes_array array containing the key name which needs to be altered
* @param $remove_indexes_array array containing the key name of the index which is to be removed from the target table
* @param $table_counter number of the matching table
* @return nothing
*/
function PMA_indexesDiffInTables($src_db, $trg_db, $src_link, $trg_link, $matching_tables, &$source_indexes, &$target_indexes, &$add_indexes_array,
@ -1188,16 +1188,16 @@ function PMA_indexesDiffInTables($src_db, $trg_db, $src_link, $trg_link, $matchi
/**
* PMA_applyIndexesDiff() create indexes, alters indexes and remove indexes.
*
* @param $trg_db name of target database
* @param $trg_link connection established with target server
* @param $matching_tables array containing the matching tables name
* @param $source_indexes array containing the indexes of the source table
* @param $target_indexes array containing the indexes of the target table
* @param $add_indexes_array array containing the column names on which indexes are to be created in target table
* @param $alter_indexes_array array containing the column names for which indexes are to be altered
* @param $remove_indexes_array array containing the key name of the indexes which are to be removed from the target table
* @param $table_counter number of the matching table
* @param $display true/false value
* @param $trg_db name of target database
* @param $trg_link connection established with target server
* @param $matching_tables array containing the matching tables name
* @param $source_indexes array containing the indexes of the source table
* @param $target_indexes array containing the indexes of the target table
* @param $add_indexes_array array containing the column names on which indexes are to be created in target table
* @param $alter_indexes_array array containing the column names for which indexes are to be altered
* @param $remove_indexes_array array containing the key name of the indexes which are to be removed from the target table
* @param $table_counter number of the matching table
* @param $display true/false value
* @return nothing
*/
function PMA_applyIndexesDiff ($trg_db, $trg_link, $matching_tables, $source_indexes, $target_indexes, $add_indexes_array, $alter_indexes_array,
@ -1276,7 +1276,7 @@ function PMA_applyIndexesDiff ($trg_db, $trg_link, $matching_tables, $source_ind
* PMA_displayQuery() displays a query, taking the maximum display size
* into account
*
* @param $query the query to display
* @param $query the query to display
* @return nothing
*/
function PMA_displayQuery($query) {
@ -1289,7 +1289,7 @@ function PMA_displayQuery($query) {
/**
* PMA_syncDisplayHeaderSource() shows the header for source database
*
* @param string $src_db source db name
* @param string $src_db source db name
* @return nothing
*/
function PMA_syncDisplayHeaderSource($src_db) {
@ -1311,8 +1311,8 @@ function PMA_syncDisplayHeaderSource($src_db) {
/**
* PMA_syncDisplayHeaderTargetAndMatchingTables() shows the header for target database and the matching tables
*
* @param string $trg_db target db name
* @param array $matching_tables
* @param string $trg_db target db name
* @param array $matching_tables
* @return boolean $odd_row current value of this toggle
*/
function PMA_syncDisplayHeaderTargetAndMatchingTables($trg_db, $matching_tables) {
@ -1338,7 +1338,7 @@ function PMA_syncDisplayHeaderTargetAndMatchingTables($trg_db, $matching_tables)
/**
* PMA_syncDisplayBeginTableRow() displays the TR tag for alternating colors
*
* @param boolean $odd_row current status of the toggle
* @param boolean $odd_row current status of the toggle
* @return boolean $odd_row final status of the toggle
*/
function PMA_syncDisplayBeginTableRow($odd_row) {
@ -1352,10 +1352,10 @@ function PMA_syncDisplayBeginTableRow($odd_row) {
/**
* array PMA_get_column_values (string $database, string $table, string $column , mysql db link $link = null)
*
* @param string $database name of database
* @param string $table name of table to retrieve columns from
* @param string $column name of the column to retrieve data from
* @param mixed $link mysql link resource
* @param string $database name of database
* @param string $table name of table to retrieve columns from
* @param string $column name of the column to retrieve data from
* @param mixed $link mysql link resource
* @return array $field_values
*/
function PMA_get_column_values($database, $table, $column, $link = null)
@ -1381,9 +1381,9 @@ function PMA_get_column_values($database, $table, $column, $link = null)
/**
* array PMA_get_table_indexes($database, $table, $link = null)
*
* @param string $database name of database
* @param string $table name of the table whose indexes are to be retreived
* @param mixed $link mysql link resource
* @param string $database name of database
* @param string $table name of the table whose indexes are to be retreived
* @param mixed $link mysql link resource
* @return array $indexes
*/
function PMA_get_table_indexes($database, $table, $link = null)

12
libraries/sql_query_form.lib.php
View File

@ -30,12 +30,12 @@ require_once './libraries/bookmark.lib.php'; // used for file listing
* @usedby tbl_structure.php
* @usedby tbl_tracking.php
* @usedby querywindow.php
* @param boolean|string $query query to display in the textarea
* @param boolean|string $query query to display in the textarea
* or true to display last executed
* @param boolean|string $display_tab sql|files|history|full|false
* @param boolean|string $display_tab sql|files|history|full|false
* what part to display
* false if not inside querywindow
* @param string $delimiter
* @param string $delimiter
*/
function PMA_sqlQueryForm($query = true, $display_tab = false, $delimiter = ';')
{
@ -157,9 +157,9 @@ function PMA_sqlQueryForm($query = true, $display_tab = false, $delimiter = ';')
* prints querybox fieldset
*
* @usedby PMA_sqlQueryForm()
* @param string $query query to display in the textarea
* @param boolean $is_querywindow if inside querywindow or not
* @param string $delimiter default delimiter to use
* @param string $query query to display in the textarea
* @param boolean $is_querywindow if inside querywindow or not
* @param string $delimiter default delimiter to use
*/
function PMA_sqlQueryFormInsert($query = '', $is_querywindow = false, $delimiter = ';')
{

34
libraries/sqlparser.lib.php
View File

@ -120,8 +120,8 @@ if (! defined('PMA_MINIMUM_COMMON')) {
/**
* Set an error message for the system
*
* @param string The error message
* @param string The failing SQL query
* @param string The error message
* @param string The failing SQL query
*
* @access private
* @scope SQL Parser internal
@ -141,8 +141,8 @@ if (! defined('PMA_MINIMUM_COMMON')) {
/**
* Do display the bug report
*
* @param string The error message
* @param string The failing SQL query
* @param string The error message
* @param string The failing SQL query
*
* @access public
*/
@ -182,7 +182,7 @@ if (! defined('PMA_MINIMUM_COMMON')) {
/**
* Parses the SQL queries
*
* @param string The SQL query list
* @param string The SQL query list
*
* @return mixed Most of times, nothing...
*
@ -795,8 +795,8 @@ if (! defined('PMA_MINIMUM_COMMON')) {
/**
* Checks for token types being what we want...
*
* @param string String of type that we have
* @param string String of type that we want
* @param string String of type that we have
* @param string String of type that we want
*
* @return boolean result of check
*
@ -820,7 +820,7 @@ if (! defined('PMA_MINIMUM_COMMON')) {
/**
* Analyzes SQL queries
*
* @param array The SQL queries
* @param array The SQL queries
*
* @return array The analyzed SQL queries
*
@ -2046,7 +2046,7 @@ if (! defined('PMA_MINIMUM_COMMON')) {
*
* @todo check why adding a "\n" after the </span> would cause extra blanks
* to be displayed: SELECT p . person_name
* @param array The SQL queries html formatted
* @param array The SQL queries html formatted
*
* @return array The colorized SQL queries
*
@ -2069,10 +2069,10 @@ if (! defined('PMA_MINIMUM_COMMON')) {
/**
* Formats SQL queries to html
*
* @param array The SQL queries
* @param string mode
* @param integer starting token
* @param integer number of tokens to format, -1 = all
* @param array The SQL queries
* @param string mode
* @param integer starting token
* @param integer number of tokens to format, -1 = all
*
* @return string The formatted SQL queries
*
@ -2663,9 +2663,9 @@ if (! defined('PMA_MINIMUM_COMMON')) {
/**
* Builds a CSS rule used for html formatted SQL queries
*
* @param string The class name
* @param string The property name
* @param string The property value
* @param string The class name
* @param string The property name
* @param string The property value
*
* @return string The CSS rule
*
@ -2716,7 +2716,7 @@ if (! defined('PMA_MINIMUM_COMMON')) {
/**
* Gets SQL queries with no format
*
* @param array The SQL queries list
* @param array The SQL queries list
*
* @return string The SQL queries with no format
*

68
libraries/sqlvalidator.class.php
View File

@ -73,7 +73,7 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Service opening
*
* @param string URL of Mimer SQL Validator WSDL file
* @param string URL of Mimer SQL Validator WSDL file
*
* @return object Object to use
*
@ -93,16 +93,16 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Service initializer to connect to server
*
* @param object Service object
* @param string Username
* @param string Password
* @param string Name of calling program
* @param string Version of calling program
* @param string Target DBMS
* @param string Version of target DBMS
* @param string Connection Technology
* @param string version of Connection Technology
* @param integer boolean of 1/0 to specify if we are an interactive system
* @param object Service object
* @param string Username
* @param string Password
* @param string Name of calling program
* @param string Version of calling program
* @param string Target DBMS
* @param string Version of target DBMS
* @param string Connection Technology
* @param string version of Connection Technology
* @param integer boolean of 1/0 to specify if we are an interactive system
*
* @return object stdClass return object with data
*
@ -139,10 +139,10 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Validator sytem call
*
* @param object Service object
* @param object Session object
* @param string SQL Query to validate
* @param string Data return type
* @param object Service object
* @param object Session object
* @param string SQL Query to validate
* @param string Data return type
*
* @return object stClass return with data
*
@ -170,7 +170,7 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Validator sytem call
*
* @param string SQL Query to validate
* @param string SQL Query to validate
*
* @return object stdClass return with data
*
@ -221,8 +221,8 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Sets credentials
*
* @param string the username
* @param string the password
* @param string the username
* @param string the password
*
* @access public
*/
@ -236,8 +236,8 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Sets the calling program
*
* @param string the calling program name
* @param string the calling program revision
* @param string the calling program name
* @param string the calling program revision
*
* @access public
*/
@ -251,8 +251,8 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Appends the calling program
*
* @param string the calling program name
* @param string the calling program revision
* @param string the calling program name
* @param string the calling program revision
*
* @access public
*/
@ -266,8 +266,8 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Sets the target DBMS
*
* @param string the target DBMS name
* @param string the target DBMS revision
* @param string the target DBMS name
* @param string the target DBMS revision
*
* @access public
*/
@ -281,8 +281,8 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Appends the target DBMS
*
* @param string the target DBMS name
* @param string the target DBMS revision
* @param string the target DBMS name
* @param string the target DBMS revision
*
* @access public
*/
@ -296,8 +296,8 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Sets the connection technology used
*
* @param string the connection technology name
* @param string the connection technology revision
* @param string the connection technology name
* @param string the connection technology revision
*
* @access public
*/
@ -311,8 +311,8 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Appends the connection technology used
*
* @param string the connection technology name
* @param string the connection technology revision
* @param string the connection technology name
* @param string the connection technology revision
*
* @access public
*/
@ -326,7 +326,7 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Sets whether interactive mode should be used or not
*
* @param integer whether interactive mode should be used or not
* @param integer whether interactive mode should be used or not
*
* @access public
*/
@ -339,7 +339,7 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Sets the output type to use
*
* @param string the output type to use
* @param string the output type to use
*
* @access public
*/
@ -399,7 +399,7 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Call to determine just if a query is valid or not.
*
* @param string SQL statement to validate
* @param string SQL statement to validate
*
* @return string Validator string from Mimer
*
@ -415,7 +415,7 @@ if (!$GLOBALS['sqlvalidator_error']) {
/**
* Call for complete validator response
*
* @param string SQL statement to validate
* @param string SQL statement to validate
*
* @return string Validator string from Mimer
*

2
libraries/sqlvalidator.lib.php
View File

@ -49,7 +49,7 @@ if ($cfg['SQLValidator']['use'] == true) {
*
* <http://developer.mimer.com/validator/index.htm>
*
* @param string SQL query to validate
* @param string SQL query to validate
*
* @return string Validator result string
*

16
libraries/string.lib.php
View File

@ -57,9 +57,9 @@ if ($GLOBALS['PMA_allow_ctype']) {
/**
* Checks if a given character position in the string is escaped or not
*
* @param string string to check for
* @param integer the character to check for
* @param integer starting position in the string
* @param string string to check for
* @param integer the character to check for
* @param integer starting position in the string
* @return boolean whether the character is escaped or not
*/
function PMA_STR_charIsEscaped($string, $pos, $start = 0)
@ -88,9 +88,9 @@ function PMA_STR_charIsEscaped($string, $pos, $start = 0)
/**
* Checks if a number is in a range
*
* @param integer number to check for
* @param integer lower bound
* @param integer upper bound
* @param integer number to check for
* @param integer lower bound
* @param integer upper bound
* @return boolean whether the number is in the range or not
*/
function PMA_STR_numberInRangeInclusive($num, $lower, $upper)
@ -101,8 +101,8 @@ function PMA_STR_numberInRangeInclusive($num, $lower, $upper)
/**
* Checks if a character is an SQL identifier
*
* @param string character to check for
* @param boolean whether the dot character is valid or not
* @param string character to check for
* @param boolean whether the dot character is valid or not
* @return boolean whether the character is an SQL identifier or not
*/
function PMA_STR_isSqlIdentifier($c, $dot_is_valid = false)

16
libraries/string_mb.lib.php
View File

@ -18,7 +18,7 @@
/**
* Returns length of string depending on current charset.
*
* @param string string to count
* @param string string to count
* @return int string length
*/
function PMA_strlen($string)
@ -29,9 +29,9 @@ function PMA_strlen($string)
/**
* Returns substring from string, works depending on current charset.
*
* @param string $string string to count
* @param int $start start of substring
* @param int $length length of substring
* @param string $string string to count
* @param int $start start of substring
* @param int $length length of substring
* @return string
*/
function PMA_substr($string, $start, $length = 2147483647)
@ -42,9 +42,9 @@ function PMA_substr($string, $start, $length = 2147483647)
/**
* Returns postion of $needle in $haystack or false if not found
*
* @param string $haystack
* @param string $needle
* @param int $offset
* @param string $haystack
* @param string $needle
* @param int $offset
* @return integer position of $needle in $haystack or false
*/
function PMA_strpos($haystack, $needle, $offset = 0)
@ -55,7 +55,7 @@ function PMA_strpos($haystack, $needle, $offset = 0)
/**
* Make a string lowercase
*
* @param string $string
* @param string $string
* @return string
*/
function PMA_strtolower($string)

16
libraries/string_native.lib.php
View File

@ -18,7 +18,7 @@
/**
* Returns length of string depending on current charset.
*
* @param string string to count
* @param string string to count
* @return int string length
*/
function PMA_strlen($string)
@ -29,9 +29,9 @@ function PMA_strlen($string)
/**
* Returns substring from string, works depending on current charset.
*
* @param string $string string to count
* @param int $start start of substring
* @param int $length length of substring
* @param string $string string to count
* @param int $start start of substring
* @param int $length length of substring
* @return string
*/
function PMA_substr($string, $start, $length = 2147483647)
@ -42,9 +42,9 @@ function PMA_substr($string, $start, $length = 2147483647)
/**
* Returns postion of $needle in $haystack or false if not found
*
* @param string $haystack
* @param string $needle
* @param int $offset
* @param string $haystack
* @param string $needle
* @param int $offset
* @return integer position of $needle in $haystack or false
*/
function PMA_strpos($haystack, $needle, $offset = 0)
@ -55,7 +55,7 @@ function PMA_strpos($haystack, $needle, $offset = 0)
/**
* Make a string lowercase
*
* @param string $string
* @param string $string
* @return string
*/
function PMA_strtolower($string)

14
libraries/string_type_ctype.lib.php
View File

@ -18,7 +18,7 @@
/**
* Checks if a character is an alphanumeric one
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is an alphanumeric one or not
*/
function PMA_STR_isAlnum($c)
@ -29,7 +29,7 @@ function PMA_STR_isAlnum($c)
/**
* Checks if a character is an alphabetic one
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is an alphabetic one or not
*/
function PMA_STR_isAlpha($c)
@ -40,7 +40,7 @@ function PMA_STR_isAlpha($c)
/**
* Checks if a character is a digit
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is a digit or not
*/
function PMA_STR_isDigit($c)
@ -51,7 +51,7 @@ function PMA_STR_isDigit($c)
/**
* Checks if a character is an upper alphabetic one
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is an upper alphabetic one or not
*/
function PMA_STR_isUpper($c)
@ -63,7 +63,7 @@ function PMA_STR_isUpper($c)
/**
* Checks if a character is a lower alphabetic one
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is a lower alphabetic one or not
*/
function PMA_STR_isLower($c)
@ -74,7 +74,7 @@ function PMA_STR_isLower($c)
/**
* Checks if a character is a space one
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is a space one or not
*/
function PMA_STR_isSpace($c)
@ -85,7 +85,7 @@ function PMA_STR_isSpace($c)
/**
* Checks if a character is an hexadecimal digit
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is an hexadecimal digit or not
*/
function PMA_STR_isHexDigit($c)

14
libraries/string_type_native.lib.php
View File

@ -18,7 +18,7 @@
/**
* Checks if a character is an alphanumeric one
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is an alphanumeric one or not
*/
function PMA_STR_isAlnum($c)
@ -29,7 +29,7 @@ function PMA_STR_isAlnum($c)
/**
* Checks if a character is an alphabetic one
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is an alphabetic one or not
*/
function PMA_STR_isAlpha($c)
@ -40,7 +40,7 @@ function PMA_STR_isAlpha($c)
/**
* Checks if a character is a digit
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is a digit or not
*/
function PMA_STR_isDigit($c)
@ -55,7 +55,7 @@ function PMA_STR_isDigit($c)
/**
* Checks if a character is an upper alphabetic one
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is an upper alphabetic one or not
*/
function PMA_STR_isUpper($c)
@ -70,7 +70,7 @@ function PMA_STR_isUpper($c)
/**
* Checks if a character is a lower alphabetic one
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is a lower alphabetic one or not
*/
function PMA_STR_isLower($c)
@ -85,7 +85,7 @@ function PMA_STR_isLower($c)
/**
* Checks if a character is a space one
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is a space one or not
*/
function PMA_STR_isSpace($c)
@ -104,7 +104,7 @@ function PMA_STR_isSpace($c)
/**
* Checks if a character is an hexadecimal digit
*
* @param string character to check for
* @param string character to check for
* @return boolean whether the character is an hexadecimal digit or not
*/
function PMA_STR_isHexDigit($c)

22
libraries/transformations.lib.php
View File

@ -19,7 +19,7 @@
* // }
* </code>
*
* @param string $option_string comma separated options
* @param string $option_string comma separated options
* @return array options
*/
function PMA_transformation_getOptions($option_string)
@ -118,9 +118,9 @@ function PMA_getAvailableMIMEtypes()
* Gets the mimetypes for all columns of a table
*
* @access public
* @param string $db the name of the db to check for
* @param string $table the name of the table to check for
* @param string $strict whether to include only results having a mimetype set
* @param string $db the name of the db to check for
* @param string $table the name of the table to check for
* @param string $strict whether to include only results having a mimetype set
* @return array [field_name][field_key] = field_value
*/
function PMA_getMIME($db, $table, $strict = false)
@ -149,13 +149,13 @@ function PMA_getMIME($db, $table, $strict = false)
* Set a single mimetype to a certain value.
*
* @access public
* @param string $db the name of the db
* @param string $table the name of the table
* @param string $key the name of the column
* @param string $mimetype the mimetype of the column
* @param string $transformation the transformation of the column
* @param string $transformation_options the transformation options of the column
* @param string $forcedelete force delete, will erase any existing comments for this column
* @param string $db the name of the db
* @param string $table the name of the table
* @param string $key the name of the column
* @param string $mimetype the mimetype of the column
* @param string $transformation the transformation of the column
* @param string $transformation_options the transformation options of the column
* @param string $forcedelete force delete, will erase any existing comments for this column
* @return boolean true, if comment-query was made.
*/
function PMA_setMIME($db, $table, $key, $mimetype, $transformation,

16
libraries/url_generating.lib.php
View File

@ -10,11 +10,11 @@
* Generates text with hidden inputs.
*
* @see PMA_generate_common_url()
* @param string optional database name
* @param string optional database name
* (can also be an array of parameters)
* @param string optional table name
* @param int indenting level
* @param string do not generate a hidden field for this parameter
* @param string optional table name
* @param int indenting level
* @param string do not generate a hidden field for this parameter
* (can be an array of strings)
*
* @return string string with input fields
@ -160,16 +160,16 @@ function PMA_getHiddenFields($values, $pre = '')
* // script.php?server=1&amp;lang=en
* </code>
*
* @param mixed assoc. array with url params or optional string with database name
* @param mixed assoc. array with url params or optional string with database name
* if first param is an array there is also an ? prefixed to the url
*
* @param string - if first param is array: 'html' to use htmlspecialchars()
* @param string - if first param is array: 'html' to use htmlspecialchars()
* on the resulting URL (for a normal URL displayed in HTML)
* or something else to avoid using htmlspecialchars() (for
* a URL sent via a header); if not set,'html' is assumed
* - if first param is not array: optional table name
*
* @param string - if first param is array: optional character to
* @param string - if first param is array: optional character to
* use instead of '?'
* - if first param is not array: optional character to use
* instead of '&amp;' for dividing URL parameters
@ -256,7 +256,7 @@ function PMA_generate_common_url()
* extracted from arg_separator.input as set in php.ini
* we do not use arg_separator.output to avoid problems with &amp; and &
*
* @param string whether to encode separator or not, currently 'none' or 'html'
* @param string whether to encode separator or not, currently 'none' or 'html'
* @return string character used for separating url parts usally ; or &
* @access public
*/

8
libraries/zip.lib.php
View File

@ -71,7 +71,7 @@ class zipfile
* Converts an Unix timestamp to a four byte DOS date and time format (date
* in high two bytes, time in low two bytes allowing magnitude comparison).
*
* @param integer the current Unix timestamp
* @param integer the current Unix timestamp
*
* @return integer the current date in a four byte DOS format
*
@ -97,9 +97,9 @@ class zipfile
/**
* Adds "file" to archive
*
* @param string file contents
* @param string name of the file in the archive (may contains the path)
* @param integer the current timestamp
* @param string file contents
* @param string name of the file in the archive (may contains the path)
* @param integer the current timestamp
*
* @access public
*/

4
libraries/zip_extension.lib.php
View File

@ -9,7 +9,7 @@
/**
* Gets zip file contents
*
* @param string $file
* @param string $file
* @return array ($error_message, $file_data); $error_message
* is empty if no error
*/
@ -71,7 +71,7 @@ function PMA_getZipContents($file)
/**
* Gets zip error message
*
* @param integer error code
* @param integer error code
* @return string error message
*/
function PMA_getZipError($code)

16
main.php
View File

@ -368,14 +368,14 @@ if (file_exists('./libraries/language_stats.inc.php')) {
/**
* prints list item for main page
*
* @param string $name displayed text
* @param string $id id, used for css styles
* @param string $url make item as link with $url as target
* @param string $mysql_help_page display a link to MySQL's manual
* @param string $target special target for $url
* @param string $a_id id for the anchor, used for jQuery to hook in functions
* @param string $class class for the li element
* @param string $a_class class for the anchor element
* @param string $name displayed text
* @param string $id id, used for css styles
* @param string $url make item as link with $url as target
* @param string $mysql_help_page display a link to MySQL's manual
* @param string $target special target for $url
* @param string $a_id id for the anchor, used for jQuery to hook in functions
* @param string $class class for the li element
* @param string $a_class class for the anchor element
*/
function PMA_printListItem($name, $id = null, $url = null, $mysql_help_page = null, $target = null, $a_id = null, $class = null, $a_class = null)
{

14
navigation.php
View File

@ -327,9 +327,9 @@ if ($GLOBALS['cfg']['LeftFrameLight'] && strlen($GLOBALS['db'])) {
* @global string $href_left
* @global string $db_start
* @global string $common_url_query
* @param array $ext_dblist extended db list
* @param integer $offset
* @param integer $count
* @param array $ext_dblist extended db list
* @param integer $offset
* @param integer $count
*/
function PMA_displayDbList($ext_dblist, $offset, $count) {
global $element_counter, $img_minus, $img_plus, $href_left,
@ -494,10 +494,10 @@ function PMA_displayDbList($ext_dblist, $offset, $count) {
* @global string html code for '-' image
* @global string html code for '+' image
* @global string html code for self link
* @param array $tables array of tables/tablegroups
* @param boolean $visible whether the list is visible or not
* @param string $tab_group_full full tab group name
* @param string $table_db db of this table
* @param array $tables array of tables/tablegroups
* @param boolean $visible whether the list is visible or not
* @param string $tab_group_full full tab group name
* @param string $table_db db of this table
*/
function PMA_displayTableList($tables, $visible = false,
$tab_group_full = '', $table_db = '')

2
pmd_common.php
View File

@ -167,7 +167,7 @@ function get_pk_or_unique_keys()
/**
* returns all indizes
*
* @param boolean whether to include ony unique ones
* @param boolean whether to include ony unique ones
* @return array indizes
*/
function get_all_keys($unique_only = false)

14
server_privileges.php
View File

@ -157,7 +157,7 @@ function PMA_wildcardEscapeForGrant($dbname, $tablename) {
/**
* Generates a condition on the user name
*
* @param string the user's initial
* @param string the user's initial
* @return string the generated condition
*/
function PMA_rangeOfUsers($initial = '')
@ -176,8 +176,8 @@ function PMA_rangeOfUsers($initial = '')
/**
* Extracts the privilege information of a priv table row
*
* @param array $row the row
* @param boolean $enableHTML add <dfn> tag with tooltips
* @param array $row the row
* @param boolean $enableHTML add <dfn> tag with tooltips
*
* @global resource $user_link the database connection
*
@ -404,9 +404,9 @@ function PMA_display_column_privs($columns, $row, $name_for_select,
/**
* Displays the privileges form table
*
* @param string $db the database
* @param string $table the table
* @param boolean $submit wheather to display the submit button or not
* @param string $db the database
* @param string $table the table
* @param boolean $submit wheather to display the submit button or not
* @global array $cfg the phpMyAdmin configuration
* @global ressource $user_link the database connection
*
@ -739,7 +739,7 @@ function PMA_displayPrivTable($db = '*', $table = '*', $submit = true)
* Displays the fields used by the "new user" form as well as the
* "change login information / copy user" form.
*
* @param string $mode are we creating a new user or are we just
* @param string $mode are we creating a new user or are we just
* changing one? (allowed values: 'new', 'change')
* @global array $cfg the phpMyAdmin configuration
* @global ressource $user_link the database connection

8
tbl_relation.php
View File

@ -48,9 +48,9 @@ $options_array = array(
/**
* Generate dropdown choices
*
* @param string Message to display
* @param string Name of the <select> field
* @param array Choices for dropdown
* @param string Message to display
* @param string Name of the <select> field
* @param array Choices for dropdown
* @return string The existing value (for selected)
*
* @access public
@ -74,7 +74,7 @@ function PMA_generate_dropdown($dropdown_question, $select_name, $choices, $sele
/**
* Split a string on backquote pairs
*
* @param string original string
* @param string original string
* @return array containing the elements (and their surrounding backquotes)
*
* @access public

8
tbl_tracking.php
View File

@ -52,10 +52,10 @@ if (isset($_REQUEST['report_export'])) {
/**
* Filters tracking entries
*
* @param array the entries to filter
* @param string "from" date
* @param string "to" date
* @param string users
* @param array the entries to filter
* @param string "from" date
* @param string "to" date
* @param string users
*
* @return array filtered entries
*