[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   * Completion test generator
  19   *
  20   * @package     core_completion
  21   * @copyright   2023 Amaia Anabitarte <amaia@moodle.com>
  22   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  class core_completion_generator extends component_generator_base {
  25  
  26      /**
  27       * Create default completion
  28       *
  29       * @param array|stdClass $record
  30       * @return stdClass
  31       */
  32      public function create_default_completion($record): stdClass {
  33          global $DB;
  34  
  35          $record = (array) $record;
  36  
  37          if (!array_key_exists('course', $record) || !is_numeric($record['course'])) {
  38              throw new moodle_exception('courserequired');
  39          }
  40          if (!$DB->get_record('course', ['id' => $record['course']])) {
  41              throw new moodle_exception('invalidcourseid');
  42          }
  43  
  44          if (!array_key_exists('module', $record) || !is_numeric($record['module'])) {
  45              throw new moodle_exception('modulerequired');
  46          }
  47          if (!$DB->get_record('modules', ['id' => $record['module']])) {
  48              throw new moodle_exception('invalidmoduleid');
  49          }
  50  
  51          $record = (object) array_merge([
  52              'completion' => 0,
  53              'completionview' => 0,
  54              'completionusegrade' => 0,
  55              'completionpassgrade' => 0,
  56              'completionexpected' => 0,
  57              'customrules' => '',
  58          ], $record);
  59          $record->id = $DB->insert_record('course_completion_defaults', $record);
  60  
  61          return $record;
  62      }
  63  }