[Phpmyadmin-git] [SCM] phpMyAdmin branch, master, updated. RELEASE_3_4_3_1-13253-g5237533
Michal Čihař
nijel at users.sourceforge.net
Fri Aug 5 15:21:35 CEST 2011
The branch, master has been updated
via 52375334c394f8bbde24d2545ef8b78f5bac42b0 (commit)
via 5c0ec4b9f30d60a7a0aca94c61085a02320ea5f2 (commit)
via be0989e94443224d90b7c1ae1c655020cebd42a0 (commit)
via 024e164f0255333bd5b2b47849796de44d4b37af (commit)
via b6c6e79dc281e8d96db285086cbc3105bceed8df (commit)
from 64c30e51e7c2ac2dc2041510a1c65d923c3d08e1 (commit)
- Log -----------------------------------------------------------------
commit 52375334c394f8bbde24d2545ef8b78f5bac42b0
Author: Michal Čihař <mcihar at suse.cz>
Date: Fri Aug 5 15:21:24 2011 +0200
Add some docblocks
commit 5c0ec4b9f30d60a7a0aca94c61085a02320ea5f2
Author: Michal Čihař <mcihar at suse.cz>
Date: Fri Aug 5 15:17:15 2011 +0200
Reformat docblocks
commit be0989e94443224d90b7c1ae1c655020cebd42a0
Author: Michal Čihař <mcihar at suse.cz>
Date: Fri Aug 5 15:15:11 2011 +0200
Reformat docblock
commit 024e164f0255333bd5b2b47849796de44d4b37af
Author: Michal Čihař <mcihar at suse.cz>
Date: Fri Aug 5 15:14:39 2011 +0200
Add doc
commit b6c6e79dc281e8d96db285086cbc3105bceed8df
Author: Michal Čihař <mcihar at suse.cz>
Date: Fri Aug 5 15:13:40 2011 +0200
Reformat docblock
-----------------------------------------------------------------------
Summary of changes:
libraries/common.lib.php | 16 ++++----
libraries/database_interface.lib.php | 8 ++--
libraries/display_tbl.lib.php | 60 +++++++++++++++++-----------------
libraries/replication.inc.php | 49 ++++++++++++++-------------
libraries/replication_gui.lib.php | 6 ++--
5 files changed, 70 insertions(+), 69 deletions(-)
diff --git a/libraries/common.lib.php b/libraries/common.lib.php
index cc89c85..353e775 100644
--- a/libraries/common.lib.php
+++ b/libraries/common.lib.php
@@ -2278,9 +2278,9 @@ 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 $label label for checkbox
+ * @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)
{
@@ -2292,11 +2292,11 @@ 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 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='')
{
diff --git a/libraries/database_interface.lib.php b/libraries/database_interface.lib.php
index 6514393..8877dad 100644
--- a/libraries/database_interface.lib.php
+++ b/libraries/database_interface.lib.php
@@ -70,10 +70,10 @@ require_once './libraries/dbi/' . $GLOBALS['cfg']['Server']['extension'] . '.dbi
/**
* runs a query
*
- * @param string $query
- * @param mixed $link
- * @param int $options
- * @param bool $cache_affected_rows
+ * @param string $query SQL query to execte
+ * @param mixed $link optional database link to use
+ * @param int $options optional query options
+ * @param bool $cache_affected_rows whether to cache affected rows
* @return mixed
*/
function PMA_DBI_query($query, $link = null, $options = 0, $cache_affected_rows = true)
diff --git a/libraries/display_tbl.lib.php b/libraries/display_tbl.lib.php
index 454f888..a524767 100644
--- a/libraries/display_tbl.lib.php
+++ b/libraries/display_tbl.lib.php
@@ -1069,9 +1069,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 class of table cell
+ * @param bool $condition_field whether to add CSS class condition
+ * @param string $value value to display
*
* @return string the td
*/
@@ -1083,8 +1083,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 class of table cell
+ * @param bool $condition_field whether to add CSS class condition
*
* @return string the td
*/
@@ -1097,9 +1097,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 class of table cell
+ * @param bool $condition_field whether to add CSS class condition
+ * @param string $align cell allignment
*
* @return string the td
*/
@@ -1112,13 +1112,13 @@ function PMA_buildEmptyDisplay($class, $condition_field, $meta, $align = '')
/**
* Adds the relavant classes.
*
- * @param string $class
- * @param string $condition_field
- * @param object $meta the meta-information about this field
- * @param string $nowrap
- * @param bool $is_field_truncated
- * @param string $transform_function
- * @param string $default_function
+ * @param string $class class of table cell
+ * @param bool $condition_field whether to add CSS class condition
+ * @param object $meta the meta-information about this field
+ * @param string $nowrap avoid wrapping
+ * @param bool $is_field_truncated is field truncated (display ...)
+ * @param string $transform_function transformation function
+ * @param string $default_function default transformation function
*
* @return string the list of classes
*/
@@ -1155,27 +1155,27 @@ 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
- * to be displayed
- * @param array which elements to display
- * @param array the list of relations
- * @param array the analyzed query
+ * @param integer &$dt_result the link id associated to the query which results have
+ * to be displayed
+ * @param array &$is_display which elements to display
+ * @param array $map the list of relations
+ * @param array $analyzed_sql the analyzed query
*
* @return boolean always true
*
- * @global string $db the database name
- * @global string $table the table name
- * @global string $goto the URL to go back in case of errors
- * @global string $sql_query the SQL query
- * @global array $fields_meta the list of fields properties
- * @global integer $fields_cnt the total number of fields returned by
+ * @global string $db the database name
+ * @global string $table the table name
+ * @global string $goto the URL to go back in case of errors
+ * @global string $sql_query the SQL query
+ * @global array $fields_meta the list of fields properties
+ * @global integer $fields_cnt the total number of fields returned by
* the SQL query
- * @global array $vertical_display informations used with vertical display
+ * @global array $vertical_display informations used with vertical display
* mode
- * @global array $highlight_columns column names to highlight
- * @global array $row current row data
+ * @global array $highlight_columns column names to highlight
+ * @global array $row current row data
*
- * @access private
+ * @access private
*
* @see PMA_displayTable()
*/
diff --git a/libraries/replication.inc.php b/libraries/replication.inc.php
index 7327075..a6b5d99 100644
--- a/libraries/replication.inc.php
+++ b/libraries/replication.inc.php
@@ -150,9 +150,9 @@ function PMA_extract_db_or_table($string, $what = 'db')
}
}
/**
- * @param String $action - possible values: START or STOP
- * @param String $control - default: null, possible values: SQL_THREAD or IO_THREAD or null. If it is set to null, it controls both SQL_THREAD and IO_THREAD
- * @param mixed $link - mysql link
+ * @param string $action possible values: START or STOP
+ * @param string $control default: null, possible values: SQL_THREAD or IO_THREAD or null. If it is set to null, it controls both SQL_THREAD and IO_THREAD
+ * @param mixed $link mysql link
*
* @return mixed output of PMA_DBI_try_query
*/
@@ -171,14 +171,14 @@ function PMA_replication_slave_control($action, $control = null, $link = null)
return PMA_DBI_try_query($action . " SLAVE " . $control . ";", $link);
}
/**
- * @param String $user - replication user on master
- * @param String $password - password for the user
- * @param String $host - master's hostname or IP
- * @param int $port - port, where mysql is running
- * @param array $pos - position of mysql replication, array should contain fields File and Position
- * @param boolean $stop - shall we stop slave?
- * @param boolean $start - shall we start slave?
- * @param mixed $link - mysql link
+ * @param string $user replication user on master
+ * @param string $password password for the user
+ * @param string $host master's hostname or IP
+ * @param int $port port, where mysql is running
+ * @param array $pos position of mysql replication, array should contain fields File and Position
+ * @param bool $stop shall we stop slave?
+ * @param bool $start shall we start slave?
+ * @param mixed $link mysql link
*
* @return output of CHANGE MASTER mysql command
*/
@@ -206,11 +206,11 @@ function PMA_replication_slave_change_master($user, $password, $host, $port, $po
/**
* This function provides connection to remote mysql server
*
- * @param String $user - mysql username
- * @param String $password - password for the user
- * @param String $host - mysql server's hostname or IP
- * @param int $port - mysql remote port
- * @param String $socket - path to unix socket
+ * @param string $user mysql username
+ * @param string $password password for the user
+ * @param string $host mysql server's hostname or IP
+ * @param int $port mysql remote port
+ * @param string $socket path to unix socket
*
* @return mixed $link mysql link on success
*/
@@ -226,7 +226,7 @@ function PMA_replication_connect_to_master($user, $password, $host = null, $port
return PMA_DBI_connect($user, $password, false, $server, true);
}
/**
- * @param $link - mysql link
+ * @param mixed $link mysql link
*
* @return array - containing File and Position in MySQL replication on master server, useful for PMA_replication_slave_change_master
*/
@@ -245,7 +245,7 @@ function PMA_replication_slave_bin_log_master($link = null)
/**
* Get list of replicated databases on master server
*
- * @param mixed mysql link
+ * @param mixed $link mysql link
*
* @return array array of replicated databases
*/
@@ -285,12 +285,13 @@ function PMA_replication_master_replicated_dbs($link = null)
}
/**
* This function provides synchronization of structure and data between two mysql servers.
- * TODO: improve code sharing between the function and synchronization
*
- * @param String $db - name of database, which should be synchronized
- * @param mixed $src_link - link of source server, note: if the server is current PMA server, use null
- * @param mixed $trg_link - link of target server, note: if the server is current PMA server, use null
- * @param boolean $data - if true, then data will be copied as well
+ * @todo improve code sharing between the function and synchronization
+ *
+ * @param string $db name of database, which should be synchronized
+ * @param mixed $src_link link of source server, note: if the server is current PMA server, use null
+ * @param mixed $trg_link link of target server, note: if the server is current PMA server, use null
+ * @param bool $data if true, then data will be copied as well
*/
function PMA_replication_synchronize_db($db, $src_link, $trg_link, $data = true)
@@ -357,7 +358,7 @@ function PMA_replication_synchronize_db($db, $src_link, $trg_link, $data = true)
* INTEGRATION OF STRUCTURE DIFFERENCE CODE
*
*/
- $source_columns = array();
+ $source_columns = array();test/libraries/common/PMA_contains_nonprintable_ascii_test.php:
$target_columns = array();
$alter_str_array = array(array());
$add_column_array = array(array());
diff --git a/libraries/replication_gui.lib.php b/libraries/replication_gui.lib.php
index 91b284f..2f57b2b 100644
--- a/libraries/replication_gui.lib.php
+++ b/libraries/replication_gui.lib.php
@@ -81,9 +81,9 @@ function PMA_replication_gui_changemaster($submitname)
/**
* This function prints out table with replication status.
*
- * @param String type - either master or slave
- * @param boolean $hidden - if true, then default style is set to hidden, default value false
- * @param boolen $title - if true, then title is displayed, default true
+ * @param string $type either master or slave
+ * @param boolean $hidden if true, then default style is set to hidden, default value false
+ * @param boolen $title if true, then title is displayed, default true
*/
function PMA_replication_print_status_table($type, $hidden = false, $title = true)
{
hooks/post-receive
--
phpMyAdmin
More information about the Git
mailing list