core\output\notification Class Reference

Inheritance diagram for core\output\notification:

Public Member Functions
	__construct ($message, $messagetype=null)
	Notification constructor. More...
	export_for_template (\renderer_base $output)
	Export this data so it can be used as the context for a mustache template. More...
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template. More...
	get_message ()
	Get the message for this notification. More...
	get_message_type ()
	Get the message type for this notification. More...
	get_template_name ()
	set_announce ($announce=false)
	Set whether this notification should be announced assertively to screen readers. More...
	set_extra_classes ($classes=array())
	Add any extra classes that this notification requires. More...
	set_show_closebutton ($button=false)
	Set whether this notification should include a button to disiss itself. More...

Public Attributes
const	NOTIFY_ERROR = 'error'
	A notification of level 'error'.
const	NOTIFY_INFO = 'info'
	A notification of level 'info'.
const	NOTIFY_SUCCESS = 'success'
	A notification of level 'success'.
const	NOTIFY_WARNING = 'warning'
	A notification of level 'warning'.

Protected Attributes
bool	$announce = true
	$announce Whether this notification should be announced assertively to screen readers.
bool	$closebutton = true
	$closebutton Whether this notification should inlcude a button to dismiss itself.
array	$extraclasses = array()
	$extraclasses A list of any extra classes that may be required.
string	$message = ''
	Message payload.
string	$messagetype = self::NOTIFY_WARNING
	Message type.

Constructor & Destructor Documentation

__construct()

core\output\notification::__construct	(		$message,
			$messagetype = null
	)

Notification constructor.

Parameters

string	$message	the message to print out
string	$messagetype	one of the NOTIFY_* constants..

Member Function Documentation

export_for_template() [1/2]

core\output\notification::export_for_template

(

\renderer_base

$output

)

Export this data so it can be used as the context for a mustache template.

Parameters

renderer_base

$output

typically, the renderer that's calling this function

Return values

stdClass

data context for a mustache template

export_for_template() [2/2]

templatable::export_for_template ( renderer_base  $output )

inherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

1. No complex types - only stdClass, array, int, string, float, bool
2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).

Parameters

renderer_base

$output

Used to do a final render of any components that need to be rendered for export.

Return values

stdClass|array

Implemented in tool_customlang\output\translator, tool_dataprivacy\output\categories, tool_dataprivacy\output\data_deletion_page, tool_dataprivacy\output\data_registry_compliance_page, tool_dataprivacy\output\data_registry_page, tool_dataprivacy\output\data_requests_page, tool_dataprivacy\output\defaults_page, tool_dataprivacy\output\my_data_requests_page, tool_dataprivacy\output\purposes, tool_dataprivacy\output\request_filter, tool_dataprivacy\output\summary_page, tool_langimport\output\langimport_page, tool_lp\output\competency_plan_navigation, tool_lp\output\competency_summary, tool_lp\output\course_competencies_page, tool_lp\output\manage_competencies_page, tool_lp\output\manage_competency_frameworks_page, tool_lp\output\manage_templates_page, tool_lp\output\module_navigation, tool_lp\output\plans_page, tool_lp\output\related_competencies, tool_lp\output\template_competencies_page, tool_lp\output\user_competency_course_navigation, tool_lp\output\user_competency_summary, tool_lp\output\user_competency_summary_in_course, tool_lp\output\user_evidence_list_page, tool_policy\output\acceptances, tool_policy\output\guestconsent, tool_policy\output\page_agreedocs, tool_policy\output\page_managedocs_list, tool_policy\output\page_nopermission, tool_policy\output\page_viewalldoc, tool_policy\output\page_viewdoc, tool_templatelibrary\output\list_templates_page, core_auth\output\digital_minor_page, core_auth\output\login, core_auth\output\verify_age_location_page, block_lp\output\competencies_to_review_page, block_lp\output\plans_to_review_page, block_lp\output\summary, block_myoverview\output\main, block_myprofile\output\myprofile, block_recentlyaccessedcourses\output\main, block_recentlyaccesseditems\output\main, block_search_forums\output\search_form, block_starredcourses\output\main, block_timeline\output\main, core_contentbank\output\bankcontent, core_contentbank\output\viewcontent, enrol_lti\output\registration, core_group\output\group_details, core_group\output\index_page, core_h5p\output\libraries, core\output\checkbox_toggleall, core\output\chooser, core\output\chooser_item, core\output\chooser_section, MoodleQuickForm_advcheckbox, MoodleQuickForm_autocomplete, MoodleQuickForm_checkbox, MoodleQuickForm_date_selector, MoodleQuickForm_date_time_selector, MoodleQuickForm_editor, MoodleQuickForm_filemanager, MoodleQuickForm_filepicker, MoodleQuickForm_grading, MoodleQuickForm_group, MoodleQuickForm_passwordunmask, MoodleQuickForm_recaptcha, MoodleQuickForm_select, MoodleQuickForm_selectgroups, MoodleQuickForm_selectwithlink, MoodleQuickForm_static, MoodleQuickForm_submit, MoodleQuickForm_tags, MoodleQuickForm_textarea, MoodleQuickForm_url, MoodleQuickForm_warning, component_action, help_icon, pix_icon_font, pix_icon, single_select, url_select, paging_bar, initials_bar, custom_menu_item, tabobject, tabtree, action_menu, progress_bar, login_signup_form, mod_assign\output\grading_app, assign_attempt_history_chooser, booktool_print\output\print_book_chapter_page, booktool_print\output\print_book_page, mod_feedback\output\summary, mod_forum\output\big_search_form, mod_forum\output\quick_search_form, mod_h5pactivity\output\attempt, mod_h5pactivity\output\reportattempts, mod_h5pactivity\output\reportlink, mod_h5pactivity\output\reportresults, mod_h5pactivity\output\result, mod_h5pactivity\output\result\longfillin, mod_h5pactivity\output\result\other, mod_lti\output\external_registration_return_page, mod_lti\output\repost_crosssite_page, mod_lti\output\tool_configure_page, MoodleQuickForm_wikieditor, core_privacy\output\exported_html_page, core_privacy\output\exported_navigation_page, report_competency\output\report, report_competency\output\user_course_navigation, core_tag\output\tag, core_tag\output\tagcloud, core_tag\output\tagfeed, core_tag\output\tagindex, core_tag\output\taglist, core_user\output\participants_filter, core_user\output\status_field, core_user\output\unified_filter, and forumreport_summary\output\filters.

get_message()

core\output\notification::get_message

(

)

Get the message for this notification.

Return values

string

message

get_message_type()

core\output\notification::get_message_type

(

)

Get the message type for this notification.

Return values

string

message type

set_announce()

core\output\notification::set_announce

(

$announce = false

)

Set whether this notification should be announced assertively to screen readers.

Parameters

bool

$announce

Return values

$this

set_extra_classes()

core\output\notification::set_extra_classes

(

$classes = array()

)

Add any extra classes that this notification requires.

Parameters

array

$classes

Return values

$this

set_show_closebutton()

core\output\notification::set_show_closebutton

(

$button = false

)

Set whether this notification should include a button to disiss itself.

Parameters

bool

$button

Return values

$this

---

The documentation for this class was generated from the following file:

• lib/classes/output/notification.php