From 2260f89ecc4151523d029a74a55c334fd7858464 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Tue, 29 May 2012 16:16:25 +0200 Subject: [PATCH 1/4] Document no return values --- libraries/server_synchronize.lib.php | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/libraries/server_synchronize.lib.php b/libraries/server_synchronize.lib.php index 3ae10819bb..933113e625 100644 --- a/libraries/server_synchronize.lib.php +++ b/libraries/server_synchronize.lib.php @@ -22,6 +22,8 @@ if (! defined('PHPMYADMIN')) { * @param array &$uncommon_source_tables empty array passed by reference to save * names of tables present in source database * but absent from target database + * + * @return nothing */ function PMA_getMatchingTables($trg_tables, $src_tables, &$matching_tables, &$uncommon_source_tables) { @@ -48,6 +50,8 @@ function PMA_getMatchingTables($trg_tables, $src_tables, &$matching_tables, &$un * @param array &$uncommon_target_tables empty array passed by reference to save * names of tables presnet in target database * but absent from source database + * + * @return nothing */ function PMA_getNonMatchingTargetTables($trg_tables, $matching_tables, &$uncommon_target_tables) { @@ -89,6 +93,8 @@ function PMA_getNonMatchingTargetTables($trg_tables, $matching_tables, &$uncommo * contain number of fields for each matching table * @param int $matching_table_index Index of a table from $matching_table array * @param array &$matching_tables_keys A two dimensional array passed by reference to contain names of keys for each matching table + * + * @return nothing */ function PMA_dataDiffInTables($src_db, $trg_db, $src_link, $trg_link, &$matching_table, &$matching_tables_fields, &$update_array, &$insert_array, @@ -313,6 +319,8 @@ function PMA_dataDiffInTables($src_db, $trg_db, $src_link, $trg_link, * @param db_link $trg_link connection established with target server * @param string $src_db name of source database * @param db_link $src_link connection established with source server + * + * @return nothing */ function PMA_findDeleteRowsFromTargetTables(&$delete_array, $matching_table, $matching_table_index, $trg_keys, $src_keys, $trg_db, $trg_link, $src_db, $src_link @@ -406,6 +414,8 @@ function PMA_dataDiffInUncommonTables($source_tables_uncommon, $src_db, $src_lin * @param int $matching_table_index index of matching table in matching_table_array * @param array $matching_table_keys * @param boolean $display + * + * @return nothing */ function PMA_updateTargetTables( $table, $update_array, $src_db, $trg_db, @@ -482,6 +492,8 @@ function PMA_updateTargetTables( * @param array &$delete_array rows that are to be deleted * @param array &$update_array rows that are to be updated in target * @param bool $display + * + * @return nothing */ function PMA_insertIntoTargetTable($matching_table, $src_db, $trg_db, $src_link, $trg_link, $table_fields, &$array_insert, $matching_table_index, @@ -620,6 +632,8 @@ function PMA_insertIntoTargetTable($matching_table, $src_db, $trg_db, $src_link, * @param int $table_index index of table in $uncommon_tables array * @param array &$uncommon_tables_fields field names of the uncommon table * @param bool $display + * + * @return nothing */ function PMA_createTargetTables($src_db, $trg_db, $src_link, $trg_link, &$uncommon_tables, $table_index, &$uncommon_tables_fields, $display @@ -675,6 +689,8 @@ function PMA_createTargetTables($src_db, $trg_db, $src_link, $trg_link, * @param array $uncommon_tables_fields field names of the uncommon table * @param bool $display * + * @return nothing + * * @todo This turns NULL values into '' (empty string) */ function PMA_populateTargetTables($src_db, $trg_db, $src_link, $trg_link, @@ -974,6 +990,8 @@ function PMA_checkForeignKeys($src_db, $src_link, $trg_db, $trg_link, * @param array &$target_tables_keys field names which is key in the target table * @param int $matching_table_index number of the matching table * @param bool $display + * + * @return nothing */ function PMA_alterTargetTableStructure($trg_db, $trg_link, $matching_tables, &$source_columns, &$alter_str_array, $matching_tables_fields, $criteria, @@ -1105,6 +1123,8 @@ function PMA_alterTargetTableStructure($trg_db, $trg_link, $matching_tables, * @param array $uncommon_columns array containing the names of the column which are to be dropped from the target table * @param int $table_counter index of the matching table as in $matchiing_tables array * @param bool $display + * + * @return nothing */ function PMA_removeColumnsFromTargetTable($trg_db, $trg_link, $matching_tables, $uncommon_columns, $table_counter, $display @@ -1168,6 +1188,8 @@ function PMA_removeColumnsFromTargetTable($trg_db, $trg_link, $matching_tables, * @param array &$remove_indexes_array key name of the index which is to be * removed from the target table * @param int $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, @@ -1230,6 +1252,8 @@ function PMA_indexesDiffInTables($src_db, $trg_db, $src_link, $trg_link, * @param array $remove_indexes_array key name of the indexes which are to be removed from the target table * @param int $table_counter number of the matching table * @param $display + * + * @return nothing */ function PMA_applyIndexesDiff($trg_db, $trg_link, $matching_tables, $source_indexes, $target_indexes, $add_indexes_array, $alter_indexes_array, @@ -1364,6 +1388,8 @@ function PMA_syncDisplayHeaderCompare($src_db, $trg_db) * i, update_size, insert_size, remove_size, insert_index, remove_index * * @param array $rows + * + * @return nothing */ function PMA_syncDisplayDataCompare($rows) { From 186515ed8e4383cd5d9904fa416e181d9b0201d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Tue, 29 May 2012 16:16:59 +0200 Subject: [PATCH 2/4] Saner function name --- libraries/server_synchronize.lib.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/libraries/server_synchronize.lib.php b/libraries/server_synchronize.lib.php index 933113e625..69b2c50cf2 100644 --- a/libraries/server_synchronize.lib.php +++ b/libraries/server_synchronize.lib.php @@ -119,7 +119,7 @@ function PMA_dataDiffInTables($src_db, $trg_db, $src_link, $trg_link, $fields_num[$matching_table_index] = sizeof($fld); $matching_tables_keys[$matching_table_index] = $is_key; - $source_result_set = PMA_get_column_values( + $source_result_set = PMA_getColumnValues( $src_db, $matching_table[$matching_table_index], $is_key, $src_link ); $source_size = sizeof($source_result_set); @@ -326,10 +326,10 @@ function PMA_findDeleteRowsFromTargetTables(&$delete_array, $matching_table, $matching_table_index, $trg_keys, $src_keys, $trg_db, $trg_link, $src_db, $src_link ) { if (isset($trg_keys[$matching_table_index])) { - $target_key_values = PMA_get_column_values($trg_db, $matching_table[$matching_table_index], $trg_keys[$matching_table_index], $trg_link); + $target_key_values = PMA_getColumnValues($trg_db, $matching_table[$matching_table_index], $trg_keys[$matching_table_index], $trg_link); } if (isset($src_keys[$matching_table_index])) { - $source_key_values = PMA_get_column_values($src_db, $matching_table[$matching_table_index], $src_keys[$matching_table_index], $src_link); + $source_key_values = PMA_getColumnValues($src_db, $matching_table[$matching_table_index], $src_keys[$matching_table_index], $src_link); } $all_keys_match = 1; for ($a = 0; $a < sizeof($trg_keys[$matching_table_index]); $a++) { @@ -1423,7 +1423,7 @@ function PMA_syncDisplayDataCompare($rows) } /** - * array PMA_get_column_values (string $database, string $table, string $column , mysql db link $link = null) + * array PMA_getColumnValues (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 @@ -1432,7 +1432,7 @@ function PMA_syncDisplayDataCompare($rows) * * @return array $field_values */ -function PMA_get_column_values($database, $table, $column, $link = null) +function PMA_getColumnValues($database, $table, $column, $link = null) { $query = 'SELECT '; for ($i=0; $i< sizeof($column); $i++) { From 3dc6c9396772bc552619277c73d2c6ed8c76a3ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Tue, 29 May 2012 16:19:49 +0200 Subject: [PATCH 3/4] Document $display parameter --- libraries/server_synchronize.lib.php | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/libraries/server_synchronize.lib.php b/libraries/server_synchronize.lib.php index 69b2c50cf2..0f02f108d2 100644 --- a/libraries/server_synchronize.lib.php +++ b/libraries/server_synchronize.lib.php @@ -413,7 +413,7 @@ function PMA_dataDiffInUncommonTables($source_tables_uncommon, $src_db, $src_lin * @param mixed $trg_link Connection established with target server * @param int $matching_table_index index of matching table in matching_table_array * @param array $matching_table_keys - * @param boolean $display + * @param bool $display whether to display query * * @return nothing */ @@ -491,7 +491,7 @@ function PMA_updateTargetTables( * @param array &$alter_indexes_array column names whose indexes are to be altered. Only index name and uniqueness of an index can be changed * @param array &$delete_array rows that are to be deleted * @param array &$update_array rows that are to be updated in target - * @param bool $display + * @param bool $display whether to display query * * @return nothing */ @@ -631,7 +631,7 @@ function PMA_insertIntoTargetTable($matching_table, $src_db, $trg_db, $src_link, * @param array &$uncommon_tables names of tables present in source but not in target * @param int $table_index index of table in $uncommon_tables array * @param array &$uncommon_tables_fields field names of the uncommon table - * @param bool $display + * @param bool $display whether to display query * * @return nothing */ @@ -687,7 +687,7 @@ function PMA_createTargetTables($src_db, $trg_db, $src_link, $trg_link, * @param array $uncommon_tables uncommon table names (table names that are present in source but not in target db) * @param int $table_index index of table in matching_table_array * @param array $uncommon_tables_fields field names of the uncommon table - * @param bool $display + * @param bool $display whether to display query * * @return nothing * @@ -729,7 +729,9 @@ function PMA_populateTargetTables($src_db, $trg_db, $src_link, $trg_link, * @param int $table_index index of table in matching_table_array * @param array $target_tables_keys primary key names of the target tables * @param array $delete_array key values of rows that are to be deleted - * @param bool $display + * @param bool $display whether to display query + * + * @return nothing */ function PMA_deleteFromTargetTable($trg_db, $trg_link, $matching_tables, $table_index, $target_tables_keys, $delete_array, $display @@ -860,7 +862,9 @@ function PMA_structureDiffInTables($src_db, $trg_db, $src_link, $trg_link, * @param array &$uncommon_tables_fields names of the fields of the uncommon tables * @param int $table_counter number of the matching table * @param array $uncommon_cols - * @param bool $display + * @param bool $display whether to display query + * + * @return nothing */ function PMA_addColumnsInTargetTable($src_db, $trg_db, $src_link, $trg_link, $matching_tables, $source_columns, &$add_column_array, $matching_tables_fields, @@ -952,7 +956,9 @@ function PMA_addColumnsInTargetTable($src_db, $trg_db, $src_link, $trg_link, * @param string $referenced_table table whose column is a foreign key in another table * @param array &$uncommon_tables names that are uncommon * @param array &$uncommon_tables_fields field names of the uncommon table - * @param bool $display + * @param bool $display whether to display query + * + * @return nothing */ function PMA_checkForeignKeys($src_db, $src_link, $trg_db, $trg_link, $referenced_table, &$uncommon_tables, &$uncommon_tables_fields, $display @@ -989,7 +995,7 @@ function PMA_checkForeignKeys($src_db, $src_link, $trg_db, $trg_link, * @param array &$matching_tables_keys field names which is key in the source table * @param array &$target_tables_keys field names which is key in the target table * @param int $matching_table_index number of the matching table - * @param bool $display + * @param bool $display whether to display query * * @return nothing */ @@ -1122,7 +1128,7 @@ function PMA_alterTargetTableStructure($trg_db, $trg_link, $matching_tables, * @param array $matching_tables names of matching tables * @param array $uncommon_columns array containing the names of the column which are to be dropped from the target table * @param int $table_counter index of the matching table as in $matchiing_tables array - * @param bool $display + * @param bool $display whether to display query * * @return nothing */ @@ -1251,7 +1257,7 @@ function PMA_indexesDiffInTables($src_db, $trg_db, $src_link, $trg_link, * @param array $alter_indexes_array column names for which indexes are to be altered * @param array $remove_indexes_array key name of the indexes which are to be removed from the target table * @param int $table_counter number of the matching table - * @param $display + * @param bool $display whether to display query * * @return nothing */ From 73e56724dade3975ca7cf045758f8a4daba6bc6b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Tue, 29 May 2012 16:29:25 +0200 Subject: [PATCH 4/4] Wrap some long lines --- libraries/server_synchronize.lib.php | 146 +++++++++++++++++---------- 1 file changed, 92 insertions(+), 54 deletions(-) diff --git a/libraries/server_synchronize.lib.php b/libraries/server_synchronize.lib.php index 0f02f108d2..1d17fbad41 100644 --- a/libraries/server_synchronize.lib.php +++ b/libraries/server_synchronize.lib.php @@ -25,8 +25,8 @@ if (! defined('PHPMYADMIN')) { * * @return nothing */ -function PMA_getMatchingTables($trg_tables, $src_tables, &$matching_tables, &$uncommon_source_tables) -{ +function PMA_getMatchingTables($trg_tables, $src_tables, &$matching_tables, +&$uncommon_source_tables) { for ($k=0; $k< sizeof($src_tables); $k++) { $present_in_target = false; for ($l=0; $l < sizeof($trg_tables); $l++) { @@ -53,8 +53,8 @@ function PMA_getMatchingTables($trg_tables, $src_tables, &$matching_tables, &$un * * @return nothing */ -function PMA_getNonMatchingTargetTables($trg_tables, $matching_tables, &$uncommon_target_tables) -{ +function PMA_getNonMatchingTargetTables($trg_tables, $matching_tables, +&$uncommon_target_tables) { for ($c=0; $c