Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Differences Between: [Versions 311 and 402] [Versions 311 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   * Events tests.
  19   *
  20   * @package    booktool_print
  21   * @category   phpunit
  22   * @copyright  2013 Frédéric Massart
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace booktool_print\event;
  27  
  28  /**
  29   * Events tests class.
  30   *
  31   * @package    booktool_print
  32   * @category   phpunit
  33   * @copyright  2013 Frédéric Massart
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class events_test extends \advanced_testcase {
  37  
  38      public function setUp(): void {
  39          $this->resetAfterTest();
  40      }
  41  
  42      public function test_book_printed() {
  43          // There is no proper API to call to test the event, so what we are
  44          // doing here is simply making sure that the events returns the right information.
  45  
  46          $course = $this->getDataGenerator()->create_course();
  47          $book = $this->getDataGenerator()->create_module('book', array('course' => $course->id));
  48          $context = \context_module::instance($book->cmid);
  49  
  50          $event = \booktool_print\event\book_printed::create_from_book($book, $context);
  51  
  52          // Triggering and capturing the event.
  53          $sink = $this->redirectEvents();
  54          $event->trigger();
  55          $events = $sink->get_events();
  56          $this->assertCount(1, $events);
  57          $event = reset($events);
  58  
  59          // Checking that the event contains the expected values.
  60          $this->assertInstanceOf('\booktool_print\event\book_printed', $event);
  61          $this->assertEquals(\context_module::instance($book->cmid), $event->get_context());
  62          $this->assertEquals($book->id, $event->objectid);
  63          $expected = array($course->id, 'book',  'print', 'tool/print/index.php?id=' . $book->cmid, $book->id, $book->cmid);
  64          $this->assertEventLegacyLogData($expected, $event);
  65          $this->assertEventContextNotUsed($event);
  66      }
  67  
  68  
  69      public function test_chapter_printed() {
  70          // There is no proper API to call to test the event, so what we are
  71          // doing here is simply making sure that the events returns the right information.
  72  
  73          $course = $this->getDataGenerator()->create_course();
  74          $book = $this->getDataGenerator()->create_module('book', array('course' => $course->id));
  75          $bookgenerator = $this->getDataGenerator()->get_plugin_generator('mod_book');
  76          $chapter = $bookgenerator->create_chapter(array('bookid' => $book->id));
  77          $context = \context_module::instance($book->cmid);
  78  
  79          $event = \booktool_print\event\chapter_printed::create_from_chapter($book, $context, $chapter);
  80  
  81          // Triggering and capturing the event.
  82          $sink = $this->redirectEvents();
  83          $event->trigger();
  84          $events = $sink->get_events();
  85          $this->assertCount(1, $events);
  86          $event = reset($events);
  87  
  88          // Checking that the event contains the expected values.
  89          $this->assertInstanceOf('\booktool_print\event\chapter_printed', $event);
  90          $this->assertEquals(\context_module::instance($book->cmid), $event->get_context());
  91          $this->assertEquals($chapter->id, $event->objectid);
  92          $expected = array($course->id, 'book', 'print chapter', 'tool/print/index.php?id=' . $book->cmid .
  93              '&chapterid=' . $chapter->id, $chapter->id, $book->cmid);
  94          $this->assertEventLegacyLogData($expected, $event);
  95          $this->assertEventContextNotUsed($event);
  96      }
  97  
  98  }