Abandoned
2 months ago
AffiliationClicks
2 months ago
AffiliationPayoutGroups
2 years ago
AffiliationPayouts
10 months ago
AffiliationReferrals
7 months ago
AffiliationRequests
2 months ago
Affiliations
2 months ago
AutoFees
1 week ago
Bumps
2 months ago
Bundles
6 days ago
CancellationInsights
2 months ago
Cart
4 years ago
Checkouts
3 months ago
Coupons
3 months ago
Customers
2 months ago
Dashboard
10 months ago
Invoices
2 months ago
Learn
3 months ago
Licenses
2 months ago
Onboarding
11 months ago
Orders
2 months ago
ProductCollections
1 week ago
ProductGroups
1 week ago
Products
6 days ago
Restore
2 years ago
Reviews
1 week ago
Settings
1 month ago
Subscriptions
2 months ago
Tables
1 week ago
Upsells
2 months ago
.gitkeep
4 years ago
Account.php
4 years ago
AdminController.php
1 week ago
PluginSettings.php
4 years ago
RendersEnhancedAdminView.php
1 week ago
RendersEnhancedAdminView.php
95 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Controllers\Admin; |
| 4 | |
| 5 | /** |
| 6 | * Shared plumbing for admin pages that dual-render between the new React |
| 7 | * DataViews SPA and the legacy WP_List_Table controller. |
| 8 | * |
| 9 | * Consumers implement `renderSpaView()` and `renderWpListView()`; the trait |
| 10 | * owns the feature-flag check, `index()` routing, and SPA-shell rendering. |
| 11 | */ |
| 12 | trait RendersEnhancedAdminView { |
| 13 | /** |
| 14 | * Render the SPA shell view for this admin page. |
| 15 | * |
| 16 | * Must enqueue the scripts controller and return the shell response |
| 17 | * — typically by calling `renderSpaShell()`. |
| 18 | * |
| 19 | * @return \SureCartCore\Responses\ResponseInterface |
| 20 | */ |
| 21 | abstract protected function renderSpaView(); |
| 22 | |
| 23 | /** |
| 24 | * Render the legacy WP_List_Table view for this admin page. |
| 25 | * |
| 26 | * @return \SureCartCore\Responses\ResponseInterface |
| 27 | */ |
| 28 | abstract protected function renderWpListView(); |
| 29 | |
| 30 | /** |
| 31 | * Render the appropriate view based on the `surecart_enhanced_admin_views` feature flag. |
| 32 | */ |
| 33 | public function index() { |
| 34 | return $this->isEnhancedAdminViewsEnabled() ? $this->renderSpaView() : $this->renderWpListView(); |
| 35 | } |
| 36 | |
| 37 | /** |
| 38 | * Enqueue the SPA bundle on admin_enqueue_scripts. |
| 39 | * |
| 40 | * @param string $scripts_controller FQN of the scripts controller (ProductScriptsController::class etc.). |
| 41 | * @return void |
| 42 | */ |
| 43 | protected function enqueueSpaScripts( string $scripts_controller ): void { |
| 44 | add_action( 'admin_enqueue_scripts', \SureCart::closure()->method( $scripts_controller, 'enqueue' ) ); |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Render the SPA shell view, optionally with a breadcrumb header. |
| 49 | * |
| 50 | * Pass a breadcrumb key + title for list views where the PHP-rendered |
| 51 | * admin header bar should show "Logo → Title". Omit both for edit/create |
| 52 | * views — the React detail components render their own breadcrumbs, so a |
| 53 | * second PHP-rendered bar would duplicate them. |
| 54 | * |
| 55 | * @param string $view View slug passed to \SureCart::view(). |
| 56 | * @param string|null $breadcrumb_key Breadcrumb array key (e.g. 'products'). |
| 57 | * @param string|null $title Localized breadcrumb title. |
| 58 | * |
| 59 | * @return \SureCartCore\Responses\ResponseInterface |
| 60 | */ |
| 61 | protected function renderSpaShell( string $view, ?string $breadcrumb_key = null, ?string $title = null ) { |
| 62 | if ( null !== $breadcrumb_key && null !== $title ) { |
| 63 | $this->withHeader( |
| 64 | [ |
| 65 | 'breadcrumbs' => [ |
| 66 | $breadcrumb_key => [ 'title' => $title ], |
| 67 | ], |
| 68 | 'enhanced_view_promo' => $this->currentAdminPageUrl(), |
| 69 | ] |
| 70 | ); |
| 71 | } |
| 72 | |
| 73 | return \SureCart::view( $view ); |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Get the URL of the current admin page, for redirecting back after toggling enhanced views. |
| 78 | * |
| 79 | * @return string |
| 80 | */ |
| 81 | private function currentAdminPageUrl(): string { |
| 82 | $page = isset( $_GET['page'] ) ? sanitize_key( wp_unslash( $_GET['page'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
| 83 | return $page ? admin_url( 'admin.php?page=' . $page ) : admin_url(); |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Whether the React DataViews experience is enabled. |
| 88 | * |
| 89 | * @return bool |
| 90 | */ |
| 91 | public function isEnhancedAdminViewsEnabled(): bool { |
| 92 | return (bool) get_option( 'surecart_enhanced_admin_views', true ); |
| 93 | } |
| 94 | } |
| 95 |