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.
/lib/classes/output/ -> notification.php (source)

[Source view]

Differences Between: [Versions 310 and 400] [Versions 39 and 400] [Versions 400 and 402] [Versions 400 and 403]

Notification renderable component.

Copyright: 2015 Jetha Chan
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 189 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

notification:: (8 methods):
  __construct()
  set_announce()
  set_show_closebutton()
  set_extra_classes()
  get_message()
  get_message_type()
  export_for_template()
  get_template_name()


Class: notification  - X-Ref

Data structure representing a notification.

__construct($message, $messagetype = null, $closebutton = true)   X-Ref
Notification constructor.

param: string $message the message to print out
param: ?string $messagetype one of the NOTIFY_* constants..
param: bool $closebutton Whether to show a close icon to remove the notification (default true).

set_announce($announce = false)   X-Ref
Set whether this notification should be announced assertively to screen readers.

return: $this
param: bool $announce

set_show_closebutton($button = false)   X-Ref
Set whether this notification should include a button to disiss itself.

return: $this
param: bool $button

set_extra_classes($classes = array()   X-Ref
Add any extra classes that this notification requires.

return: $this
param: array $classes

get_message()   X-Ref
Get the message for this notification.

return: string message

get_message_type()   X-Ref
Get the message type for this notification.

return: string message type

export_for_template(\renderer_base $output)   X-Ref
Export this data so it can be used as the context for a mustache template.

return: stdClass data context for a mustache template
param: renderer_base $output typically, the renderer that's calling this function

get_template_name()   X-Ref
No description