[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   * Behat data generator for mod_lesson.
  19   *
  20   * @package   mod_lesson
  21   * @category  test
  22   * @copyright 2023 Dani Palou <dani@moodle.com>
  23   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  /**
  27   * Behat data generator for mod_lesson.
  28   *
  29   * @copyright 2023 Dani Palou <dani@nmoodle.com>
  30   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31   */
  32  class behat_mod_lesson_generator extends behat_generator_base {
  33  
  34      /**
  35       * Get a list of the entities that can be created.
  36       *
  37       * @return array entity name => information about how to generate.
  38       */
  39      protected function get_creatable_entities(): array {
  40          return [
  41              'pages' => [
  42                  'singular' => 'page',
  43                  'datagenerator' => 'page',
  44                  'required' => ['lesson', 'qtype'],
  45                  'switchids' => ['lesson' => 'lessonid'],
  46              ],
  47              'answers' => [
  48                  'singular' => 'answer',
  49                  'datagenerator' => 'answer',
  50                  'required' => ['page'],
  51              ],
  52          ];
  53      }
  54  
  55      /**
  56       * Look up the id of a lesson from its name.
  57       *
  58       * @param string $idnumberorname the lesson idnumber or name, for example 'Test lesson'.
  59       * @return int corresponding id.
  60       */
  61      protected function get_lesson_id(string $idnumberorname): int {
  62          return $this->get_cm_by_activity_name('lesson', $idnumberorname)->instance;
  63      }
  64  
  65  }