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.
<?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/>.

/**
 * Base trait for message popup tests.
 *
 * @package    message_popup
 * @copyright  2016 Ryan Wyllie <ryan@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

> use \core_message\tests\helper as testhelper; trait message_popup_test_helper { >
/**
>
* Send a fake unread popup notification. * * {@link message_send()} does not support transaction, this function will simulate a message * sent from a user to another. We should stop using it once {@link message_send()} will support * transactions. This is not clean at all, this is just used to add rows to the table. * * @param stdClass $userfrom user object of the one sending the message. * @param stdClass $userto user object of the one receiving the message. * @param string $message message to send. * @param int $timecreated time the message was created. * @return int the id of the message */
< protected function send_fake_unread_popup_notification($userfrom, $userto, $message = 'Hello world!', $timecreated = 0) {
> protected function send_fake_unread_popup_notification(\stdClass $userfrom, \stdClass $userto, > string $message = 'Hello world!', int $timecreated = 0): int {
global $DB;
< $record = new stdClass(); < $record->useridfrom = $userfrom->id; < $record->useridto = $userto->id; < $record->notification = 1; < $record->subject = 'No subject'; < $record->fullmessage = $message; < $record->smallmessage = $message; < $record->timecreated = $timecreated ? $timecreated : time(); < $record->customdata = json_encode(['datakey' => 'data']); < < $id = $DB->insert_record('notifications', $record);
> $id = testhelper::send_fake_unread_notification($userfrom, $userto, $message, $timecreated);
$popup = new stdClass(); $popup->notificationid = $id; $DB->insert_record('message_popup_notifications', $popup); return $id; } /** * Send a fake read popup notification. * * {@link message_send()} does not support transaction, this function will simulate a message * sent from a user to another. We should stop using it once {@link message_send()} will support * transactions. This is not clean at all, this is just used to add rows to the table. * * @param stdClass $userfrom user object of the one sending the message. * @param stdClass $userto user object of the one receiving the message. * @param string $message message to send. * @param int $timecreated time the message was created. * @param int $timeread the the message was read * @return int the id of the message */
< protected function send_fake_read_popup_notification($userfrom, $userto, $message = 'Hello world!', < $timecreated = 0, $timeread = 0) {
> protected function send_fake_read_popup_notification(\stdClass $userfrom, \stdClass $userto, string $message = 'Hello world!', > int $timecreated = 0, int $timeread = 0): int {
global $DB;
< $record = new stdClass(); < $record->useridfrom = $userfrom->id; < $record->useridto = $userto->id; < $record->notification = 1; < $record->subject = 'No subject'; < $record->fullmessage = $message; < $record->smallmessage = $message; < $record->timecreated = $timecreated ? $timecreated : time(); < $record->timeread = $timeread ? $timeread : time(); < < $record->id = $DB->insert_record('notifications', $record); < < // Mark it as read. < \core_message\api::mark_notification_as_read($record);
> $id = testhelper::send_fake_read_notification($userfrom, $userto, $message, $timecreated, $timeread);
$popup = new stdClass();
< $popup->notificationid = $record->id;
> $popup->notificationid = $id;
$DB->insert_record('message_popup_notifications', $popup);
< return $record->id;
> return $id;
} }