Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [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   * mod_lti data generator
  19   *
  20   * @package    mod_lti
  21   * @category   test
  22   * @copyright  Copyright (c) 2012 Moodlerooms Inc. (http://www.moodlerooms.com)
  23   * @author     Mark Nielsen
  24   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  global $CFG;
  30  require_once($CFG->dirroot . '/mod/lti/locallib.php');
  31  
  32  /**
  33   * LTI module data generator class
  34   *
  35   * @package    mod_lti
  36   * @category   test
  37   * @copyright  Copyright (c) 2012 Moodlerooms Inc. (http://www.moodlerooms.com)
  38   * @author     Mark Nielsen
  39   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class mod_lti_generator extends testing_module_generator {
  42  
  43      public function create_instance($record = null, array $options = null) {
  44          $record  = (object) (array) $record;
  45  
  46          if (!isset($record->toolurl)) {
  47              $record->toolurl = '';
  48          } else {
  49              $toolurl = new moodle_url($record->toolurl);
  50              $record->toolurl = $toolurl->out(false);
  51          }
  52          if (!isset($record->resourcekey)) {
  53              $record->resourcekey = '12345';
  54          }
  55          if (!isset($record->password)) {
  56              $record->password = 'secret';
  57          }
  58          if (!isset($record->grade)) {
  59              $record->grade = 100;
  60          }
  61          if (!isset($record->instructorchoicesendname)) {
  62              $record->instructorchoicesendname = 1;
  63          }
  64          if (!isset($record->instructorchoicesendemailaddr)) {
  65              $record->instructorchoicesendemailaddr = 1;
  66          }
  67          if (!isset($record->instructorchoiceacceptgrades)) {
  68              $record->instructorchoiceacceptgrades = 1;
  69          }
  70          if (!isset($record->typeid)) {
  71              $record->typeid = null;
  72          }
  73          return parent::create_instance($record, (array)$options);
  74      }
  75  
  76      /**
  77       * Create a tool proxy.
  78       *
  79       * @param array $config
  80       */
  81      public function create_tool_proxies(array $config) {
  82          if (!isset($config['capabilityoffered'])) {
  83              $config['capabilityoffered'] = '';
  84          }
  85          if (!isset($config['serviceoffered'])) {
  86              $config['serviceoffered'] = '';
  87          }
  88          lti_add_tool_proxy((object) $config);
  89      }
  90  
  91      /**
  92       * Create a tool type.
  93       *
  94       * @param array $type
  95       * @param array|null $config
  96       */
  97      public function create_tool_types(array $type, ?array $config = null) {
  98          if (!isset($type['baseurl'])) {
  99              throw new coding_exception('Must specify baseurl when creating a LTI tool type.');
 100          }
 101          lti_add_type((object) $type, (object) $config);
 102      }
 103  }