[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * DB schema performance check
  19   *
  20   * @package    core
  21   * @category   check
  22   * @copyright  2021 Brendan Heywood <brendan@catalyst-au.net>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace core\check\performance;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  use core\check\check;
  31  use core\check\result;
  32  
  33  /**
  34   * DB schema performance check
  35   *
  36   * @copyright  2021 Brendan Heywood <brendan@catalyst-au.net>
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  class dbschema extends check {
  40  
  41      /**
  42       * Get the short check name
  43       *
  44       * @return string
  45       */
  46      public function get_name(): string {
  47          return get_string('check_dbschema_name', 'report_performance');
  48      }
  49  
  50      /**
  51       * A link to a place to action this
  52       *
  53       * @return action_link|null
  54       */
  55      public function get_action_link(): ?\action_link {
  56          return new \action_link(
  57              new \moodle_url(\get_docs_url('Verify_Database_Schema')),
  58              get_string('moodledocs'));
  59      }
  60  
  61      /**
  62       * Return result
  63       * @return result
  64       */
  65      public function get_result(): result {
  66          global $DB;
  67  
  68          $dbmanager = $DB->get_manager();
  69          $schema = $dbmanager->get_install_xml_schema();
  70  
  71          if (!$errors = $dbmanager->check_database_schema($schema)) {
  72              return new result(result::OK, get_string('check_dbschema_ok', 'report_performance'), '');
  73          }
  74  
  75          $details = '';
  76          foreach ($errors as $tablename => $items) {
  77              $details .= \html_writer::tag('h4', $tablename);
  78              foreach ($items as $item) {
  79                  $details .= \html_writer::tag('pre', $item);
  80              }
  81          }
  82          return new result(result::ERROR, get_string('check_dbschema_errors', 'report_performance'), $details);
  83      }
  84  }
  85