LLMS_Abstract_Notification_View
Description Description
Source Source
File: includes/abstracts/llms.abstract.notification.view.php
Changelog Changelog
Version | Description |
---|---|
3.8.0 | |
3.37.19 | Introduced the method get_object() . It'll allow extending classes defining the way the object associated to the notification should be retrieved. Use in_array with strict comparison where possible. |
3.31.0 | Add filter on $basic_options class property. |
3.30.3 | Introduced. |
Methods Methods
- __construct — Constructor
- __destruct — Destructor
- get_basic_html — Get the html for a basic notification
- get_body — Retrieve the body for the notification
- get_date — Retrieve a formatted date
- get_date_display — Get relative or absolute date
- get_date_relative — Retrieve a date relative to the current time
- get_email_html — Get the html for an email notification
- get_field_options — Get an array of field-related options to be add to the notifications view config page on the admin panel
- get_filter — Get a filter hook string prefixed for the current view
- get_footer — Retrieve the footer for the notification
- get_html — Retrieve the full HTML to be output for the notification type
- get_icon — Retrieve the icon id for the notification
- get_icon_default — Retrieve a default icon for the notification based on the notification type
- get_icon_src — Retrieve the icon src for the notification
- get_merge_code_defaults — Get default merge codes available to all notifications of a given type
- get_merge_codes — Get available merge codes for the current notification
- get_merged_string — Merge a string
- get_notification — Access the protected notification object
- get_object — Get the object associated to the notification
- get_option_prefix — Retrieve a prefix for options related to the notification
- get_subject — Retrieve the subject for the notification (if supported)
- get_supported_fields — Get supported fields and allow filtering for 3rd parties
- get_title — Retrieve the title for the notification
- has_field_support — Determine if the current view supports a field by ID
- is_for_self — Determine if the notification subscriber is the user who triggered the notification
- sentence_case — Convert a string to sentence case
- set_body — Setup body content for output
- set_footer — Setup footer content for output
- set_icon — Setup notification icon for output
- set_merge_codes — Setup merge codes that can be used with the notification
- set_merge_data — Replace merge codes with actual values
- set_merge_data_default — Replace default merge codes with actual values
- set_shortcode_user — Set the user ID used by [llms-user] to the user triggering the notification.
- set_subject — Setup notification subject line for output
- set_supported_fields — Define field support for the view
- set_title — Setup notification title for output