DataTransferObjects
3 years ago
Endpoints
3 years ago
ListTable
3 years ago
Models
3 years ago
Properties
3 years ago
Repositories
3 years ago
ValueObjects
3 years ago
resources
3 years ago
DonationFormsAdminPage.php
3 years ago
ServiceProvider.php
3 years ago
DonationFormsAdminPage.php
206 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\DonationForms; |
| 4 | |
| 5 | use Give\DonationForms\ListTable\DonationFormsListTable; |
| 6 | use Give\Helpers\EnqueueScript; |
| 7 | use WP_REST_Request; |
| 8 | |
| 9 | /** |
| 10 | * @since 2.19.0 |
| 11 | */ |
| 12 | class DonationFormsAdminPage |
| 13 | { |
| 14 | /** |
| 15 | * @var string |
| 16 | */ |
| 17 | protected $apiRoot; |
| 18 | /** |
| 19 | * @var string |
| 20 | */ |
| 21 | protected $apiNonce; |
| 22 | /** |
| 23 | * @var string |
| 24 | */ |
| 25 | protected $adminUrl; |
| 26 | |
| 27 | public function __construct() |
| 28 | { |
| 29 | $this->apiRoot = esc_url_raw(rest_url('give-api/v2/admin/forms')); |
| 30 | $this->apiNonce = wp_create_nonce('wp_rest'); |
| 31 | $this->adminUrl = admin_url(); |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * Register menu item |
| 36 | */ |
| 37 | public function register() |
| 38 | { |
| 39 | remove_submenu_page('edit.php?post_type=give_forms', 'edit.php?post_type=give_forms'); |
| 40 | add_submenu_page( |
| 41 | 'edit.php?post_type=give_forms', |
| 42 | esc_html__('Donation Forms', 'give'), |
| 43 | esc_html__('All Forms', 'give'), |
| 44 | 'edit_give_forms', |
| 45 | 'give-forms', |
| 46 | [$this, 'render'], |
| 47 | // Do not change the submenu position unless you have a strong reason. |
| 48 | // We use this position value to access this menu data in $submenu to add a custom class. |
| 49 | // Check DonationFormsAdminPage::highlightAllFormsMenuItem |
| 50 | 0 |
| 51 | ); |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * @since 2.20.0 |
| 56 | */ |
| 57 | public function highlightAllFormsMenuItem() |
| 58 | { |
| 59 | global $submenu; |
| 60 | $pages = [ |
| 61 | '/wp-admin/admin.php?page=give-forms', // Donation main menu page. |
| 62 | '/wp-admin/edit.php?post_type=give_forms' // Legacy donation form listing page. |
| 63 | ]; |
| 64 | |
| 65 | if (in_array($_SERVER['REQUEST_URI'], $pages)) { |
| 66 | // Add class to highlight 'All Forms' submenu. |
| 67 | $submenu['edit.php?post_type=give_forms'][0][4] = add_cssclass( |
| 68 | 'current', |
| 69 | isset($submenu['edit.php?post_type=give_forms'][0][4]) ? $submenu['edit.php?post_type=give_forms'][0][4] : '' |
| 70 | ); |
| 71 | } |
| 72 | } |
| 73 | |
| 74 | /** |
| 75 | * Load scripts |
| 76 | */ |
| 77 | public function loadScripts() |
| 78 | { |
| 79 | $data = [ |
| 80 | 'apiRoot' => $this->apiRoot, |
| 81 | 'apiNonce' => $this->apiNonce, |
| 82 | 'preload' => $this->preloadDonationForms(), |
| 83 | 'authors' => $this->getAuthors(), |
| 84 | 'table' => give(DonationFormsListTable::class)->toArray(), |
| 85 | 'adminUrl' => $this->adminUrl, |
| 86 | 'pluginUrl' => GIVE_PLUGIN_URL, |
| 87 | ]; |
| 88 | |
| 89 | EnqueueScript::make('give-admin-donation-forms', 'assets/dist/js/give-admin-donation-forms.js') |
| 90 | ->loadInFooter() |
| 91 | ->registerTranslations() |
| 92 | ->registerLocalizeData('GiveDonationForms', $data)->enqueue(); |
| 93 | |
| 94 | wp_enqueue_style( |
| 95 | 'give-admin-ui-font', |
| 96 | 'https://fonts.googleapis.com/css2?family=Open+Sans:wght@400..700&display=swap', |
| 97 | [], |
| 98 | null |
| 99 | ); |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * Get first page of results from REST API to display as initial table data |
| 104 | * |
| 105 | * @since 2.20.0 |
| 106 | * @return array |
| 107 | */ |
| 108 | private function preloadDonationForms() |
| 109 | { |
| 110 | $queryParameters = [ |
| 111 | 'page' => 1, |
| 112 | 'perPage' => 30, |
| 113 | ]; |
| 114 | |
| 115 | $request = WP_REST_Request::from_url(add_query_arg( |
| 116 | $queryParameters, |
| 117 | $this->apiRoot |
| 118 | )); |
| 119 | |
| 120 | return rest_do_request($request)->get_data(); |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Get a list of author user IDs and names |
| 125 | * @since 2.20.0 |
| 126 | */ |
| 127 | public function getAuthors() |
| 128 | { |
| 129 | $author_users = get_users([ |
| 130 | 'role__in' => ['author', 'administrator'] |
| 131 | ]); |
| 132 | return array_map(function($user){ |
| 133 | return [ |
| 134 | 'id' => $user->ID, |
| 135 | 'name' => $user->display_name, |
| 136 | ]; |
| 137 | }, $author_users); |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * Render admin page |
| 142 | */ |
| 143 | public function render() |
| 144 | { |
| 145 | echo '<div id="give-admin-donation-forms-root"></div>'; |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * Display a button on the old donation forms table that switches to the React view |
| 150 | * |
| 151 | * @since 2.20.0 |
| 152 | */ |
| 153 | public function renderReactSwitch() |
| 154 | { |
| 155 | ?> |
| 156 | <script type="text/javascript"> |
| 157 | function showReactTable () { |
| 158 | fetch( '<?php echo esc_url_raw(rest_url('give-api/v2/admin/forms/view?isLegacy=0')) ?>', { |
| 159 | method: 'GET', |
| 160 | headers: { |
| 161 | ['X-WP-Nonce']: '<?php echo wp_create_nonce('wp_rest') ?>' |
| 162 | } |
| 163 | }) |
| 164 | .then((res) => { |
| 165 | window.location = window.location.href = '/wp-admin/edit.php?post_type=give_forms&page=give-forms'; |
| 166 | }); |
| 167 | } |
| 168 | jQuery( function() { |
| 169 | jQuery(jQuery(".wrap .page-title-action")[0]).after( |
| 170 | '<button class="page-title-action" onclick="showReactTable()">Switch to New View</button>' |
| 171 | ); |
| 172 | }); |
| 173 | </script> |
| 174 | <?php |
| 175 | } |
| 176 | |
| 177 | /** |
| 178 | * Helper function to determine if current page is Give Add-ons admin page |
| 179 | * |
| 180 | * @since 2.20.0 |
| 181 | */ |
| 182 | public static function isShowing(): bool |
| 183 | { |
| 184 | return isset($_GET['page']) && $_GET['page'] === 'give-forms'; |
| 185 | } |
| 186 | |
| 187 | /** |
| 188 | * Helper function to determine if the current page is the legacy donation forms list page |
| 189 | * |
| 190 | * @since 2.20.1 |
| 191 | */ |
| 192 | public static function isShowingLegacyPage(): bool |
| 193 | { |
| 194 | return isset($_GET['post_type']) && $_GET['post_type'] === 'give_forms' && empty($_GET['page']); |
| 195 | } |
| 196 | |
| 197 | /** |
| 198 | * @since 2.20.0 |
| 199 | * @return string |
| 200 | */ |
| 201 | public static function getUrl() |
| 202 | { |
| 203 | return add_query_arg(['page' => 'give-forms'], admin_url('edit.php?post_type=give_forms')); |
| 204 | } |
| 205 | } |
| 206 |