LLMS_Notification_View_Certificate_Earned
Notification View: Certificate Earned
Description Description
Source Source
File: includes/notifications/views/class.llms.notification.view.certificate.earned.php
class LLMS_Notification_View_Certificate_Earned extends LLMS_Abstract_Notification_View { /** * Settings for basic notifications * @var array */ protected $basic_options = array( /** * Time in milliseconds to show a notification * before automatically dismissing it */ 'auto_dismiss' => 10000, /** * Enables manual dismissal of notifications */ 'dismissible' => true, ); /** * Notification Trigger ID * @var [type] */ public $trigger_id = 'certificate_earned'; private function get_mini_html( $title, $content ) { $attrs = array( 'class' => array(), 'id' => array(), 'style' => array(), ); $allowed = array( 'h1' => $attrs, 'h2' => $attrs, 'h3' => $attrs, 'h4' => $attrs, 'h5' => $attrs, 'h6' => $attrs, 'p' => $attrs, 'ul' => $attrs, 'ol' => $attrs, 'li' => $attrs, 'strong' => $attrs, 'em' => $attrs, 'i' => $attrs, 'b' => $attrs, ); ob_start(); ?> <div class="llms-mini-cert"> <h2 class="llms-mini-cert-title"><?php echo $title; ?></h2> <?php echo wp_kses( $content, $allowed ); ?> </div> <?php return ob_get_clean(); } /** * Setup body content for output * @return string * @since 3.8.0 * @version 3.8.0 */ protected function set_body() { return '{{MINI_CERTIFICATE}}'; } /** * Setup footer content for output * @return string * @since 3.8.0 * @version 3.8.0 */ protected function set_footer() { $url = $this->set_merge_data( '{{CERTIFICATE_URL}}' ); return '<a href="' . esc_url( $url ) . '">' . __( 'View Full Certificate', 'lifterlms' ) . '</a>'; } /** * Setup notification icon for output * @return string * @since 3.8.0 * @version 3.8.0 */ protected function set_icon() { return $this->get_icon_default( 'positive' ); } /** * Setup merge codes that can be used with the notification * @return array * @since 3.8.0 * @version 3.8.0 */ protected function set_merge_codes() { return array( '{{CERTIFICATE_CONTENT}}' => __( 'Certificate Content', 'lifterlms' ), '{{CERTIFICATE_TITLE}}' => __( 'Certificate Title', 'lifterlms' ), '{{CERTIFICATE_URL}}' => __( 'Certificate URL', 'lifterlms' ), '{{STUDENT_NAME}}' => __( 'Student Name', 'lifterlms' ), '{{MINI_CERTIFICATE}}' => __( 'Mini Certificate', 'lifterlms' ), ); } /** * Replace merge codes with actual values * @param string $code the merge code to ge merged data for * @return string * @since 3.8.0 * @version 3.16.6 */ protected function set_merge_data( $code ) { $cert = new LLMS_User_Certificate( $this->notification->post_id ); switch ( $code ) { case '{{CERTIFICATE_CONTENT}}': $code = $cert->get( 'content' ); break; case '{{CERTIFICATE_TITLE}}': $code = $cert->get( 'certificate_title' ); break; case '{{CERTIFICATE_URL}}': $code = get_permalink( $cert->get( 'id' ) ); break; case '{{MINI_CERTIFICATE}}': $code = $this->get_mini_html( $this->set_merge_data( '{{CERTIFICATE_TITLE}}' ), $this->set_merge_data( '{{CERTIFICATE_CONTENT}}' ) ); break; case '{{STUDENT_NAME}}': $code = $this->is_for_self() ? __( 'you', 'lifterlms' ) : $this->user->get_name(); break; } return $code; } /** * Setup notification subject for output * @return string * @since 3.8.0 * @version 3.8.0 */ protected function set_subject() { return ''; } /** * Setup notification title for output * @return string * @since 3.8.0 * @version 3.8.0 */ protected function set_title() { return __( 'You\'ve earned a certificate!', 'lifterlms' ); } /** * Define field support for the view * Extending classes can override this * 3rd parties should filter $this->get_supported_fields() * @return array * @since 3.8.0 * @version 3.8.0 */ protected function set_supported_fields() { return array( 'basic' => array( 'body' => true, 'title' => true, 'icon' => true, ), ); } }
Expand full source code Collapse full source code View on GitHub
Changelog Changelog
Version | Description |
---|---|
3.8.0 | Introduced. |
Methods Methods
- get_mini_html
- 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_subject — Setup notification subject for output
- set_supported_fields — Define field support for the view Extending classes can override this 3rd parties should filter $this->get_supported_fields()
- set_title — Setup notification title for output
User Contributed Notes User Contributed Notes
Permalink: