[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_book.
  19   *
  20   * @package   mod_book
  21   * @category  test
  22   * @copyright 2021 Andrew Lyons <andrew@nicols.co.uk>
  23   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  /**
  27   * Behat data generator for mod_book.
  28   *
  29   * @copyright 2019 The Open University
  30   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31   */
  32  class behat_mod_book_generator extends behat_generator_base {
  33  
  34      protected function get_creatable_entities(): array {
  35          return [
  36              'chapters' => [
  37                  'singular' => 'chapter',
  38                  'datagenerator' => 'chapter',
  39                  'required' => ['book', 'title', 'content'],
  40                  'switchids' => ['book' => 'bookid'],
  41              ],
  42          ];
  43      }
  44  
  45      /**
  46       * Look up the id of a book from its name.
  47       *
  48       * @param string $bookname the book name, for example 'Test book'.
  49       * @return int corresponding id.
  50       */
  51      protected function get_book_id(string $bookname): int {
  52          global $DB;
  53  
  54          $cm = $this->get_cm_by_activity_name('book', $bookname);
  55  
  56          return $cm->instance;
  57      }
  58  }