LLMS_Abstract_Notification_Controller
Notification Controller abstract class
Description Description
Source Source
File: includes/abstracts/llms.abstract.notification.controller.php
Changelog Changelog
Version | Description |
---|---|
3.8.0 | |
3.30.3 | Introduced. |
Methods Methods
- __construct — Constructor
- add_actions — Add an action to trigger the notification to send
- add_custom_subscriptions
- add_subscriptions — Adds subscribers before sending a notifications
- get_mock_view — Get a fake instance of a view, used for managing options & customization on the admin panel
- get_option_prefix — Retrieve a prefix for options related to the notification This overrides the LLMS_Abstract_Options_Data method
- get_subscriber — Takes a subscriber type (student, author, etc) and retrieves a User ID
- get_subscriber_option_array — Get an array of prebuilt subscriber option settings for common subscriptions
- get_subscriber_options — Retrieve get an array of subscriber options for the current notification by type
- get_subscriber_subscriptions — Get a subscriptions array for a specific subscriber
- get_subscribers_settings — Get an array of saved subscriber settings prefilled with defaults for the current notification
- get_subscriptions — Retrieve subscribers
- get_supported_types — Get an array of supported notification types
- get_test_settings — Get an array of LifterLMS Admin Page settings to send test notifications
- get_title — Get the translatable title for the notification used on settings screens
- has_subscriber_received — Determine if the notification is a potential duplicate
- instance — Get the singleton instance for the extending class
- is_testable — Determine if the notification type support tests
- send — Send all the subscriptions
- send_one — Send a notification for a subscriber
- send_test — Send a test notification to the currently logged in users Extending classes should redefine this in order to properly setup the controller with post_id and user_id data
- set_subscriber_options — Setup the subscriber options for the notification
- set_supported_types — Determine what types are supported Extending classes can override this function in order to add or remove support 3rd parties should add support via filter on $this->get_supported_types()
- subscribe — Subscribe a user to a notification type
- supports — Determine if a given notification type is supported
- unset_subscriptions — Reset the subscriptions array