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.

Group message sent event.

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

Defines 1 class

group_message_sent:: (8 methods):
  create_from_ids()
  init()
  get_name()
  get_url()
  get_description()
  validate_data()
  get_objectid_mapping()
  get_other_mapping()


Class: group_message_sent  - X-Ref

Group message sent event class.

create_from_ids(int $userfromid, int $conversationid, int $messageid, int $courseid)   X-Ref
Create event using ids.

param: int $userfromid
param: int $conversationid
param: int $messageid
param: int $courseid course id the event is related with.
return: message_sent

init()   X-Ref
Init method.


get_name()   X-Ref
Returns localised general event name.

return: string

get_url()   X-Ref
Returns relevant URL.

return: \moodle_url

get_description()   X-Ref
Returns description of what happened.

return: string

validate_data()   X-Ref
Custom validation.

return: void

get_objectid_mapping()   X-Ref
Get the object this event maps to.

return: array|string object id mapping.

get_other_mapping()   X-Ref
Get the item mappings for the 'other' fields for this event.

return: array the array of other fields, mapped.