Enhance : Admin Notice Show gloablly & extand API (#2446)

* [refactor] [readable] state checking logic * [change] [filter] admin notices * [replace] args of notice api * [replace] scope to context * [refactor] app js code * [refactor] [readable] state checking logic * [change] context to scope * fix: pr review to control scope-wise admin notices * fix: global admin notice is not working * update: filter admin notices by scope * update: ensure notice scope before scope wise filtering * update: simplify the scope validation * fix: Clicking on upgrader button doesn't work if notice is set to global scope * update: data update notice description as per pm message --------- Co-authored-by: Al Amin Ahamed <[email protected]>
getdokan · Nov 26, 2024 · 9b8e9c2 · 9b8e9c2
1 parent c449b9f
commit 9b8e9c2
Show file tree

Hide file tree

Showing 7 changed files with 72 additions and 4 deletions.
diff --git a/includes/Assets.php b/includes/Assets.php
@@ -35,6 +35,7 @@ public function __construct() {
      */
     public function load_dokan_admin_notices_scripts() {
         wp_enqueue_script( 'dokan-promo-notice-js' );
+        wp_enqueue_script( 'dokan-admin-notice-js' );
         $vue_localize_script = apply_filters(
             'dokan_promo_notice_localize_script', [
                 'ajaxurl' => admin_url( 'admin-ajax.php' ),
@@ -535,6 +536,11 @@ public function get_scripts() {
                 'deps'    => [ 'jquery', 'dokan-vue-vendor' ],
                 'version' => filemtime( $asset_path . 'js/dokan-promo-notice.js' ),
             ],
+            'dokan-admin-notice-js'    => [
+                'src'     => $asset_url . '/js/dokan-admin-notice.js',
+                'deps'    => [ 'jquery', 'dokan-vue-vendor' ],
+                'version' => filemtime( $asset_path . 'js/dokan-admin-notice.js' ),
+            ],
             'dokan-reverse-withdrawal' => [
                 'src'     => $asset_url . '/js/reverse-withdrawal.js',
                 'deps'    => [ 'jquery', 'dokan-util-helper', 'dokan-vue-vendor', 'dokan-date-range-picker' ],

diff --git a/includes/REST/AdminNoticeController.php b/includes/REST/AdminNoticeController.php
@@ -5,6 +5,7 @@
 use WeDevs\Dokan\Admin\Notices\Helper;
 use WP_REST_Response;
 use WP_REST_Server;
+use WP_REST_Request;
 use WeDevs\Dokan\Abstracts\DokanRESTAdminController;
 
 /**
@@ -36,6 +37,16 @@ public function register_routes() {
                     'methods'             => WP_REST_Server::READABLE,
                     'callback'            => [ $this, 'dokan_get_admin_notices' ],
                     'permission_callback' => [ $this, 'check_permission' ],
+                    'args'                => [
+                        'scope' => [
+                            'description' => __( 'Choose notice scope: "local" displays only on Dokan pages, "global" displays across the entire site.', 'dokan-lite' ),
+                            'type'        => 'string',
+                            'enum'        => [ 'local', 'global' ],
+                            'required'    => false,
+                            'default'     => '',
+                            'sanitize_callback' => 'sanitize_text_field',
+                        ],
+                    ],
                 ],
             ]
         );
@@ -53,13 +64,26 @@ public function register_routes() {
 
     /**
      * Get dokan specific notices
+     * @param WP_REST_Request $request
      *
      * @return WP_REST_Response
      */
-    public function dokan_get_admin_notices() {
+    public function dokan_get_admin_notices( WP_REST_Request $request ) {
+        $notice_scope = $request->get_param( 'scope' );
+        $notice_scope = ! empty( $notice_scope ) ? $notice_scope : 'local';
+
         $notices = Helper::dokan_get_admin_notices();
 
-        return rest_ensure_response( $notices );
+        // Filter notices by scope
+        $filter_notices = array_filter(
+            $notices,
+            function ( $notice ) use ( $notice_scope ) {
+                return $notice_scope === ( $notice['scope'] ?? 'local' );
+            }
+        );
+        $filter_notices = array_values( $filter_notices );
+
+        return rest_ensure_response( $filter_notices );
     }
 
     /**

diff --git a/includes/Upgrade/AdminNotice.php b/includes/Upgrade/AdminNotice.php
@@ -37,8 +37,9 @@ public static function show_notice( $notices ) {
         $notices[] = [
             'type'              => 'info',
             'title'             => __( 'Dokan Data Update Required', 'dokan-lite' ),
-            'description'       => __( 'We need to update your install to the latest version', 'dokan-lite' ),
+            'description'       => __( 'Updating your Dokan data is required to continue functional operations.', 'dokan-lite' ),
             'priority'          => 1,
+            'scope'             => 'global',
             'actions'           => [
                 [
                     'type'            => 'primary',

diff --git a/src/admin/components/AdminNotice.vue b/src/admin/components/AdminNotice.vue
@@ -62,6 +62,10 @@ export default {
             type: Number,
             default: 5000
         },
+        scope: {
+            type: String,
+            default: ''
+        }
     },
 
     data() {
@@ -82,8 +86,9 @@ export default {
 
     methods: {
         fetch() {
+            const notice_scope = this.scope ? `?scope=${this.scope}` : '';
             $.ajax( {
-                url: `${dokan_promo.rest.root}${dokan_promo.rest.version}/admin/notices/${this.endpoint}`,
+                url: `${dokan_promo.rest.root}${dokan_promo.rest.version}/admin/notices/${this.endpoint}${notice_scope}`,
                 method: 'get',
                 beforeSend: function ( xhr ) {
                     xhr.setRequestHeader( 'X-WP-Nonce', dokan_promo.rest.nonce );

diff --git a/src/admin/notice/App.vue b/src/admin/notice/App.vue
@@ -0,0 +1,17 @@
+<script setup>
+
+import AdminNotice from "admin/components/AdminNotice.vue";
+</script>
+
+<template>
+    <AdminNotice
+        scope="global"
+        :interval="10000"
+        endpoint="admin"
+    />
+
+</template>
+
+<style scoped lang="less">
+
+</style>
diff --git a/src/admin/notice/main.js b/src/admin/notice/main.js
@@ -0,0 +1,14 @@
+import Vue from 'vue';
+import App from './App.vue';
+import Mixin from '../../utils/Mixin';
+
+const { jQuery: $ } = window;
+
+if ( $( '#dokan-admin-notices' ).length ) {
+    Vue.mixin( Mixin );
+
+    new Vue( {
+        el: '#dokan-admin-notices',
+        render: ( h ) => h( App ),
+    } );
+}
diff --git a/webpack.config.js b/webpack.config.js
@@ -16,6 +16,7 @@ const entryPoint = {
     './src/utils/vue-vendor.js',
   ],
   'dokan-promo-notice': './src/promo-notice/main.js',
+  'dokan-admin-notice': './src/admin/notice/main.js',
   'reverse-withdrawal': './assets/src/js/reverse-withdrawal.js',
   'product-category-ui': './assets/src/js/product-category-ui.js',
   'dokan-admin-product': './assets/src/js/dokan-admin-product.js',