From 9fba69e73ae53b4f4da8ebb37cfcfb158842c101 Mon Sep 17 00:00:00 2001
From: Chanaka Indrajith <pe.chanaka.ck@gmail.com>
Date: Thu, 14 Jun 2012 09:02:28 +0530
Subject: [PATCH] Modifications to PMA_listNavigator() function in
 common.lib.php and renamed as PMA_getListNavigator()

---
 db_structure.php         |  4 +--
 libraries/common.lib.php | 53 ++++++++++++++++++++++++++--------------
 navigation.php           |  8 +++---
 server_databases.php     |  2 +-
 4 files changed, 42 insertions(+), 25 deletions(-)

diff --git a/db_structure.php b/db_structure.php
index d711e0e75a..9424391ee0 100644
--- a/db_structure.php
+++ b/db_structure.php
@@ -112,7 +112,7 @@ if (isset($_REQUEST['sort_order'])) {
     $_url_params['sort_order'] = $_REQUEST['sort_order'];
 }
 
-PMA_listNavigator(
+echo PMA_getListNavigator(
     $total_num_tables, $pos, $_url_params, 'db_structure.php',
     'frame_content', $GLOBALS['cfg']['MaxTableList']
 );
@@ -727,7 +727,7 @@ if (!$db_is_information_schema && !$cfg['DisableMultiTableMaintenance']) {
 </form>
 <?php
 // display again the table list navigator
-PMA_listNavigator(
+echo PMA_getListNavigator(
     $total_num_tables, $pos, $_url_params, 'db_structure.php',
     'frame_content', $GLOBALS['cfg']['MaxTableList']
 );
diff --git a/libraries/common.lib.php b/libraries/common.lib.php
index 8ddc392011..5fbceb25cc 100644
--- a/libraries/common.lib.php
+++ b/libraries/common.lib.php
@@ -2424,7 +2424,7 @@ function PMA_pageselector($rows, $pageNow = 1, $nbTotalPage = 1,
 
 
 /**
- * Generate navigation for a list
+ * Prepare navigation for a list
  *
  * @param int    $count       number of elements in the list
  * @param int    $pos         current position in the list
@@ -2433,24 +2433,30 @@ function PMA_pageselector($rows, $pageNow = 1, $nbTotalPage = 1,
  * @param string $frame       target frame
  * @param int    $max_count   maximum number of elements to display from the list
  *
- * @return void
+ * @return string $list_navigator_html the  html content
  *
  * @access  public
  *
  * @todo    use $pos from $_url_params
  */
-function PMA_listNavigator($count, $pos, $_url_params, $script, $frame, $max_count)
+function PMA_getListNavigator($count, $pos, $_url_params, $script, $frame, $max_count)
 {
+    
+    $list_navigator_html = '';
 
     if ($max_count < $count) {
-        echo 'frame_navigation' == $frame
+        
+        $list_navigator_html .= ($frame == 'frame_navigation')
             ? '<div id="navidbpageselector">' . "\n"
             : '';
-        echo __('Page number:');
-        echo 'frame_navigation' == $frame ? '<br />' : ' ';
+        
+        $list_navigator_html .= __('Page number:');
+        
+        $list_navigator_html .= ($frame == 'frame_navigation') ? '<br />' : ' ';
 
         // Move to the beginning or to the previous page
         if ($pos > 0) {
+            
             // patch #474210 - part 1
             if ($GLOBALS['cfg']['NavigationBarIconic']) {
                 $caption1 = '&lt;&lt;';
@@ -2464,27 +2470,31 @@ function PMA_listNavigator($count, $pos, $_url_params, $script, $frame, $max_cou
                 $title1   = '';
                 $title2   = '';
             } // end if... else...
+            
             $_url_params['pos'] = 0;
-            echo '<a' . $title1 . ' href="' . $script
+            $list_navigator_html .= '<a' . $title1 . ' href="' . $script
                 . PMA_generate_common_url($_url_params) . '" target="'
                 . $frame . '">' . $caption1 . '</a>';
-            $_url_params['pos'] = $pos - $max_count;
-            echo '<a' . $title2 . ' href="' . $script
+            
+            $_url_params['pos'] = $pos - $max_count;            
+            $list_navigator_html .= '<a' . $title2 . ' href="' . $script
                 . PMA_generate_common_url($_url_params) . '" target="'
                 . $frame . '">' . $caption2 . '</a>';
         }
 
-        echo "\n", '<form action="', basename($script),
-            '" method="post" target="', $frame, '">', "\n";
-        echo PMA_generate_common_hidden_inputs($_url_params);
-        echo PMA_pageselector(
+        $list_navigator_html .= "\n" . '<form action="' . basename($script).
+            '" method="post" target="' . $frame . '">' . "\n";
+        
+        $list_navigator_html .= PMA_generate_common_hidden_inputs($_url_params);
+        $list_navigator_html .= PMA_pageselector(
             $max_count,
             floor(($pos + 1) / $max_count) + 1,
             ceil($count / $max_count)
         );
-        echo '</form>';
+        $list_navigator_html .= '</form>';
 
         if ($pos + $max_count < $count) {
+            
             if ($GLOBALS['cfg']['NavigationBarIconic']) {
                 $caption3 = ' &gt; ';
                 $caption4 = '&gt;&gt;';
@@ -2496,23 +2506,30 @@ function PMA_listNavigator($count, $pos, $_url_params, $script, $frame, $max_cou
                 $title3   = '';
                 $title4   = '';
             } // end if... else...
+            
             $_url_params['pos'] = $pos + $max_count;
-            echo '<a' . $title3 . ' href="' . $script
+            $list_navigator_html .= '<a' . $title3 . ' href="' . $script
                 . PMA_generate_common_url($_url_params) . '" target="'
                 . $frame . '">' . $caption3 . '</a>';
+            
             $_url_params['pos'] = floor($count / $max_count) * $max_count;
             if ($_url_params['pos'] == $count) {
                 $_url_params['pos'] = $count - $max_count;
             }
-            echo '<a' . $title4 . ' href="' . $script
+            
+            $list_navigator_html .= '<a' . $title4 . ' href="' . $script
                 . PMA_generate_common_url($_url_params) . '" target="'
                 . $frame . '">' . $caption4 . '</a>';
         }
-        echo "\n";
+        
+        $list_navigator_html .= "\n";
         if ('frame_navigation' == $frame) {
-            echo '</div>' . "\n";
+            $list_navigator_html .= '</div>' . "\n";
         }
     }
+    
+    return $list_navigator_html;
+    
 }
 
 /**
diff --git a/navigation.php b/navigation.php
index 17d649b6da..cb5901947c 100644
--- a/navigation.php
+++ b/navigation.php
@@ -176,7 +176,7 @@ if (! $GLOBALS['server']) {
     }
 
     $_url_params = array('pos' => $pos);
-    PMA_listNavigator(count($GLOBALS['pma']->databases), $pos, $_url_params, 'navigation.php', 'frame_navigation', $GLOBALS['cfg']['MaxDbList']);
+    echo PMA_getListNavigator(count($GLOBALS['pma']->databases), $pos, $_url_params, 'navigation.php', 'frame_navigation', $GLOBALS['cfg']['MaxDbList']);
 }
 ?>
 
@@ -256,7 +256,7 @@ if ($GLOBALS['cfg']['LeftFrameLight'] && strlen($GLOBALS['db'])) {
               'pos' => $tpos,
               'db' => $GLOBALS['db']
             );
-            PMA_listNavigator(
+            echo PMA_getListNavigator(
                 $table_count, $tpos, $_url_params, 'navigation.php',
                 'frame_navigation', $GLOBALS['cfg']['MaxTableList']
             );
@@ -266,7 +266,7 @@ if ($GLOBALS['cfg']['LeftFrameLight'] && strlen($GLOBALS['db'])) {
         if (count($table_list) <= $GLOBALS['cfg']['MaxTableList']
             && $table_count > $GLOBALS['cfg']['MaxTableList']
         ) {
-            PMA_listNavigator(
+            echo PMA_getListNavigator(
                 $table_count, $tpos, $_url_params, 'navigation.php',
                 'frame_navigation', $GLOBALS['cfg']['MaxTableList']
             );
@@ -297,7 +297,7 @@ if ($GLOBALS['cfg']['LeftFrameLight'] && strlen($GLOBALS['db'])) {
 } else {
     echo '<div id="databaseList">' . "\n";
     $_url_params = array('pos' => $pos);
-    PMA_listNavigator(
+    echo PMA_getListNavigator(
         count($GLOBALS['pma']->databases), $pos, $_url_params, 'navigation.php',
         'frame_navigation', $GLOBALS['cfg']['MaxDbList']
     );
diff --git a/server_databases.php b/server_databases.php
index a15e2cd178..e95a01f847 100644
--- a/server_databases.php
+++ b/server_databases.php
@@ -172,7 +172,7 @@ if ($databases_count > 0) {
         'sort_order' => $sort_order,
     );
 
-    PMA_listNavigator($databases_count, $pos, $_url_params, 'server_databases.php', 'frame_content', $GLOBALS['cfg']['MaxDbList']);
+    echo PMA_getListNavigator($databases_count, $pos, $_url_params, 'server_databases.php', 'frame_content', $GLOBALS['cfg']['MaxDbList']);
 
     $_url_params['pos'] = $pos;