mod/book/tests/helper_test.php

   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 namespace mod_book;
  17 /**
  18  * Helper test class
  19  *
  20  * @package    mod_book
  21  * @copyright  2023 Laurent David <laurent.david@moodle.com>
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24 class helper_test extends \advanced_testcase {
  25
  26     /**
  27      * Test view_book
  28      * @covers \mod_book\helper::is_last_visible_chapter
  29      */
  30     public function test_is_last_chapter(): void {
  31         $this->resetAfterTest(true);
  32
  33         $this->setAdminUser();
  34         // Setup test data.
  35         $course = $this->getDataGenerator()->create_course();
  36         $book = $this->getDataGenerator()->create_module('book', array('course' => $course->id));
  37         $bookgenerator = $this->getDataGenerator()->get_plugin_generator('mod_book');
  38         $firstchapter =
  39             $bookgenerator->create_chapter(array('bookid' => $book->id, 'pagenum' => 1)); // Create a first chapter to check that
  40         // viewing the last chapter is enough for completing the activity.
  41         $chapterhidden = $bookgenerator->create_chapter(array('bookid' => $book->id, 'hidden' => 1, 'pagenum' => 2));
  42         $lastchapter = $bookgenerator->create_chapter(array('bookid' => $book->id, 'pagenum' => 3));
  43         $chapters = book_preload_chapters($book);
  44         $this->assertFalse(helper::is_last_visible_chapter($firstchapter->id, $chapters));
  45         $this->assertFalse(helper::is_last_visible_chapter($chapterhidden->id, $chapters));
  46         $this->assertTrue(helper::is_last_visible_chapter($lastchapter->id, $chapters));
  47     }
  48 }