[Phpmyadmin-git] [SCM] phpMyAdmin branch, master, updated. RELEASE_3_4_3_1-11183-g06655a8
The branch, master has been updated via 06655a8a96a98de1c8ce4b136a10e7c4b285f398 (commit) from dd641ef16437e9c3c232889fd2181833ef8a4e2c (commit)
- Log ----------------------------------------------------------------- commit 06655a8a96a98de1c8ce4b136a10e7c4b285f398 Author: Michal Čihař mcihar@suse.cz Date: Thu Jul 21 14:58:47 2011 +0200
Document that functions do not return anything
-----------------------------------------------------------------------
Summary of changes: libraries/server_synchronize.lib.php | 22 +++++++++++++++++++++- 1 files changed, 21 insertions(+), 1 deletions(-)
diff --git a/libraries/server_synchronize.lib.php b/libraries/server_synchronize.lib.php index 3b929d3..c32ac4d 100644 --- a/libraries/server_synchronize.lib.php +++ b/libraries/server_synchronize.lib.php @@ -19,6 +19,7 @@ * @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) { @@ -45,6 +46,7 @@ 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) { @@ -85,6 +87,7 @@ function PMA_getNonMatchingTargetTables($trg_tables, $matching_tables, &$uncommo * contain number of fields for each matching table * @param array $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, &$delete_array, &$fields_num, $matching_table_index, &$matching_tables_keys) @@ -302,6 +305,7 @@ function PMA_dataDiffInTables($src_db, $trg_db, $src_link, $trg_link, &$matching * @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) { @@ -373,6 +377,7 @@ function PMA_findDeleteRowsFromTargetTables(&$delete_array, $matching_table, $ma * @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) { @@ -394,6 +399,7 @@ function PMA_dataDiffInUncommonTables($source_tables_uncommon, $src_db, $src_lin * @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) { @@ -465,6 +471,7 @@ function PMA_updateTargetTables($table, $update_array, $src_db, $trg_db, $trg_li * @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, $matching_tables_keys, $source_columns, &$add_column_array, $criteria, $target_tables_keys, $uncommon_tables, &$uncommon_tables_fields,$uncommon_cols, @@ -588,6 +595,7 @@ function PMA_insertIntoTargetTable($matching_table, $src_db, $trg_db, $src_link, * @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) { @@ -641,7 +649,9 @@ function PMA_createTargetTables($src_db, $trg_db, $src_link, $trg_link, &$uncomm * @param $uncommon_tables_fields field names of the uncommon table * @param $display true/false value * - * FIXME: This turns NULL values into '' (empty string) + * @return nothing + * + * @todo This turns NULL values into '' (empty string) */ function PMA_populateTargetTables($src_db, $trg_db, $src_link, $trg_link, $uncommon_tables, $table_index, $uncommon_tables_fields, $display) { @@ -679,6 +689,7 @@ function PMA_populateTargetTables($src_db, $trg_db, $src_link, $trg_link, $uncom * @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) { @@ -743,6 +754,7 @@ function PMA_deleteFromTargetTable($trg_db, $trg_link, $matching_tables, $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, &$add_column_array, &$uncommon_columns, $criteria, &$target_tables_keys, $matching_table_index) @@ -806,6 +818,7 @@ function PMA_structureDiffInTables($src_db, $trg_db, $src_link, $trg_link, $matc * @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, $criteria, $matching_tables_keys, $target_tables_keys, $uncommon_tables, &$uncommon_tables_fields, $table_counter, $uncommon_cols, $display) @@ -896,6 +909,7 @@ function PMA_addColumnsInTargetTable($src_db, $trg_db, $src_link, $trg_link, $ma * @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) { @@ -929,6 +943,7 @@ function PMA_checkForeignKeys($src_db, $src_link, $trg_db, $trg_link ,$reference * @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, &$matching_tables_keys, &$target_tables_keys, $matching_table_index, $display) @@ -1058,6 +1073,7 @@ function PMA_alterTargetTableStructure($trg_db, $trg_link, $matching_tables, &$s * @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) { @@ -1118,6 +1134,7 @@ function PMA_removeColumnsFromTargetTable($trg_db, $trg_link, $matching_tables, * @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, &$alter_indexes_array, &$remove_indexes_array, $table_counter) @@ -1181,6 +1198,7 @@ function PMA_indexesDiffInTables($src_db, $trg_db, $src_link, $trg_link, $matchi * @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, $remove_indexes_array, $table_counter, $display) @@ -1259,6 +1277,7 @@ function PMA_applyIndexesDiff ($trg_db, $trg_link, $matching_tables, $source_ind * into account * * @param $query the query to display + * @return nothing */ function PMA_displayQuery($query) { if (strlen($query) > $GLOBALS['cfg']['MaxCharactersInDisplayedSQL']) { @@ -1271,6 +1290,7 @@ function PMA_displayQuery($query) { * PMA_syncDisplayHeaderSource() shows the header for source database * * @param string $src_db source db name + * @return nothing */ function PMA_syncDisplayHeaderSource($src_db) { echo '<div id="serverstatus" style = "overflow: auto; width: 1020px; height: 220px; border-left: 1px gray solid; border-bottom: 1px gray solid; padding:0; margin-bottom: 1em "> ';
hooks/post-receive
-
Michal Čihař