Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Events tests.
 *
 * @package    mod_chat
 * @copyright  2013 Frédéric Massart
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace mod_chat\event;

defined('MOODLE_INTERNAL') || die();

global $CFG;
require_once($CFG->dirroot . '/mod/chat/lib.php');

/**
 * Events tests class.
 *
 * @package    mod_chat
 * @copyright  2013 Frédéric Massart
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class events_test extends \advanced_testcase {

    public function test_message_sent() {
        global $DB;
        $this->resetAfterTest();

        $this->setAdminUser();
        $course = $this->getDataGenerator()->create_course();
        $user1 = $this->getDataGenerator()->create_user();
        $user2 = $this->getDataGenerator()->create_user();
        $chat = $this->getDataGenerator()->create_module('chat', array('course' => $course->id));
        $cm = $DB->get_record('course_modules', array('id' => $chat->cmid));

        // Logging in first user to the chat.
        $this->setUser($user1->id);
        $sid1 = chat_login_user($chat->id, 'ajax', 0, $course);

        // Logging in second user to the chat.
        $this->setUser($user2->id);
        $sid2 = chat_login_user($chat->id, 'ajax', 0, $course);

        // Getting the chatuser record.
        $chatuser1 = $DB->get_record('chat_users', array('sid' => $sid1));
        $chatuser2 = $DB->get_record('chat_users', array('sid' => $sid2));

        $sink = $this->redirectEvents();

        // Send a messaging from the first user. We pass the CM to chat_send_chatmessage() this time.
        // This ensures that the event triggered when sending a message is filled with the correct information.
        $this->setUser($user1->id);
        $messageid = chat_send_chatmessage($chatuser1, 'Hello!', false, $cm);
        $events = $sink->get_events();
        $this->assertCount(1, $events);
        $event = reset($events);
        $this->assertInstanceOf('\mod_chat\event\message_sent', $event);
        $this->assertEquals($messageid, $event->objectid);
        $this->assertEquals($user1->id, $event->relateduserid);
        $this->assertEquals($user1->id, $event->userid);
< $expected = array($course->id, 'chat', 'talk', "view.php?id=$cm->id", $chat->id, $cm->id, $user1->id); < $this->assertEventLegacyLogData($expected, $event);
// Send a messaging from the first user. We DO NOT pass the CM to chat_send_chatmessage() this time. // This ensures that the event triggered when sending a message is filled with the correct information. $sink->clear(); $this->setUser($user2->id); $messageid = chat_send_chatmessage($chatuser2, 'Hello!'); $events = $sink->get_events(); $this->assertCount(1, $events); $event = reset($events); $this->assertInstanceOf('\mod_chat\event\message_sent', $event); $this->assertEquals($messageid, $event->objectid); $this->assertEquals($user2->id, $event->relateduserid); $this->assertEquals($user2->id, $event->userid);
< $expected = array($course->id, 'chat', 'talk', "view.php?id=$cm->id", $chat->id, $cm->id, $user2->id); < $this->assertEventLegacyLogData($expected, $event); < $this->assertEventContextNotUsed($event);
// Sending a message from the system should not trigger any event. $sink->clear(); $this->setAdminUser(); chat_send_chatmessage($chatuser1, 'enter', true); $this->assertEquals(0, $sink->count()); $sink->close(); } public function test_sessions_viewed() { global $USER; $this->resetAfterTest(); // Not much can be tested here as the event is only triggered on a page load, // let's just check that the event contains the expected basic information. $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(); $chat = $this->getDataGenerator()->create_module('chat', array('course' => $course->id)); $params = array( 'context' => \context_module::instance($chat->cmid), 'objectid' => $chat->id, 'other' => array( 'start' => 1234, 'end' => 5678 ) ); $event = \mod_chat\event\sessions_viewed::create($params); $event->add_record_snapshot('chat', $chat); $sink = $this->redirectEvents(); $event->trigger(); $events = $sink->get_events(); $event = reset($events); $this->assertInstanceOf('\mod_chat\event\sessions_viewed', $event); $this->assertEquals($USER->id, $event->userid); $this->assertEquals(\context_module::instance($chat->cmid), $event->get_context()); $this->assertEquals(1234, $event->other['start']); $this->assertEquals(5678, $event->other['end']); $this->assertEquals($chat->id, $event->objectid); $this->assertEquals($chat, $event->get_record_snapshot('chat', $chat->id));
< $expected = array($course->id, 'chat', 'report', "report.php?id=$chat->cmid", $chat->id, $chat->cmid); < $this->assertEventLegacyLogData($expected, $event); < $this->assertEventContextNotUsed($event);
} public function test_course_module_instance_list_viewed() { global $USER; $this->resetAfterTest(); // Not much can be tested here as the event is only triggered on a page load, // let's just check that the event contains the expected basic information. $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(); $params = array( 'context' => \context_course::instance($course->id) ); $event = \mod_chat\event\course_module_instance_list_viewed::create($params); $sink = $this->redirectEvents(); $event->trigger(); $events = $sink->get_events(); $event = reset($events); $this->assertInstanceOf('\mod_chat\event\course_module_instance_list_viewed', $event); $this->assertEquals($USER->id, $event->userid); $this->assertEquals(\context_course::instance($course->id), $event->get_context());
< $expected = array($course->id, 'chat', 'view all', "index.php?id=$course->id", ''); < $this->assertEventLegacyLogData($expected, $event); < $this->assertEventContextNotUsed($event);
} public function test_course_module_viewed() { $this->resetAfterTest(); $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(); $chat = $this->getDataGenerator()->create_module('chat', array('course' => $course->id)); $cm = get_coursemodule_from_instance('chat', $chat->id); $context = \context_module::instance($cm->id); $params = array( 'objectid' => $chat->id, 'context' => $context ); $event = \mod_chat\event\course_module_viewed::create($params); $event->add_record_snapshot('chat', $chat); $event->trigger();
< $expected = array($course->id, 'chat', 'view', "view.php?id=$cm->id", $chat->id, $cm->id); < $this->assertEventLegacyLogData($expected, $event); < $this->assertEventContextNotUsed($event);
$url = new \moodle_url('/mod/chat/view.php', array('id' => $cm->id)); $this->assertEquals($url, $event->get_url()); $event->get_name(); } }