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.

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

Contains notification_list_processor class for displaying on message preferences page.

Copyright: 2016 Ryan Wyllie <ryan@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 170 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

notification_list_processor:: (4 methods):
  __construct()
  get_preference_base()
  is_preference_enabled()
  export_for_template()


Class: notification_list_processor  - X-Ref

Class to create context for a notification component on the message preferences page.

__construct($processor, $provider, $preferences)   X-Ref
Constructor.

param: \stdClass $processor
param: \stdClass $provider
param: \stdClass $preferences

get_preference_base()   X-Ref
Get the base key prefix for the given provider.

return: string

is_preference_enabled($name, $locked)   X-Ref
Check if the given preference is enabled or not.

return: bool
param: string $name preference name
param: string $locked Wether the preference is locked by admin.

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
param: renderer_base $output