Underscores are preferred to separate words in configuration storage …

…table names/directives

Signed-off-by: Madhura Jayaratne <[email protected]>

config.sample.inc.php

@@ -63,7 +63,7 @@
 // $cfg['Servers'][$i]['savedsearches'] = 'pma__savedsearches';
 // $cfg['Servers'][$i]['central_columns'] = 'pma__central_columns';
 // $cfg['Servers'][$i]['designer_settings'] = 'pma__designer_settings';
-// $cfg['Servers'][$i]['exporttemplates'] = 'pma__exporttemplates';
+// $cfg['Servers'][$i]['export_templates'] = 'pma__export_templates';
 /* Contrib / Swekey authentication */
 // $cfg['Servers'][$i]['auth_swekey_config'] = '/etc/swekey-pma.conf';
 

doc/config.rst

@@ -812,8 +812,8 @@ Server connection settings
     * put the table name in :config:option:`$cfg['Servers'][$i]['savedsearches']` (e.g.
       ``pma__savedsearches``)
 
-.. _exporttemplates:
-.. config:option:: $cfg['Servers'][$i]['exporttemplates']
+.. _export_templates:
+.. config:option:: $cfg['Servers'][$i]['export_templates']
 
     :type: string
     :default: ``''``
@@ -823,8 +823,8 @@ Server connection settings
     To allow the usage of this functionality:
 
     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
-    * put the table name in :config:option:`$cfg['Servers'][$i]['exporttemplates']` (e.g.
-      ``pma__exporttemplates``)
+    * put the table name in :config:option:`$cfg['Servers'][$i]['export_templates']` (e.g.
+      ``pma__export_templates``)
 
 .. _tracking:
 .. config:option:: $cfg['Servers'][$i]['tracking']

examples/config.manyhosts.inc.php

@@ -49,5 +49,5 @@
     $cfg['Servers'][$i]['savedsearches'] = 'pma__savedsearches';
     $cfg['Servers'][$i]['central_columns'] = 'pma__central_columns';
     $cfg['Servers'][$i]['designer_settings'] = 'pma__designer_settings';
-    $cfg['Servers'][$i]['exporttemplates'] = 'pma__exporttemplates';
+    $cfg['Servers'][$i]['export_templates'] = 'pma__export_templates';
 }

libraries/DisplayResults.class.php

@@ -349,8 +349,8 @@ private  function _setDefaultTransformations()
                     'config_data' => $json_highlighting_data
                 );
             }
-            if (! empty($cfgRelation['exporttemplates'])) {
-                $relDb[$cfgRelation['exporttemplates']] = array(
+            if (! empty($cfgRelation['export_templates'])) {
+                $relDb[$cfgRelation['export_templates']] = array(
                     'template_data' => $json_highlighting_data
                 );
             }

libraries/config.default.php

@@ -493,11 +493,11 @@
 /**
  * table to store export templates
  *   - leave blank to disable saved searches feature
- *     SUGGESTED: 'pma__exporttemplates'
+ *     SUGGESTED: 'pma__export_templates'
  *
- * @global string $cfg['Servers'][$i]['exporttemplates']
+ * @global string $cfg['Servers'][$i]['export_templates']
  */
-$cfg['Servers'][$i]['exporttemplates'] = '';
+$cfg['Servers'][$i]['export_templates'] = '';
 
 /**
  * Maximum number of records saved in $cfg['Servers'][$i]['table_uiprefs'] table.

libraries/config/messages.inc.php

@@ -655,7 +655,7 @@
 $strConfigServers_savedsearches_name = __('Export templates table');
 $strConfigServers_savedsearches_desc = __(
     'Leave blank for no export template support, suggested: '
-    . '[kbd]pma__exporttemplates[/kbd].'
+    . '[kbd]pma__export_templates[/kbd].'
 );
 $strConfigServers_central_columns_name = __('Central columns table');
 $strConfigServers_central_columns_desc = __(

libraries/config/setup.forms.php

@@ -84,7 +84,7 @@
     'savedsearches' => 'pma__savedsearches',
     'central_columns' => 'pma__central_columns',
     'designer_settings' => 'pma__designer_settings',
-    'exporttemplates' => 'pma__exporttemplates',
+    'export_templates' => 'pma__export_templates',
     'MaxTableUiprefs' => 100)));
 $forms['Servers']['Server_tracking'] = array('Servers' => array(1 => array(
     'tracking_version_auto_create',

libraries/display_export.inc.php

@@ -42,7 +42,7 @@
 $html  = PMA_getHtmlForExportOptionHeader($export_type, $db, $table);
 
 $cfgRelation = PMA_getRelationsParam();
-if ($cfgRelation['exporttemplateswork']) {
+if ($cfgRelation['export_templateswork']) {
     $html .= PMA_getHtmlForExportTemplateLoading($export_type);
 }
 

libraries/display_export.lib.php

@@ -199,7 +199,7 @@ function PMA_getHtmlForExportOptionHeader($export_type, $db, $table)
  */
 function PMA_getHtmlForExportTemplateLoading($export_type)
 {
-    $html  = '<div class="exportoptions" id="exporttemplates">';
+    $html  = '<div class="exportoptions" id="export_templates">';
     $html .= '<h3>' . __('Export templates:') . '</h3>';
 
     $html .= '<div class="floatleft">';
@@ -220,7 +220,7 @@ function PMA_getHtmlForExportTemplateLoading($export_type)
     $html .= '<h4>' . __('Existing templates:') . '</h4>';
     $html .= '<label for="template">' . __('Template:') . '</label>';
     $html .= '<select required="required" name="template" id="template">';
-    $html .= PMA_getOptionsForExportTemplates($export_type);
+    $html .= PMA_getOptionsForexport_templates($export_type);
     $html .= '</select>';
     $html .= '<input type="submit" name="updateTemplate" '
         . 'id="updateTemplate" value="' . __('Update') . '" />';
@@ -243,7 +243,7 @@ function PMA_getHtmlForExportTemplateLoading($export_type)
  *
  * @return string HTML for the options in teplate dropdown
  */
-function PMA_getOptionsForExportTemplates($export_type)
+function PMA_getOptionsForexport_templates($export_type)
 {
     $ret = '<option value="">-- ' . __('Select a template') . ' --</option>';
 
@@ -252,7 +252,7 @@ function PMA_getOptionsForExportTemplates($export_type)
 
     $query = "SELECT `id`, `template_name` FROM "
        . PMA_Util::backquote($cfgRelation['db']) . '.'
-       . PMA_Util::backquote($cfgRelation['exporttemplates'])
+       . PMA_Util::backquote($cfgRelation['export_templates'])
        . " WHERE `username` = "
        . "'" . PMA_Util::sqlAddSlashes($GLOBALS['cfg']['Server']['user']) . "'"
        . " AND `export_type` = '" . $export_type . "'"

libraries/export.lib.php

@@ -1028,7 +1028,7 @@ function PMA_getMetadataTypesToExport()
         'pdf_pages',
         'savedsearches',
         'central_columns',
-        'exporttemplates',
+        'export_templates',
     );
 }
 ?>

libraries/relation.lib.php

@@ -326,14 +326,14 @@ function PMA_getRelationsParamDiagnostic($cfgRelation)
             $messages
         );
         $retval .= PMA_getDiagMessageForParameter(
-            'exporttemplates',
-            isset($cfgRelation['exporttemplates']),
+            'export_templates',
+            isset($cfgRelation['export_templates']),
             $messages,
-            'exporttemplates'
+            'export_templates'
         );
         $retval .= PMA_getDiagMessageForFeature(
             __('Saving export templates'),
-            'exporttemplateswork',
+            'export_templateswork',
             $messages
         );
         $retval .= '</table>' . "\n";
@@ -463,7 +463,7 @@ function PMA_checkRelationsParam()
     $cfgRelation['savedsearcheswork'] = false;
     $cfgRelation['central_columnswork'] = false;
     $cfgRelation['designer_settingswork'] = false;
-    $cfgRelation['exporttemplateswork'] = false;
+    $cfgRelation['export_templateswork'] = false;
     $cfgRelation['user']           = null;
     $cfgRelation['db']             = null;
 
@@ -539,8 +539,8 @@ function PMA_checkRelationsParam()
             $cfgRelation['central_columns']    = $curr_table[0];
         } elseif ($curr_table[0] == $GLOBALS['cfg']['Server']['designer_settings']) {
             $cfgRelation['designer_settings'] = $curr_table[0];
-        } elseif ($curr_table[0] == $GLOBALS['cfg']['Server']['exporttemplates']) {
-            $cfgRelation['exporttemplates']    = $curr_table[0];
+        } elseif ($curr_table[0] == $GLOBALS['cfg']['Server']['export_templates']) {
+            $cfgRelation['export_templates']    = $curr_table[0];
         }
     } // end while
     $GLOBALS['dbi']->freeResult($tab_rs);
@@ -611,8 +611,8 @@ function PMA_checkRelationsParam()
         $cfgRelation['designer_settingswork']    = true;
     }
 
-    if (isset($cfgRelation['exporttemplates'])) {
-        $cfgRelation['exporttemplateswork']      = true;
+    if (isset($cfgRelation['export_templates'])) {
+        $cfgRelation['export_templateswork']      = true;
     }
 
     if ($cfgRelation['relwork'] && $cfgRelation['displaywork']
@@ -624,7 +624,7 @@ function PMA_checkRelationsParam()
         && $cfgRelation['menuswork'] && $cfgRelation['navwork']
         && $cfgRelation['savedsearcheswork'] && $cfgRelation['favoritework']
         && $cfgRelation['designer_settingswork']
-        && $cfgRelation['exporttemplateswork']
+        && $cfgRelation['export_templateswork']
     ) {
         $cfgRelation['allworks'] = true;
     }
@@ -1841,7 +1841,7 @@ function PMA_fixPMATables($db, $create = true)
         'pma__savedsearches' => 'savedsearches',
         'pma__central_columns' => 'central_columns',
         'pma__designer_settings' => 'designer_settings',
-        'pma__exporttemplates' => 'exporttemplates',
+        'pma__export_templates' => 'export_templates',
     );
 
     $existingTables = $GLOBALS['dbi']->getTables($db, $GLOBALS['controllink']);

sql/create_tables.sql

@@ -339,10 +339,10 @@ CREATE TABLE IF NOT EXISTS `pma__designer_settings` (
 -- --------------------------------------------------------
 
 --
--- Table structure for table `pma__exporttemplates`
+-- Table structure for table `pma__export_templates`
 --
 
-CREATE TABLE IF NOT EXISTS `pma__exporttemplates` (
+CREATE TABLE IF NOT EXISTS `pma__export_templates` (
   `id` int(5) unsigned NOT NULL AUTO_INCREMENT,
   `username` varchar(64) NOT NULL,
   `export_type` varchar(10) NOT NULL,

sql/create_tables_drizzle.sql

@@ -291,10 +291,10 @@ CREATE TABLE IF NOT EXISTS `pma__designer_settings` (
 -- --------------------------------------------------------
 
 --
--- Table structure for table `pma__exporttemplates`
+-- Table structure for table `pma__export_templates`
 --
 
-CREATE TABLE IF NOT EXISTS `pma__exporttemplates` (
+CREATE TABLE IF NOT EXISTS `pma__export_templates` (
   `id` int(5) unsigned NOT NULL AUTO_INCREMENT,
   `username` varchar(64) NOT NULL,
   `export_type` varchar(10) NOT NULL,

tbl_export.php

@@ -24,15 +24,15 @@
 $cfgRelation = PMA_getRelationsParam();
 
 // handling export template actions
-if (isset($_REQUEST['templateAction']) && $cfgRelation['exporttemplateswork']) {
+if (isset($_REQUEST['templateAction']) && $cfgRelation['export_templateswork']) {
 
     if (isset($_REQUEST['templateId'])) {
         $templateId = $_REQUEST['templateId'];
         $id = PMA_Util::sqlAddSlashes($templateId);
     }
 
     $templateTable = PMA_Util::backquote($cfgRelation['db']) . '.'
-       . PMA_Util::backquote($cfgRelation['exporttemplates']);
+       . PMA_Util::backquote($cfgRelation['export_templates']);
     $user = PMA_Util::sqlAddSlashes($GLOBALS['cfg']['Server']['user']);
 
     switch ($_REQUEST['templateAction']) {
@@ -77,7 +77,7 @@
     if ('create' == $_REQUEST['templateAction']) {
         $response->addJSON(
             'data',
-            PMA_getOptionsForExportTemplates($_REQUEST['exportType'])
+            PMA_getOptionsForexport_templates($_REQUEST['exportType'])
         );
     } elseif ('load' == $_REQUEST['templateAction']) {
         $data = null;

test/libraries/PMA_relation_cleanup_test.php

@@ -55,7 +55,7 @@ public function setUp()
         $GLOBALS['cfg']['Server']['savedsearches'] = 'savedsearches';
         $GLOBALS['cfg']['Server']['central_columns'] = 'central_columns';
         $GLOBALS['cfg']['Server']['designer_settings'] = 'designer_settings';
-        $GLOBALS['cfg']['Server']['exporttemplates'] = 'pma__exporttemplates';
+        $GLOBALS['cfg']['Server']['export_templates'] = 'pma__export_templates';
 
         $this->redefineRelation();
     }