[Summary view]

   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   * Complete plans task.
  19   *
  20   * @package    core_competency
  21   * @copyright  2015 Frédéric Massart - FMCorz.net
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\task;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  use core_competency\api;
  29  use core_competency\plan;
  30  
  31  /**
  32   * Complete plans task class.
  33   *
  34   * This task should run relatively often because the plans due dates can be set at
  35   * any time of the day in any timezone.
  36   *
  37   * @package    core_competency
  38   * @copyright  2015 Frédéric Massart - FMCorz.net
  39   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class complete_plans_task extends \core\task\scheduled_task {
  42  
  43      /**
  44       * Get a descriptive name for this task.
  45       *
  46       * @return string
  47       */
  48      public function get_name() {
  49          return get_string('completeplanstask', 'core_competency');
  50      }
  51  
  52      /**
  53       * Do the job.
  54       */
  55      public function execute() {
  56          if (!api::is_enabled()) {
  57              return;
  58          }
  59  
  60          $records = plan::get_recordset_for_due_and_incomplete();
  61          foreach ($records as $record) {
  62              $plan = new plan(0, $record);
  63              api::complete_plan($plan);
  64          }
  65          $records->close();
  66      }
  67  
  68  }