| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
Notification renderable component.
| Copyright: | 2015 Jetha Chan |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 207 lines (6 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
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) X-Ref |
| Notification constructor. param: string $message the message to print out param: string $messagetype normally NOTIFY_PROBLEM or NOTIFY_SUCCESS. |
| set_announce($announce = false) X-Ref |
| Set whether this notification should be announced assertively to screen readers. param: bool $announce return: $this |
| set_show_closebutton($button = false) X-Ref |
| Set whether this notification should include a button to disiss itself. param: bool $button return: $this |
| set_extra_classes($classes = array() X-Ref |
| Add any extra classes that this notification requires. param: array $classes return: $this |
| 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. param: renderer_base $output typically, the renderer that's calling this function return: stdClass data context for a mustache template |
| get_template_name() X-Ref |
| No description |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |