Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/message/classes/tests/ -> helper.php (source)

[Source view]

Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400]

Contains a helper class providing util methods for testing.

Copyright: 2018 Jake Dallimore <markn@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 127 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

helper:: (3 methods):
  send_fake_message_to_conversation()
  send_fake_unread_notification()
  send_fake_read_notification()


Class: helper  - X-Ref

The helper class providing util methods for testing.

send_fake_message_to_conversation(\stdClass $userfrom, int $convid, string $message = 'Hello world!',int $time = null)   X-Ref
Sends a message to a conversation.

return: int the id of the message which was sent.
param: \stdClass $userfrom user object of the one sending the message.
param: int $convid id of the conversation in which we'll send the message.
param: string $message message to send.
param: int $time the time the message was sent.

send_fake_unread_notification(\stdClass $userfrom, \stdClass $userto, string $message = 'Hello world!',int $timecreated = 0)   X-Ref
Send a fake unread notification.

message_send() does not support transaction, this function will simulate a message
sent from a user to another. We should stop using it once message_send() will support
transactions. This is not clean at all, this is just used to add rows to the table.

return: int the id of the message
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.

send_fake_read_notification(\stdClass $userfrom, \stdClass $userto, string $message = 'Hello world!',int $timecreated = 0, int $timeread = 0)   X-Ref
Send a fake read notification.

message_send() does not support transaction, this function will simulate a message
sent from a user to another. We should stop using it once message_send() will support
transactions. This is not clean at all, this is just used to add rows to the table.

return: int the id of the message
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