oop: some coding style for plugins

phpmyadmin · Aug 16, 2012 · 34a0dac · 34a0dac
1 parent 37e771f
commit 34a0dac
Show file tree

Hide file tree

Showing 11 changed files with 73 additions and 43 deletions.
diff --git a/libraries/plugins/AuthenticationPlugin.class.php b/libraries/plugins/AuthenticationPlugin.class.php
@@ -21,30 +21,30 @@
 abstract class AuthenticationPlugin extends PluginObserver
 {
     /**
+     * Displays authentication form
      *
-     *
-     * @return void
+     * @return boolean
      */
     abstract public function auth();
 
     /**
+     * Gets advanced authentication settings
      *
-     *
-     * @return void
+     * @return boolean
      */
     abstract public function authCheck();
 
     /**
+     * Set the user and password after last checkings if required
      *
-     *
-     * @return void
+     * @return boolean
      */
     abstract public function authSetUser();
 
     /**
+     * User is not allowed to login to MySQL -> authentication failed
      *
-     *
-     * @return void
+     * @return boolean
      */
     abstract public function authFails();
 }

diff --git a/libraries/plugins/PluginObserver.class.php b/libraries/plugins/PluginObserver.class.php
@@ -54,7 +54,9 @@ public function __construct($pluginManager)
      */
     public function update (SplSubject $subject)
     {
-        throw new Exception('PluginObserver::update must be overridden in child classes.');
+        throw new Exception(
+            'PluginObserver::update must be overridden in child classes.'
+        );
     }
 
 

diff --git a/libraries/plugins/TransformationsInterface.int.php b/libraries/plugins/TransformationsInterface.int.php
@@ -15,7 +15,8 @@
  *
  * @package PhpMyAdmin
  */
-interface TransformationsInterface {
+interface TransformationsInterface
+{
     /**
      * Gets the transformation description
      *

diff --git a/libraries/plugins/TransformationsPlugin.class.php b/libraries/plugins/TransformationsPlugin.class.php
@@ -26,7 +26,7 @@ abstract class TransformationsPlugin extends PluginObserver
     /**
      * Does the actual work of each specific transformations plugin.
      *
-     * @param array  $options transformation options
+     * @param array $options transformation options
      *
      * @return void
      */

diff --git a/libraries/plugins/UploadInterface.int.php b/libraries/plugins/UploadInterface.int.php
@@ -15,7 +15,8 @@
  *
  * @package PhpMyAdmin
  */
-interface UploadInterface {
+interface UploadInterface
+{
     /**
      * Gets the specific upload ID Key
      *

diff --git a/libraries/plugins/export/ExportSql.class.php b/libraries/plugins/export/ExportSql.class.php
@@ -1451,7 +1451,8 @@ public function exportStructure(
         }
 
         $formatted_table_name = (isset($GLOBALS['sql_backquotes']))
-            ? $common_functions->backquote_compat($table, $compat) : '\'' . $table . '\'';
+            ? $common_functions->backquote_compat($table, $compat)
+            : '\'' . $table . '\'';
         $dump = $this->_possibleCRLF()
             . $this->_exportComment(str_repeat('-', 56))
             . $this->_possibleCRLF()
@@ -1672,12 +1673,20 @@ public function exportData($db, $table, $crlf, $error_url, $sql_query)
                 ) {
                     $fields        = implode(', ', $field_set);
                     $schema_insert = $sql_command . $insert_delayed .' INTO '
-                        . $common_functions->backquote_compat($table, $compat, $sql_backquotes)
+                        . $common_functions->backquote_compat(
+                            $table,
+                            $compat,
+                            $sql_backquotes
+                        )
                         // avoid EOL blank
                         . ' (' . $fields . ') VALUES';
                 } else {
                     $schema_insert = $sql_command . $insert_delayed .' INTO '
-                        . $common_functions->backquote_compat($table, $compat, $sql_backquotes)
+                        . $common_functions->backquote_compat(
+                            $table,
+                            $compat,
+                            $sql_backquotes
+                        )
                         . ' VALUES';
                 }
             }
@@ -1715,12 +1724,16 @@ public function exportData($db, $table, $crlf, $error_url, $sql_query)
                  // We need to SET IDENTITY_INSERT ON for MSSQL
                 if (isset($GLOBALS['sql_compatibility'])
                     && $GLOBALS['sql_compatibility'] == 'MSSQL'
-                    && $current_row == 0) {
-                    if (! PMA_exportOutputHandler('SET IDENTITY_INSERT '
-                            . $common_functions->backquote_compat(
-                                    $table,
-                                    $compat)
-                            . ' ON ;'.$crlf)) {
+                    && $current_row == 0
+                ) {
+                    if (! PMA_exportOutputHandler(
+                        'SET IDENTITY_INSERT '
+                        . $common_functions->backquote_compat(
+                            $table,
+                            $compat
+                        )
+                        . ' ON ;'.$crlf
+                    )) {
                         return false;
                     }
                 }
@@ -1851,23 +1864,25 @@ public function exportData($db, $table, $crlf, $error_url, $sql_query)
                 }
             }
 
-        // We need to SET IDENTITY_INSERT OFF for MSSQL
+            // We need to SET IDENTITY_INSERT OFF for MSSQL
         if (isset($GLOBALS['sql_compatibility'])
-             && $GLOBALS['sql_compatibility'] == 'MSSQL'
-             && $current_row > 0)
-        if (! PMA_exportOutputHandler(
-            $crlf . 'SET IDENTITY_INSERT '
+            && $GLOBALS['sql_compatibility'] == 'MSSQL'
+            && $current_row > 0
+        )
+            if (! PMA_exportOutputHandler(
+                $crlf . 'SET IDENTITY_INSERT '
                 . $common_functions->backquote_compat(
-                        $table,
-                        $compat)
+                    $table,
+                    $compat
+                )
                 . ' OFF;' . $crlf
             )) {
-            return false;
-        }
+                return false;
+            }
 
         } // end if ($result != false)
         PMA_DBI_free_result($result);
 
         return true;
     } // end of the 'exportData()' function
-}
+}
diff --git a/libraries/plugins/import/ImportLdi.class.php b/libraries/plugins/import/ImportLdi.class.php
@@ -145,10 +145,12 @@ public function doImport()
             $sql .= ' FIELDS TERMINATED BY \'' . $ldi_terminated . '\'';
         }
         if (strlen($ldi_enclosed) > 0) {
-            $sql .= ' ENCLOSED BY \'' . $common_functions->sqlAddSlashes($ldi_enclosed) . '\'';
+            $sql .= ' ENCLOSED BY \''
+                . $common_functions->sqlAddSlashes($ldi_enclosed) . '\'';
         }
         if (strlen($ldi_escaped) > 0) {
-            $sql .= ' ESCAPED BY \'' . $common_functions->sqlAddSlashes($ldi_escaped) . '\'';
+            $sql .= ' ESCAPED BY \''
+                . $common_functions->sqlAddSlashes($ldi_escaped) . '\'';
         }
         if (strlen($ldi_new_line) > 0) {
             if ($ldi_new_line == 'auto') {
@@ -172,7 +174,9 @@ public function doImport()
                     $sql .= ', ';
                 }
                 /* Trim also `, if user already included backquoted fields */
-                $sql .= $common_functions->backquote(trim($tmp[$i], " \t\r\n\0\x0B`"));
+                $sql .= $common_functions->backquote(
+                    trim($tmp[$i], " \t\r\n\0\x0B`")
+                );
             } // end for
             $sql .= ')';
         }

diff --git a/libraries/plugins/import/ImportOds.class.php b/libraries/plugins/import/ImportOds.class.php
@@ -69,10 +69,11 @@ protected function setProperties()
         $leaf = new BoolPropertyItem();
         $leaf->setName("col_names");
         $leaf->setText(
-                __('The first line of the file contains the table column names'
-                    . ' <i>(if this is unchecked, the first line will become part'
-                    . ' of the data)</i>'
-                )
+            __(
+                'The first line of the file contains the table column names'
+                . ' <i>(if this is unchecked, the first line will become part'
+                . ' of the data)</i>'
+            )
         );
         $generalOptions->addProperty($leaf);
         $leaf = new BoolPropertyItem();
@@ -82,9 +83,9 @@ protected function setProperties()
         $leaf = new BoolPropertyItem();
         $leaf->setName("recognize_percentages");
         $leaf->setText(
-             __(
+            __(
                 'Import percentages as proper decimals <i>(ex. 12.00% to .12)</i>'
-             )
+            )
         );
         $generalOptions->addProperty($leaf);
         $leaf = new BoolPropertyItem();

diff --git a/libraries/plugins/import/ImportXml.class.php b/libraries/plugins/import/ImportXml.class.php
@@ -219,7 +219,9 @@ public function doImport()
                      */
                     $attrs = $val2->attributes();
                     $create[] = "USE "
-                        . PMA_CommonFunctions::getInstance()->backquote($attrs["name"]);
+                        . PMA_CommonFunctions::getInstance()->backquote(
+                            $attrs["name"]
+                        );
 
                     foreach ($val2 as $val3) {
                         /**

diff --git a/libraries/plugins/transformations/abstract/DateFormatTransformationsPlugin.class.php b/libraries/plugins/transformations/abstract/DateFormatTransformationsPlugin.class.php
@@ -130,7 +130,10 @@ public function applyTransformation($buffer, $options = array(), $meta = '')
             $timestamp -= $options[0] * 60 * 60;
             $source = $buffer;
             if ($options[2] == 'local') {
-                $text = PMA_CommonFunctions::getInstance()->localisedDate($timestamp, $options[1]);
+                $text = PMA_CommonFunctions::getInstance()->localisedDate(
+                    $timestamp,
+                    $options[1]
+                );
             } elseif ($options[2] == 'utc') {
                 $text = gmdate($options[1], $timestamp);
             } else {

diff --git a/libraries/plugins/transformations/abstract/TextLinkTransformationsPlugin.class.php b/libraries/plugins/transformations/abstract/TextLinkTransformationsPlugin.class.php
@@ -52,7 +52,8 @@ public function applyTransformation($buffer, $options = array(), $meta = '')
             'string' => '<a href="'
                 . PMA_linkURL((isset($options[0]) ? $options[0] : '') . $append_part)
                 . '" title="' . (isset($options[1]) ? $options[1] : '')
-                . '" target="_new">' . (isset($options[1]) ? $options[1] : $buffer) . '</a>'
+                . '" target="_new">' . (isset($options[1]) ? $options[1] : $buffer)
+                . '</a>'
         );
 
         $buffer = PMA_transformation_global_html_replace(