MDL-59323 XMLDB: Code style fixes
authorsam marshall <s.marshall@open.ac.uk>
Thu, 13 Jul 2017 10:58:19 +0000 (11:58 +0100)
committersam marshall <s.marshall@open.ac.uk>
Thu, 13 Jul 2017 11:01:42 +0000 (12:01 +0100)
admin/tool/xmldb/actions/check_defaults/check_defaults.class.php

index 73306ea..c8b7846 100644 (file)
@@ -20,6 +20,8 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * This class will check all the default values existing in the DB
  * match those specified in the xml specs
@@ -34,15 +36,15 @@ class check_defaults extends XMLDBCheckAction {
     /**
      * Init method, every subclass will have its own
      */
-    function init() {
+    public function init() {
         $this->introstr = 'confirmcheckdefaults';
         parent::init();
 
-        // Set own core attributes
+        // Set own core attributes.
 
-        // Set own custom attributes
+        // Set own custom attributes.
 
-        // Get needed strings
+        // Get needed strings.
         $this->loadStrings(array(
             'wrongdefaults' => 'tool_xmldb',
             'nowrongdefaultsfound' => 'tool_xmldb',
@@ -52,107 +54,106 @@ class check_defaults extends XMLDBCheckAction {
         ));
     }
 
-    protected function check_table(xmldb_table $xmldb_table, array $metacolumns) {
+    protected function check_table(xmldb_table $xmldbtable, array $metacolumns) {
         $o = '';
-        $wrong_fields = array();
+        $wrongfields = array();
 
-        // Get and process XMLDB fields
-        if ($xmldb_fields = $xmldb_table->getFields()) {
-            $o.='        <ul>';
-            foreach ($xmldb_fields as $xmldb_field) {
+        // Get and process XMLDB fields.
+        if ($xmldbfields = $xmldbtable->getFields()) {
+            $o .= '        <ul>';
+            foreach ($xmldbfields as $xmldbfield) {
 
-                // Get the default value for the field
-                $xmldbdefault = $xmldb_field->getDefault();
+                // Get the default value for the field.
+                $xmldbdefault = $xmldbfield->getDefault();
 
-                // If the metadata for that column doesn't exist or 'id' field found, skip
-                if (!isset($metacolumns[$xmldb_field->getName()]) or $xmldb_field->getName() == 'id') {
+                // If the metadata for that column doesn't exist or 'id' field found, skip.
+                if (!isset($metacolumns[$xmldbfield->getName()]) or $xmldbfield->getName() == 'id') {
                     continue;
                 }
 
-                // To variable for better handling
-                $metacolumn = $metacolumns[$xmldb_field->getName()];
+                // To variable for better handling.
+                $metacolumn = $metacolumns[$xmldbfield->getName()];
 
-                // Going to check this field in DB
-                $o.='            <li>' . $this->str['field'] . ': ' . $xmldb_field->getName() . ' ';
+                // Going to check this field in DB.
+                $o .= '            <li>' . $this->str['field'] . ': ' . $xmldbfield->getName() . ' ';
 
-                // get the value of the physical default (or blank if there isn't one)
-                if ($metacolumn->has_default==1) {
+                // Get the value of the physical default (or blank if there isn't one).
+                if ($metacolumn->has_default == 1) {
                     $physicaldefault = $metacolumn->default_value;
-                }
-                else {
+                } else {
                     $physicaldefault = '';
                 }
 
-                // there *is* a default and it's wrong
+                // There *is* a default and it's wrong.
                 if ($physicaldefault != $xmldbdefault) {
                     $info = '('.$this->str['expected']." '$xmldbdefault', ".$this->str['actual'].
                     " '$physicaldefault')";
-                    $o.='<font color="red">' . $this->str['wrong'] . " $info</font>";
-                    // Add the wrong field to the list
+                    $o .= '<font color="red">' . $this->str['wrong'] . " $info</font>";
+                    // Add the wrong field to the list.
                     $obj = new stdClass();
-                    $obj->table = $xmldb_table;
-                    $obj->field = $xmldb_field;
+                    $obj->table = $xmldbtable;
+                    $obj->field = $xmldbfield;
                     $obj->physicaldefault = $physicaldefault;
                     $obj->xmldbdefault = $xmldbdefault;
-                    $wrong_fields[] = $obj;
+                    $wrongfields[] = $obj;
                 } else {
-                    $o.='<font color="green">' . $this->str['ok'] . '</font>';
+                    $o .= '<font color="green">' . $this->str['ok'] . '</font>';
                 }
-                $o.='</li>';
+                $o .= '</li>';
             }
-            $o.='        </ul>';
+            $o .= '        </ul>';
         }
 
-        return array($o, $wrong_fields);
+        return array($o, $wrongfields);
     }
 
-    protected function display_results(array $wrong_fields) {
+    protected function display_results(array $wrongfields) {
         global $DB;
         $dbman = $DB->get_manager();
 
         $s = '';
         $r = '<table class="generaltable boxaligncenter boxwidthwide" border="0" cellpadding="5" cellspacing="0" id="results">';
-        $r.= '  <tr><td class="generalboxcontent">';
-        $r.= '    <h2 class="main">' . $this->str['searchresults'] . '</h2>';
-        $r.= '    <p class="centerpara">' . $this->str['wrongdefaults'] . ': ' . count($wrong_fields) . '</p>';
-        $r.= '  </td></tr>';
-        $r.= '  <tr><td class="generalboxcontent">';
-
-        // If we have found wrong defaults inform about them
-        if (count($wrong_fields)) {
-            $r.= '    <p class="centerpara">' . $this->str['yeswrongdefaultsfound'] . '</p>';
-            $r.= '        <ul>';
-            foreach ($wrong_fields as $obj) {
-                $xmldb_table = $obj->table;
-                $xmldb_field = $obj->field;
+        $r .= '  <tr><td class="generalboxcontent">';
+        $r .= '    <h2 class="main">' . $this->str['searchresults'] . '</h2>';
+        $r .= '    <p class="centerpara">' . $this->str['wrongdefaults'] . ': ' . count($wrongfields) . '</p>';
+        $r .= '  </td></tr>';
+        $r .= '  <tr><td class="generalboxcontent">';
+
+        // If we have found wrong defaults inform about them.
+        if (count($wrongfields)) {
+            $r .= '    <p class="centerpara">' . $this->str['yeswrongdefaultsfound'] . '</p>';
+            $r .= '        <ul>';
+            foreach ($wrongfields as $obj) {
+                $xmldbtable = $obj->table;
+                $xmldbfield = $obj->field;
                 $physicaldefault = $obj->physicaldefault;
                 $xmldbdefault = $obj->xmldbdefault;
 
-                // get the alter table command
-                $sqlarr = $dbman->generator->getAlterFieldSQL($xmldb_table, $xmldb_field);
+                // Get the alter table command.
+                $sqlarr = $dbman->generator->getAlterFieldSQL($xmldbtable, $xmldbfield);
 
-                $r.= '            <li>' . $this->str['table'] . ': ' . $xmldb_table->getName() . '. ' .
-                                          $this->str['field'] . ': ' . $xmldb_field->getName() . ', ' .
-                                          $this->str['expected'] . ' ' . "'$xmldbdefault'" . ' ' .
-                                          $this->str['actual'] . ' ' . "'$physicaldefault'" . '</li>';
-                // Add to output if we have sentences
+                $r .= '            <li>' . $this->str['table'] . ': ' . $xmldbtable->getName() . '. ' .
+                        $this->str['field'] . ': ' . $xmldbfield->getName() . ', ' .
+                        $this->str['expected'] . ' ' . $xmldbtext . ' ' .
+                        $this->str['actual'] . ' ' . $physicaltext . '</li>';
+                // Add to output if we have sentences.
                 if ($sqlarr) {
                     $sqlarr = $dbman->generator->getEndedStatements($sqlarr);
-                    $s.= '<code>' . str_replace("\n", '<br />', implode('<br />', $sqlarr)) . '</code><br />';
+                    $s .= '<code>' . str_replace("\n", '<br />', implode('<br />', $sqlarr)) . '</code><br />';
                 }
             }
-            $r.= '        </ul>';
-            // Add the SQL statements (all together)
-            $r.= '<hr />' . $s;
+            $r .= '        </ul>';
+            // Add the SQL statements (all together).
+            $r .= '<hr />' . $s;
         } else {
-            $r.= '    <p class="centerpara">' . $this->str['nowrongdefaultsfound'] . '</p>';
+            $r .= '    <p class="centerpara">' . $this->str['nowrongdefaultsfound'] . '</p>';
         }
-        $r.= '  </td></tr>';
-        $r.= '  <tr><td class="generalboxcontent">';
-        // Add the complete log message
-        $r.= '    <p class="centerpara">' . $this->str['completelogbelow'] . '</p>';
-        $r.= '  </td></tr>';
-        $r.= '</table>';
+        $r .= '  </td></tr>';
+        $r .= '  <tr><td class="generalboxcontent">';
+        // Add the complete log message.
+        $r .= '    <p class="centerpara">' . $this->str['completelogbelow'] . '</p>';
+        $r .= '  </td></tr>';
+        $r .= '</table>';
 
         return $r;
     }