update: React Admin Dashboard Structure (#2558)

* feat: react admin dashboard

* refactor: implemented the `Hookable` Interface

* refactor: implemented the `Hookable` Interface

* refactor: implemented the new servicefor AdminDashboardServiceProvider.php

* refactor: implemented the `Hookable` to Dashboard

* chore: comment changed

includes/Admin/Dashboard/Dashboard.php

@@ -0,0 +1,220 @@
+<?php
+
+namespace WeDevs\Dokan\Admin\Dashboard;
+
+use WeDevs\Dokan\Contracts\Hookable;
+
+/**
+ * Admin dashboard class.
+ *
+ * @since DOKAN_SINCE
+ */
+class Dashboard implements Hookable {
+
+    /**
+     * @var array< Pageable >
+     */
+    protected array $pages = [];
+
+    /**
+     * @var string
+     */
+    protected string $script_key = 'dokan-admin-dashboard';
+
+    /**
+     * Register hooks.
+     */
+    public function register_hooks(): void {
+        add_action( 'dokan_admin_menu', [ $this, 'register_menu' ], 99, 2 );
+        add_action( 'dokan_register_scripts', [ $this, 'register_scripts' ] );
+        add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_scripts' ] );
+    }
+
+    /**
+     * Get all pages.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return array< Pageable >
+     *
+     * @throws \InvalidArgumentException If the page is not an instance of Pageable.
+     */
+    public function get_pages(): array {
+        $pages = apply_filters( 'dokan_admin_dashboard_pages', $this->pages );
+
+        if ( ! is_array( $pages ) ) {
+            return $this->pages;
+        }
+
+        return array_filter(
+            $pages, function ( $page ) {
+				if ( ! $page instanceof Pageable ) {
+					throw new \InvalidArgumentException( esc_html__( 'The page must be an instance of Pageable.', 'dokan-lite' ) );
+				}
+				return true;
+			}
+        );
+    }
+
+    /**
+     * Register the submenu menu.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @param string $capability Menu capability.
+     * @param string $position Menu position.
+     *
+     * @return void
+     */
+    public function register_menu( string $capability, string $position ) {
+        global $submenu;
+
+        $parent_slug = 'dokan';
+
+        // TODO: Remove and rewrite this code for registering `dokan-dashboard`.
+        $menu_slug = 'dokan-dashboard';
+        add_submenu_page(
+            'dokan',
+            '',
+            '',
+            $capability,
+            $menu_slug,
+            [ $this, 'render_dashboard_page' ],
+            1
+        );
+
+        foreach ( $this->get_pages() as $page ) {
+            $menu_args = $page->menu( $capability, $position );
+
+            if ( ! $menu_args ) {
+                continue;
+            }
+
+            $route = $menu_args['route'] ?? $page->get_id();
+            $route = trim( $route, ' /' );
+
+            // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
+            $submenu[ $parent_slug ][] = [ $menu_args['menu_title'], $capability, 'admin.php?page=' . $menu_slug . '#/' . $route ];
+        }
+    }
+
+    /**
+     * Render the dashboard page.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return void
+     */
+    public function render_dashboard_page(): void {
+        $settings = $this->settings();
+
+        ob_start();
+        echo '<div class="wrap"><div id="dokan-admin-dashboard" class="dokan-layout" data-settings="' . esc_attr( wp_json_encode( $settings ) ) . '">' . esc_html__( 'Loading...', 'dokan-lite' ) . '</div></div>';
+        echo ob_get_clean();
+    }
+
+    /**
+     * Get all settings.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return array<string, mixed>
+     */
+    public function settings(): array {
+        $settings = [
+            'nonce' => wp_create_nonce( 'dokan_admin_dashboard' ),
+        ];
+
+        foreach ( $this->get_pages() as $page ) {
+
+            /**
+             * Filter the settings for a specific page.
+             *
+             * @since DOKAN_SINCE
+             *
+             * @param  array  $settings The settings.
+             * @param  string $page_id The page ID.
+             * @param  Pageable $page The page.
+             */
+            $settings[ $page->get_id() ] = apply_filters( 'dokan_admin_dashboard_page_settings', $page->settings(), $page->get_id(), $page );
+        }
+
+        /**
+         * Filter the settings.
+         *
+         * @since DOKAN_SINCE
+         *
+         * @param array<string, mixed> $settings The settings.
+         */
+        return apply_filters( 'dokan_admin_dashboard_pages_settings', $settings );
+    }
+
+    /**
+     * Get all scripts ids.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return array<string>
+     */
+    public function scripts(): array {
+        return array_reduce(
+            $this->get_pages(), fn( $carry, $page ) => array_merge( $carry, $page->scripts() ), [ $this->script_key ]
+        );
+    }
+
+    /**
+     * Get all styles ids.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return array<string>
+     */
+    public function styles(): array {
+        return array_reduce(
+            $this->get_pages(), fn( $carry, $page ) => array_merge( $carry, $page->styles() ), [ $this->script_key ]
+        );
+    }
+
+    /**
+     * Register dashboard scripts.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return void
+     */
+    public function register_scripts() {
+        $script = require DOKAN_DIR . '/assets/js/dokan-admin-dashboard.asset.php';
+
+        // Register the main script.
+        wp_register_script( $this->script_key, DOKAN_PLUGIN_ASSEST . '/js/dokan-admin-dashboard.js', $script['dependencies'], $script['version'], true );
+        wp_register_style( $this->script_key, DOKAN_PLUGIN_ASSEST . '/css/dokan-admin-dashboard.css', [], $script['version'] );
+
+        // Register all other scripts.
+        foreach ( $this->get_pages() as $page ) {
+            $page->register();
+        }
+    }
+
+    /**
+     * Enqueue dashboard scripts.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return void
+     */
+    public function enqueue_scripts() {
+        $screen = get_current_screen();
+
+        if ( $screen->id !== 'toplevel_page_dokan' && $screen->id !== 'dokan_page_dokan-dashboard' ) {
+            return;
+        }
+
+        foreach ( $this->scripts() as $handle ) {
+            wp_enqueue_script( $handle );
+        }
+
+        foreach ( $this->styles() as $handle ) {
+            wp_enqueue_style( $handle );
+        }
+    }
+}

includes/Admin/Dashboard/Pageable.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace WeDevs\Dokan\Admin\Dashboard;
+
+/**
+ * Interface Pageable.
+ *
+ * @package WeDevs\Dokan\Admin\Dashboard
+ *
+ * @since DOKAN_SINCE
+ */
+interface Pageable {
+
+    /**
+     * Get the ID of the page.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return string
+     */
+    public function get_id(): string;
+
+    /**
+     * Get the menu arguments.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @param  string  $capability Menu capability.
+     * @param  string  $position Menu position.
+     *
+     * @return array<string, string|int> An array of associative arrays with keys 'route', 'page_title', 'menu_title', 'capability', 'position'.
+     */
+    public function menu( string $capability, string $position ): array;
+
+    /**
+     * Get the settings values.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return array<string,mixed> An array of settings values.
+     */
+    public function settings(): array;
+
+    /**
+     * Get the scripts.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return array<string> An array of script handles.
+     */
+    public function scripts(): array;
+
+    /**
+     * Get the styles.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return array<string> An array of style handles.
+     */
+    public function styles(): array;
+
+    /**
+     * Register the page scripts and styles.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return void
+     */
+    public function register(): void;
+}

includes/Admin/Dashboard/Pages/AbstractPage.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace WeDevs\Dokan\Admin\Dashboard\Pages;
+
+use WeDevs\Dokan\Admin\Dashboard\Pageable;
+use WeDevs\Dokan\Contracts\Hookable;
+
+abstract class AbstractPage implements Pageable, Hookable {
+
+    /**
+     * Register the hooks.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return void
+     */
+    public function register_hooks(): void {
+        if ( ! is_admin() ) {
+            return;
+        }
+
+        add_filter( 'dokan_admin_dashboard_pages', [ $this, 'enlist' ] );
+    }
+
+    public function enlist( $pages ) {
+        $pages[] = $this;
+        return $pages;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    abstract public function get_id(): string;
+
+    /**
+     * @inheritDoc
+     */
+    abstract public function menu( string $capability, string $position ): array;
+
+    /**
+     * @inheritDoc
+     */
+    abstract public function settings(): array;
+
+    /**
+     * @inheritDoc
+     */
+    abstract public function scripts(): array;
+
+    /**
+     * @inheritDoc
+     */
+    abstract public function styles(): array;
+
+    /**
+     * @inheritDoc
+     */
+    abstract public function register(): void;
+}