MDL-50887 antivirus: Fix style issues.

moodle · Feb 25, 2016 · 1a980fd · 1a980fd
1 parent 375223c
commit 1a980fd
Show file tree

Hide file tree

Showing 11 changed files with 95 additions and 78 deletions.
diff --git a/admin/antiviruses.php b/admin/antiviruses.php
@@ -30,7 +30,7 @@
 $antivirus  = required_param('antivirus', PARAM_PLUGIN);
 $confirm = optional_param('confirm', 0, PARAM_BOOL);
 
-$PAGE->set_url('/admin/antiviruses.php', array('action'=>$action, 'antivirus'=>$antivirus));
+$PAGE->set_url('/admin/antiviruses.php', array('action' => $action, 'antivirus' => $antivirus));
 $PAGE->set_context(context_system::instance());
 
 require_login();
@@ -39,15 +39,15 @@
 $returnurl = "$CFG->wwwroot/$CFG->admin/settings.php?section=manageantiviruses";
 
 // Get currently installed and enabled antivirus plugins.
-$available_antiviruses = antiviruses_get_available();
-if (!empty($antivirus) and empty($available_antiviruses[$antivirus])) {
+$availableantiviruses = antiviruses_get_available();
+if (!empty($antivirus) and empty($availableantiviruses[$antivirus])) {
     redirect ($returnurl);
 }
 
-$active_antiviruses = explode(',', $CFG->antiviruses);
-foreach ($active_antiviruses as $key=>$active) {
-    if (empty($available_antiviruses[$active])) {
-        unset($active_antiviruses[$key]);
+$activeantiviruses = explode(',', $CFG->antiviruses);
+foreach ($activeantiviruses as $key => $active) {
+    if (empty($availableantiviruses[$active])) {
+        unset($activeantiviruses[$key]);
     }
 }
 
@@ -58,40 +58,40 @@
 switch ($action) {
     case 'disable':
         // Remove from enabled list.
-        $key = array_search($antivirus, $active_antiviruses);
-        unset($active_antiviruses[$key]);
+        $key = array_search($antivirus, $activeantiviruses);
+        unset($activeantiviruses[$key]);
         break;
 
     case 'enable':
         // Add to enabled list.
-        if (!in_array($antivirus, $active_antiviruses)) {
-            $active_antiviruses[] = $antivirus;
-            $active_antiviruses = array_unique($active_antiviruses);
+        if (!in_array($antivirus, $activeantiviruses)) {
+            $activeantiviruses[] = $antivirus;
+            $activeantiviruses = array_unique($activeantiviruses);
         }
         break;
 
     case 'down':
-        $key = array_search($antivirus, $active_antiviruses);
+        $key = array_search($antivirus, $activeantiviruses);
         // Check auth plugin is valid.
         if ($key !== false) {
-            // move down the list
-            if ($key < (count($active_antiviruses) - 1)) {
-                $fsave = $active_antiviruses[$key];
-                $active_antiviruses[$key] = $active_antiviruses[$key + 1];
-                $active_antiviruses[$key + 1] = $fsave;
+            // Move down the list.
+            if ($key < (count($activeantiviruses) - 1)) {
+                $fsave = $activeantiviruses[$key];
+                $activeantiviruses[$key] = $activeantiviruses[$key + 1];
+                $activeantiviruses[$key + 1] = $fsave;
             }
         }
         break;
 
     case 'up':
-        $key = array_search($antivirus, $active_antiviruses);
+        $key = array_search($antivirus, $activeantiviruses);
         // Check auth is valid.
         if ($key !== false) {
-            // move up the list
+            // Move up the list.
             if ($key >= 1) {
-                $fsave = $active_antiviruses[$key];
-                $active_antiviruses[$key] = $active_antiviruses[$key - 1];
-                $active_antiviruses[$key - 1] = $fsave;
+                $fsave = $activeantiviruses[$key];
+                $activeantiviruses[$key] = $activeantiviruses[$key - 1];
+                $activeantiviruses[$key - 1] = $fsave;
             }
         }
         break;
@@ -100,7 +100,7 @@
         break;
 }
 
-set_config('antiviruses', implode(',', $active_antiviruses));
+set_config('antiviruses', implode(',', $activeantiviruses));
 core_plugin_manager::reset_caches();
 
 redirect ($returnurl);
diff --git a/admin/settings/plugins.php b/admin/settings/plugins.php
@@ -138,13 +138,13 @@
         $plugin->load_settings($ADMIN, 'editorsettings', $hassiteconfig);
     }
 
-/// Antivirus plugins
+    // Antivirus plugins.
     $ADMIN->add('modules', new admin_category('antivirussettings', new lang_string('antiviruses', 'antivirus')));
     $temp = new admin_settingpage('manageantiviruses', new lang_string('antivirussettings', 'antivirus'));
     $temp->add(new admin_setting_manageantiviruses());
     $ADMIN->add('antivirussettings', $temp);
     foreach (core_plugin_manager::instance()->get_plugins_of_type('antivirus') as $plugin) {
-        /** @var \core\plugininfo\antivirus $plugin */
+        /* @var \core\plugininfo\antivirus $plugin */
         $plugin->load_settings($ADMIN, 'antivirussettings', $hassiteconfig);
     }
 

diff --git a/lib/adminlib.php b/lib/adminlib.php
@@ -6497,6 +6497,7 @@ public function output_html($data, $query='') {
 /**
  * Special class for antiviruses administration.
  *
+ * @copyright  2015 Ruslan Kabalin, Lancaster University.
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class admin_setting_manageantiviruses extends admin_setting {
@@ -6529,10 +6530,11 @@ public function get_defaultsetting() {
     /**
      * Always returns '', does not write anything
      *
+     * @param string $data Unused
      * @return string Always returns ''
      */
     public function write_setting($data) {
-    // do not write any setting
+        // Do not write any setting.
         return '';
     }
 
@@ -6547,8 +6549,8 @@ public function is_related($query) {
             return true;
         }
 
-        $antiviruses_available = antiviruses_get_available();
-        foreach ($antiviruses_available as $antivirus=>$antivirusstr) {
+        $antivirusesavailable = antiviruses_get_available();
+        foreach ($antivirusesavailable as $antivirus => $antivirusstr) {
             if (strpos($antivirus, $query) !== false) {
                 return true;
             }
@@ -6569,27 +6571,27 @@ public function is_related($query) {
     public function output_html($data, $query='') {
         global $CFG, $OUTPUT;
 
-        // display strings
+        // Display strings.
         $txt = get_strings(array('administration', 'settings', 'edit', 'name', 'enable', 'disable',
             'up', 'down', 'none'));
         $struninstall = get_string('uninstallplugin', 'core_admin');
 
         $txt->updown = "$txt->up/$txt->down";
 
-        $antiviruses_available = antiviruses_get_available();
-        $active_antiviruses = explode(',', $CFG->antiviruses);
+        $antivirusesavailable = antiviruses_get_available();
+        $activeantiviruses = explode(',', $CFG->antiviruses);
 
-        $active_antiviruses = array_reverse($active_antiviruses);
-        foreach ($active_antiviruses as $key=>$antivirus) {
-            if (empty($antiviruses_available[$antivirus])) {
-                unset($active_antiviruses[$key]);
+        $activeantiviruses = array_reverse($activeantiviruses);
+        foreach ($activeantiviruses as $key => $antivirus) {
+            if (empty($antivirusesavailable[$antivirus])) {
+                unset($activeantiviruses[$key]);
             } else {
-                $name = $antiviruses_available[$antivirus];
-                unset($antiviruses_available[$antivirus]);
-                $antiviruses_available[$antivirus] = $name;
+                $name = $antivirusesavailable[$antivirus];
+                unset($antivirusesavailable[$antivirus]);
+                $antivirusesavailable[$antivirus] = $name;
             }
         }
-        $antiviruses_available = array_reverse($antiviruses_available, true);
+        $antivirusesavailable = array_reverse($antivirusesavailable, true);
         $return = $OUTPUT->heading(get_string('actantivirushdr', 'antivirus'), 3, 'main', true);
         $return .= $OUTPUT->box_start('generalbox antivirusesui');
 
@@ -6600,50 +6602,47 @@ public function output_html($data, $query='') {
         $table->attributes['class'] = 'admintable generaltable';
         $table->data  = array();
 
-        // iterate through auth plugins and add to the display table
+        // Iterate through auth plugins and add to the display table.
         $updowncount = 1;
-        $antiviruscount = count($active_antiviruses);
+        $antiviruscount = count($activeantiviruses);
         $url = "antiviruses.php?sesskey=" . sesskey();
-        foreach ($antiviruses_available as $antivirus => $name) {
-        // hide/show link
+        foreach ($antivirusesavailable as $antivirus => $name) {
+            // Hide/show link.
             $class = '';
-            if (in_array($antivirus, $active_antiviruses)) {
+            if (in_array($antivirus, $activeantiviruses)) {
                 $hideshow = "<a href=\"$url&amp;action=disable&amp;antivirus=$antivirus\">";
                 $hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/hide') . "\" class=\"iconsmall\" alt=\"disable\" /></a>";
                 $enabled = true;
                 $displayname = $name;
-            }
-            else {
+            } else {
                 $hideshow = "<a href=\"$url&amp;action=enable&amp;antivirus=$antivirus\">";
                 $hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/show') . "\" class=\"iconsmall\" alt=\"enable\" /></a>";
                 $enabled = false;
                 $displayname = $name;
                 $class = 'dimmed_text';
             }
 
-            // up/down link (only if auth is enabled)
+            // Up/down link (only if auth is enabled).
             $updown = '';
             if ($enabled) {
                 if ($updowncount > 1) {
                     $updown .= "<a href=\"$url&amp;action=up&amp;antivirus=$antivirus\">";
                     $updown .= "<img src=\"" . $OUTPUT->pix_url('t/up') . "\" alt=\"up\" class=\"iconsmall\" /></a>&nbsp;";
-                }
-                else {
+                } else {
                     $updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" />&nbsp;";
                 }
                 if ($updowncount < $antiviruscount) {
                     $updown .= "<a href=\"$url&amp;action=down&amp;antivirus=$antivirus\">";
                     $updown .= "<img src=\"" . $OUTPUT->pix_url('t/down') . "\" alt=\"down\" class=\"iconsmall\" /></a>";
-                }
-                else {
+                } else {
                     $updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" />";
                 }
                 ++ $updowncount;
             }
 
-            // settings link
+            // Settings link.
             if (file_exists($CFG->dirroot.'/lib/antivirus/'.$antivirus.'/settings.php')) {
-                $eurl = new moodle_url('/admin/settings.php', array('section'=>'antivirussettings'.$antivirus));
+                $eurl = new moodle_url('/admin/settings.php', array('section' => 'antivirussettings'.$antivirus));
                 $settings = "<a href='$eurl'>{$txt->settings}</a>";
             } else {
                 $settings = '';

diff --git a/lib/antivirus/clamav/db/upgrade.php b/lib/antivirus/clamav/db/upgrade.php
@@ -17,8 +17,7 @@
 /**
  * ClamAV antivirus plugin upgrade script.
  *
- * @package    core
- * @subpackage antivirus_clamav
+ * @package    antivirus_clamav
  * @copyright  2015 Ruslan Kabalin, Lancaster University.
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/lib/antivirus/clamav/lang/en/antivirus_clamav.php b/lib/antivirus/clamav/lang/en/antivirus_clamav.php
@@ -17,8 +17,7 @@
 /**
  * Strings for component 'antivirus_clamav', language 'en'.
  *
- * @package    core
- * @subpackage antivirus_clamav
+ * @package    antivirus_clamav
  * @copyright  2015 Ruslan Kabalin, Lancaster University.
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/lib/antivirus/clamav/lib.php b/lib/antivirus/clamav/lib.php
@@ -17,8 +17,7 @@
 /**
  * ClamAV antivirus integration.
  *
- * @package    core
- * @subpackage antivirus_clamav
+ * @package    antivirus_clamav
  * @copyright  2015 Ruslan Kabalin, Lancaster University.
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -89,17 +88,17 @@ public function scan_file($file, $filename, $deleteinfected) {
             if ($deleteinfected) {
                 unlink($file);
             }
-            throw new antivirus_exception('virusfounduser', '', array('filename'=>$filename));
+            throw new antivirus_exception('virusfounduser', '', array('filename' => $filename));
         } else {
-            //Unknown problem,
+            // Unknown problem.
             $notice = get_string('clamfailed', 'antivirus_clamav', $this->get_clam_error_code($return));
             $notice .= "\n\n". implode("\n", $output);
             $this->message_admins($notice);
             if ($this->config->clamfailureonupload === 'actlikevirus') {
                 if ($deleteinfected) {
                     unlink($file);
                 }
-                throw new antivirus_exception('virusfounduser', '', array('filename'=>$filename));
+                throw new antivirus_exception('virusfounduser', '', array('filename' => $filename));
             } else {
                 return;
             }
@@ -112,12 +111,12 @@ public function scan_file($file, $filename, $deleteinfected) {
      * @param int $returncode The numeric error code in question.
      * @return string The definition of the error code
      */
-    function get_clam_error_code($returncode) {
+    private function get_clam_error_code($returncode) {
         $returncodes = array();
         $returncodes[0] = 'No virus found.';
         $returncodes[1] = 'Virus(es) found.';
-        $returncodes[2] = ' An error occured'; // specific to clamdscan
-        // all after here are specific to clamscan
+        $returncodes[2] = ' An error occured'; // Specific to clamdscan.
+        // All after here are specific to clamscan.
         $returncodes[40] = 'Unknown option passed.';
         $returncodes[50] = 'Database initialization error.';
         $returncodes[52] = 'Not supported file type.';

diff --git a/lib/antivirus/clamav/settings.php b/lib/antivirus/clamav/settings.php
@@ -17,8 +17,7 @@
 /**
  * ClamAV admin settings.
  *
- * @package    core
- * @subpackage antivirus_clamav
+ * @package    antivirus_clamav
  * @copyright  2015 Ruslan Kabalin, Lancaster University.
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -30,7 +29,11 @@
             new lang_string('pathtoclam', 'antivirus_clamav'), new lang_string('configpathtoclam', 'antivirus_clamav'), ''));
     $settings->add(new admin_setting_configdirectory('antivirus_clamav/quarantinedir',
             new lang_string('quarantinedir', 'antivirus_clamav'), new lang_string('configquarantinedir', 'antivirus_clamav'), ''));
-    $options = array('donothing' => new lang_string('configclamdonothing', 'antivirus_clamav'), 'actlikevirus' => new lang_string('configclamactlikevirus', 'antivirus_clamav'));
+    $options = array(
+        'donothing' => new lang_string('configclamdonothing', 'antivirus_clamav'),
+        'actlikevirus' => new lang_string('configclamactlikevirus', 'antivirus_clamav'),
+    );
     $settings->add(new admin_setting_configselect('antivirus_clamav/clamfailureonupload',
-            new lang_string('clamfailureonupload', 'antivirus_clamav'), new lang_string('configclamfailureonupload', 'antivirus_clamav'), 'donothing', $options));
+            new lang_string('clamfailureonupload', 'antivirus_clamav'),
+            new lang_string('configclamfailureonupload', 'antivirus_clamav'), 'donothing', $options));
 }
diff --git a/lib/antivirus/clamav/version.php b/lib/antivirus/clamav/version.php
@@ -17,8 +17,7 @@
 /**
  * ClamAV antivirus version file.
  *
- * @package    core
- * @subpackage antivirus_clamav
+ * @package    antivirus_clamav
  * @copyright  2015 Ruslan Kabalin, Lancaster University.
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/lib/antiviruslib.php b/lib/antiviruslib.php
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -38,7 +37,7 @@ function antiviruses_get_enabled() {
         return $active;
     }
 
-    foreach(explode(',', $CFG->antiviruses) as $e) {
+    foreach (explode(',', $CFG->antiviruses) as $e) {
         if ($antivirus = antiviruses_get_antivirus($e)) {
             if ($antivirus->is_configured()) {
                 $active[$e] = $antivirus;
@@ -184,7 +183,7 @@ class antivirus_exception extends moodle_exception {
      * @param mixed $a
      * @param mixed $debuginfo
      */
-    public function __construct($errorcode, $link = '', $a=NULL, $debuginfo=null) {
+    public function __construct($errorcode, $link = '', $a = null, $debuginfo = null) {
         parent::__construct($errorcode, 'antivirus', $link, $a, $debuginfo);
     }
 }