Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Differences Between: [Versions 311 and 403] [Versions 400 and 403] [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   * Tests for report log events.
  19   *
  20   * @package    report_log
  21   * @copyright  2014 Rajesh Taneja <rajesh@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  23   */
  24  
  25  namespace report_log\event;
  26  
  27  /**
  28   * Class report_log_events_testcase
  29   *
  30   * Class for tests related to log events.
  31   *
  32   * @package    report_log
  33   * @copyright  2014 Rajesh Taneja <rajesh@moodle.com>
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  35   */
  36  class events_test extends \advanced_testcase {
  37  
  38      /**
  39       * Setup testcase.
  40       */
  41      public function setUp(): void {
  42          $this->setAdminUser();
  43          $this->resetAfterTest();
  44      }
  45  
  46      /**
  47       * Test the report viewed event.
  48       *
  49       * It's not possible to use the moodle API to simulate the viewing of log report, so here we
  50       * simply create the event and trigger it.
  51       */
  52      public function test_report_viewed() {
  53          $course = $this->getDataGenerator()->create_course();
  54          $context = \context_course::instance($course->id);
  55  
  56          // Trigger event for log report viewed.
  57          $event = \report_log\event\report_viewed::create(array('context' => $context,
  58                  'relateduserid' => 0, 'other' => array('groupid' => 0, 'date' => 0, 'modid' => 0, 'modaction' => '',
  59                  'logformat' => 'showashtml')));
  60  
  61          // Trigger and capture the event.
  62          $sink = $this->redirectEvents();
  63          $event->trigger();
  64          $events = $sink->get_events();
  65          $event = reset($events);
  66  
  67          $this->assertInstanceOf('\report_log\event\report_viewed', $event);
  68          $this->assertEquals($context, $event->get_context());
  69          $this->assertEventContextNotUsed($event);
  70          $url = new \moodle_url('/report/log/index.php', array('id' => $event->courseid));
  71          $this->assertEquals($url, $event->get_url());
  72      }
  73  
  74      /**
  75       * Test the user report viewed event.
  76       *
  77       * It's not possible to use the moodle API to simulate the viewing of user log report, so here we
  78       * simply create the event and trigger it.
  79       */
  80      public function test_user_report_viewed() {
  81          $user = $this->getDataGenerator()->create_user();
  82          $course = $this->getDataGenerator()->create_course();
  83          $context = \context_course::instance($course->id);
  84  
  85          // Trigger event for user report viewed.
  86          $event = \report_log\event\user_report_viewed::create(array('context' => $context,
  87                  'relateduserid' => $user->id, 'other' => array('mode' => 'today')));
  88  
  89          // Trigger and capture the event.
  90          $sink = $this->redirectEvents();
  91          $event->trigger();
  92          $events = $sink->get_events();
  93          $event = reset($events);
  94  
  95          $this->assertInstanceOf('\report_log\event\user_report_viewed', $event);
  96          $this->assertEquals($context, $event->get_context());
  97          $this->assertEventContextNotUsed($event);
  98          $url = new \moodle_url('/report/log/user.php', array('course' => $course->id, 'id' => $user->id, 'mode' => 'today'));
  99          $this->assertEquals($url, $event->get_url());
 100      }
 101  }