Simplify getting table comment

- remove not needed word Show from method name - fix code to handle errors Signed-off-by: Michal Čihař <[email protected]>
linaspasv · Mar 20, 2017 · b2bf9fb · b2bf9fb
1 parent 56046cc
commit b2bf9fb
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 9 deletions.
diff --git a/libraries/Menu.php b/libraries/Menu.php
@@ -240,7 +240,7 @@ private function _getBreadcrumbs()
                     $show_comment = null;
                 } else {
                     $tbl_is_view = false;
-                    $show_comment = $table_class_object->getShowComment();
+                    $show_comment = $table_class_object->getComment();
                 }
                 $retval .= $separator;
                 if (Util::showIcons('TabsMode')) {

diff --git a/libraries/Table.php b/libraries/Table.php
@@ -339,11 +339,12 @@ public function getStorageEngine() {
      *
      * @return string  Return comment info if it is set for the selected table or return blank.
      */
-    public function getShowComment() {
+    public function getComment() {
         $table_comment = $this->getStatusInfo('COMMENT', false, true);
         if ($table_comment === false) {
-            return isset($table_comment) ? $table_comment : '';
+            return '';
         }
+        return $table_comment;
     }
 
     /**

diff --git a/libraries/controllers/table/TableChartController.php b/libraries/controllers/table/TableChartController.php
@@ -128,7 +128,7 @@ public function indexAction()
             } else {
                 $tbl_is_view = false;
                 $tbl_storage_engine = $table_class_object->getStorageEngine();
-                $show_comment = $table_class_object->getShowComment();
+                $show_comment = $table_class_object->getComment();
             }
             $tbl_collation = $table_class_object->getTableCollation();
             $table_info_num_rows = $table_class_object->getTableNumRowInfo();

diff --git a/libraries/controllers/table/TableIndexesController.php b/libraries/controllers/table/TableIndexesController.php
@@ -76,7 +76,7 @@ public function displayFormAction()
         } else {
             $tbl_is_view = false;
             $tbl_storage_engine = $table_class_object->getStorageEngine();
-            $show_comment = $table_class_object->getShowComment();
+            $show_comment = $table_class_object->getComment();
         }
         $tbl_collation = $table_class_object->getTableCollation();
         $table_info_num_rows = $table_class_object->getTableNumRowInfo();

diff --git a/tbl_operations.php b/tbl_operations.php
@@ -222,7 +222,7 @@
     } else {
         $tbl_is_view = false;
         $tbl_storage_engine = $pma_table->getStorageEngine();
-        $show_comment = $pma_table->getShowComment();
+        $show_comment = $pma_table->getComment();
     }
     $tbl_collation = $pma_table->getTableCollation();
     $table_info_num_rows = $pma_table->getTableNumRowInfo();

diff --git a/test/classes/TableTest.php b/test/classes/TableTest.php
@@ -1226,11 +1226,11 @@ public function testGetStorageEngine(){
     }
 
     /**
-     * Test for getShowComment
+     * Test for getComment
      *
      * @return void
      */
-    public function testGetShowComment(){
+    public function testGetComment(){
         $target_table = 'table1';
         $target_db = 'pma_test';
         $tbl_object = new Table($target_db, $target_table);
@@ -1241,7 +1241,7 @@ public function testGetShowComment(){
         $show_comment = $dbi->getTable(
             $target_db,
             $target_table
-        )->getShowComment();
+        )->getComment();
         $this->assertEquals(
             $expect,
             $show_comment