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.
/message/classes/output/preferences/ -> notification_list_component.php (source)

[Source view]

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

Contains notification_list_component 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: 168 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

notification_list_component:: (5 methods):
  __construct()
  get_preference_base()
  get_provider_display_name()
  should_show_preference_key()
  export_for_template()


Class: notification_list_component  - X-Ref

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

__construct($component, $processors, $providers, $preferences, $user)   X-Ref
Constructor.

param: string $component
param: array $processors
param: array $providers
param: \stdClass $preferences
param: \stdClass $user

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

param: \stdClass $provider The message provider
return: string

get_provider_display_name($provider)   X-Ref
Get the display name for the given provider.

param: \stdClass $provider The message provider
return: string

should_show_preference_key($preferencekey)   X-Ref
Determine if the preference should be displayed.

param: string $preferencekey
return: bool

export_for_template(\renderer_base $output)   X-Ref
No description