Added rating notice

classes/class-bsf-sb-sidebar.php

@@ -43,6 +43,18 @@ public static function get_instance() {
 		 */
 		public function __construct() {
 			$this->load_actions();
+			add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) );
+		}
+
+		/**
+		 * Enqueue Admin Scripts
+		 *
+		 * @since 1.0.0
+		 */
+		public function enqueue_admin_scripts() {
+
+			wp_enqueue_style( 'bsf-sidebar-manager-css', BSF_SB_URL . 'includes/assets/css/sidebar-manager.css', array(), BSF_SB_VER );
+
 		}
 
 		/**

includes/assets/css/sidebar-manager.css

@@ -0,0 +1,39 @@
+.astra-review-notice-container {
+	display: flex;
+	align-items: center;
+	padding-top: 10px;
+}
+
+.astra-review-notice-container .dashicons {
+    font-size: 1.4em;
+	padding-left: 10px;
+}
+
+.astra-review-notice-container a {
+    padding-left: 5px;
+    text-decoration: none;
+}
+
+.astra-review-notice-container .dashicons:first-child {
+    padding-left: 0;
+}
+
+.notice-image img {
+    max-width: 90px;
+}
+
+.notice-content .notice-heading {
+    padding-bottom: 5px;
+}
+
+.notice-content {
+    margin-left: 15px;
+}
+
+.notice-container {
+    padding-top: 10px;
+    padding-bottom: 10px;
+    display: flex;
+    justify-content: left;
+    align-items: center;
+}

includes/lib/notices/class-astra-notices.php

@@ -0,0 +1,328 @@
+<?php
+/**
+ * Astra Sites Notices
+ *
+ * Closing notice on click on `astra-notice-close` class.
+ *
+ * If notice has the data attribute `data-repeat-notice-after="%2$s"` then notice close for that SPECIFIC TIME.
+ * If notice has NO data attribute `data-repeat-notice-after="%2$s"` then notice close for the CURRENT USER FOREVER.
+ *
+ * > Create custom close notice link in the notice markup. E.g.
+ * `<a href="#" data-repeat-notice-after="<?php echo MONTH_IN_SECONDS; ?>" class="astra-notice-close">`
+ * It close the notice for 30 days.
+ *
+ * @package Astra Sites
+ * @since 1.4.0
+ */
+
+if ( ! class_exists( 'Astra_Notices' ) ) :
+
+	/**
+	 * Astra_Notices
+	 *
+	 * @since 1.4.0
+	 */
+	class Astra_Notices {
+
+		/**
+		 * Notices
+		 *
+		 * @access private
+		 * @var array Notices.
+		 * @since 1.4.0
+		 */
+		private static $version = '1.0.0';
+
+		/**
+		 * Notices
+		 *
+		 * @access private
+		 * @var array Notices.
+		 * @since 1.4.0
+		 */
+		private static $notices = array();
+
+		/**
+		 * Instance
+		 *
+		 * @access private
+		 * @var object Class object.
+		 * @since 1.4.0
+		 */
+		private static $instance;
+
+		/**
+		 * Initiator
+		 *
+		 * @since 1.4.0
+		 * @return object initialized object of class.
+		 */
+		public static function get_instance() {
+			if ( ! isset( self::$instance ) ) {
+				self::$instance = new self;
+			}
+			return self::$instance;
+		}
+
+		/**
+		 * Constructor
+		 *
+		 * @since 1.4.0
+		 */
+		public function __construct() {
+			add_action( 'admin_notices', array( $this, 'show_notices' ), 30 );
+			add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
+			add_action( 'wp_ajax_astra-notice-dismiss', array( $this, 'dismiss_notice' ) );
+			add_filter( 'wp_kses_allowed_html', array( $this, 'add_data_attributes' ), 10, 2 );
+		}
+
+		/**
+		 * Filters and Returns a list of allowed tags and attributes for a given context.
+		 *
+		 * @param Array  $allowedposttags Array of allowed tags.
+		 * @param String $context Context type (explicit).
+		 * @since 1.4.0
+		 * @return Array
+		 */
+		function add_data_attributes( $allowedposttags, $context ) {
+			$allowedposttags['a']['data-repeat-notice-after'] = true;
+
+			return $allowedposttags;
+		}
+
+		/**
+		 * Add Notice.
+		 *
+		 * @since 1.4.0
+		 * @param array $args Notice arguments.
+		 * @return void
+		 */
+		public static function add_notice( $args = array() ) {
+			self::$notices[] = $args;
+		}
+
+		/**
+		 * Dismiss Notice.
+		 *
+		 * @since 1.4.0
+		 * @return void
+		 */
+		function dismiss_notice() {
+			$notice_id           = ( isset( $_POST['notice_id'] ) ) ? sanitize_key( $_POST['notice_id'] ) : '';
+			$repeat_notice_after = ( isset( $_POST['repeat_notice_after'] ) ) ? absint( $_POST['repeat_notice_after'] ) : '';
+			$nonce               = ( isset( $_POST['nonce'] ) ) ? sanitize_key( $_POST['nonce'] ) : '';
+
+			if ( false === wp_verify_nonce( $nonce, 'astra-notices' ) ) {
+				wp_send_json_error( _e( 'WordPress Nonce not validated.', 'astra-sites' ) );
+			}
+
+			// Valid inputs?
+			if ( ! empty( $notice_id ) ) {
+
+				if ( ! empty( $repeat_notice_after ) ) {
+					set_transient( $notice_id, true, $repeat_notice_after );
+				} else {
+					update_user_meta( get_current_user_id(), $notice_id, true );
+				}
+
+				wp_send_json_success();
+			}
+
+			wp_send_json_error();
+		}
+
+		/**
+		 * Enqueue Scripts.
+		 *
+		 * @since 1.4.0
+		 * @return void
+		 */
+		function enqueue_scripts() {
+			wp_register_script( 'astra-notices', self::_get_uri() . 'notices.js', array( 'jquery' ), null, self::$version );
+			wp_localize_script(
+				'astra-notices',
+				'astraNotices',
+				array(
+					'_notice_nonce' => wp_create_nonce( 'astra-notices' ),
+				)
+			);
+		}
+
+		/**
+		 * Rating priority sort
+		 *
+		 * @since 1.5.2
+		 * @param array $array1 array one.
+		 * @param array $array2 array two.
+		 * @return array
+		 */
+		function sort_notices( $array1, $array2 ) {
+			if ( ! isset( $array1['priority'] ) ) {
+				$array1['priority'] = 10;
+			}
+			if ( ! isset( $array2['priority'] ) ) {
+				$array2['priority'] = 10;
+			}
+
+			return $array1['priority'] - $array2['priority'];
+		}
+
+		/**
+		 * Notice Types
+		 *
+		 * @since 1.4.0
+		 * @return void
+		 */
+		function show_notices() {
+
+			$defaults = array(
+				'id'                         => '',      // Optional, Notice ID. If empty it set `astra-notices-id-<$array-index>`.
+				'type'                       => 'info',  // Optional, Notice type. Default `info`. Expected [info, warning, notice, error].
+				'message'                    => '',      // Optional, Message.
+				'show_if'                    => true,    // Optional, Show notice on custom condition. E.g. 'show_if' => if( is_admin() ) ? true, false, .
+				'repeat-notice-after'        => '',      // Optional, Dismiss-able notice time. It'll auto show after given time.
+				'class'                      => '',      // Optional, Additional notice wrapper class.
+				'priority'                   => 10,      // Priority of the notice.
+				'display-with-other-notices' => true,    // Should the notice be displayed if other notices  are being displayed from Astra_Notices.
+			);
+
+			// Count for the notices that are rendered.
+			$notices_displayed = 0;
+
+			// sort the array with priority.
+			usort( self::$notices, array( $this, 'sort_notices' ) );
+
+			foreach ( self::$notices as $key => $notice ) {
+
+				$notice = wp_parse_args( $notice, $defaults );
+
+				$notice['id'] = self::get_notice_id( $notice, $key );
+
+				$notice['classes'] = self::get_wrap_classes( $notice );
+
+				// Notices visible after transient expire.
+				if ( isset( $notice['show_if'] ) && true === $notice['show_if'] ) {
+					if ( self::is_expired( $notice ) ) {
+
+						// don't display the notice if it is not supposed to be displayed with other notices.
+						if ( 0 !== $notices_displayed && false === $notice['display-with-other-notices'] ) {
+							continue;
+						}
+
+						self::markup( $notice );
+					}
+				} else {
+					// No transient notices.
+					self::markup( $notice );
+				}
+
+				++$notices_displayed;
+			}
+
+		}
+
+		/**
+		 * Markup Notice.
+		 *
+		 * @since 1.4.0
+		 * @param  array $notice Notice markup.
+		 * @return void
+		 */
+		public static function markup( $notice = array() ) {
+
+			wp_enqueue_script( 'astra-notices' );
+
+			?>
+			<div id="<?php echo esc_attr( $notice['id'] ); ?>" class="<?php echo esc_attr( $notice['classes'] ); ?>" data-repeat-notice-after="<?php echo esc_attr( $notice['repeat-notice-after'] ); ?>">
+				<div class="notice-container">
+					<?php echo wp_kses_post( $notice['message'] ); ?>
+				</div>
+			</div>
+			<?php
+		}
+
+		/**
+		 * Notice classes.
+		 *
+		 * @since 1.4.0
+		 *
+		 * @param  array $notice Notice arguments.
+		 * @return array       Notice wrapper classes.
+		 */
+		private static function get_wrap_classes( $notice ) {
+			$classes   = array( 'astra-notice', 'notice', 'is-dismissible' );
+			$classes[] = $notice['class'];
+			if ( isset( $notice['type'] ) && '' !== $notice['type'] ) {
+				$classes[] = 'notice-' . $notice['type'];
+			}
+
+			return esc_attr( implode( ' ', $classes ) );
+		}
+
+		/**
+		 * Get Notice ID.
+		 *
+		 * @since 1.4.0
+		 *
+		 * @param  array $notice Notice arguments.
+		 * @param  int   $key     Notice array index.
+		 * @return string       Notice id.
+		 */
+		private static function get_notice_id( $notice, $key ) {
+			if ( isset( $notice['id'] ) && ! empty( $notice['id'] ) ) {
+				return $notice['id'];
+			}
+
+			return 'astra-notices-id-' . $key;
+		}
+
+		/**
+		 * Is notice expired?
+		 *
+		 * @since 1.4.0
+		 *
+		 * @param  array $notice Notice arguments.
+		 * @return boolean
+		 */
+		private static function is_expired( $notice ) {
+
+			$expired = get_transient( $notice['id'] );
+			if ( false === $expired ) {
+				$expired = get_user_meta( get_current_user_id(), $notice['id'], true );
+				if ( empty( $expired ) ) {
+					return true;
+				}
+			}
+
+			return false;
+		}
+
+		/**
+		 * Get URI
+		 *
+		 * @return mixed URL.
+		 */
+		public static function _get_uri() {
+			$path       = wp_normalize_path( dirname( __FILE__ ) );
+			$theme_dir  = wp_normalize_path( get_template_directory() );
+			$plugin_dir = wp_normalize_path( WP_PLUGIN_DIR );
+
+			if ( strpos( $path, $theme_dir ) !== false ) {
+				return trailingslashit( get_template_directory_uri() . str_replace( $theme_dir, '', $path ) );
+			} elseif ( strpos( $path, $plugin_dir ) !== false ) {
+				return plugin_dir_url( __FILE__ );
+			} elseif ( strpos( $path, dirname( plugin_basename( __FILE__ ) ) ) !== false ) {
+				return plugin_dir_url( __FILE__ );
+			}
+
+			return;
+		}
+
+	}
+
+	/**
+	 * Kicking this off by calling 'get_instance()' method
+	 */
+	Astra_Notices::get_instance();
+
+endif;