Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
   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   * Train system models with new data available.
  19   *
  20   * @package    tool_analytics
  21   * @copyright  2017 David Monllao {@link http://www.davidmonllao.com}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace tool_analytics\task;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Train system models with new data available.
  31   *
  32   * @package    tool_analytics
  33   * @copyright  2017 David Monllao {@link http://www.davidmonllao.com}
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class train_models extends \core\task\scheduled_task {
  37  
  38      /**
  39       * get_name
  40       *
  41       * @return string
  42       */
  43      public function get_name() {
  44          return get_string('trainmodels', 'tool_analytics');
  45      }
  46  
  47      /**
  48       * Executes the prediction task.
  49       *
  50       * @return void
  51       */
  52      public function execute() {
  53          global $OUTPUT, $PAGE;
  54  
  55          if (!\core_analytics\manager::is_analytics_enabled()) {
  56              mtrace(get_string('analyticsdisabled', 'analytics'));
  57              return;
  58          }
  59  
  60          $models = \core_analytics\manager::get_all_models(true);
  61          if (!$models) {
  62              mtrace(get_string('errornoenabledmodels', 'tool_analytics'));
  63              return;
  64          }
  65  
  66          foreach ($models as $model) {
  67  
  68              if ($model->is_static()) {
  69                  // Skip models based on assumptions.
  70                  continue;
  71              }
  72  
  73              if (!$model->get_time_splitting()) {
  74                  // Can not train if there is no time splitting method selected.
  75                  continue;
  76              }
  77  
  78              $renderer = $PAGE->get_renderer('tool_analytics');
  79  
  80              $result = $model->train();
  81  
  82              // Reset the page as some indicators may call external functions that overwrite the page context.
  83              \tool_analytics\output\helper::reset_page();
  84  
  85              if ($result) {
  86                  echo $OUTPUT->heading(get_string('modelresults', 'tool_analytics', $model->get_name()));
  87                  echo $renderer->render_get_predictions_results($result, $model->get_analyser()->get_logs());
  88              }
  89          }
  90      }
  91  }