Settings.php
299 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\DonorDashboards\Admin; |
| 4 | |
| 5 | /** |
| 6 | * @since 2.10.0 |
| 7 | */ |
| 8 | class Settings { |
| 9 | |
| 10 | /** |
| 11 | * Register settings related to Donor Profiles |
| 12 | * |
| 13 | * @param array $settings |
| 14 | * @return array |
| 15 | * |
| 16 | * @since 2.10.0 |
| 17 | */ |
| 18 | public function register( $settings ) { |
| 19 | |
| 20 | $donorDashboardSettings = [ |
| 21 | $this->getDonorDashboardPageSetting(), |
| 22 | $this->donorDashboardPageIsPublished() ? $this->getOverrideLegacyDonationManagementPagesSetting() : null, |
| 23 | ]; |
| 24 | |
| 25 | return give_settings_array_insert( |
| 26 | $settings, |
| 27 | 'history_page', |
| 28 | $donorDashboardSettings |
| 29 | ); |
| 30 | } |
| 31 | |
| 32 | /** |
| 33 | * Return true if donor profile page is defined and published, false if not |
| 34 | * |
| 35 | * @return boolean |
| 36 | * |
| 37 | * @since 2.10.0 |
| 38 | */ |
| 39 | protected function donorDashboardPageIsPublished() { |
| 40 | $donorDashboardPageId = ! empty( give_get_option( 'donor_dashboard_page' ) ) ? give_get_option( 'donor_dashboard_page' ) : null; |
| 41 | return $donorDashboardPageId && get_post_status( $donorDashboardPageId ) === 'publish'; |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Return CMB2 compatible array used to render/control donor profile page setting |
| 46 | * |
| 47 | * @return array |
| 48 | * |
| 49 | * @since 2.10.0 |
| 50 | */ |
| 51 | protected function getDonorDashboardPageSetting() { |
| 52 | |
| 53 | $generateDonorDashboardPageUrl = add_query_arg( |
| 54 | [ |
| 55 | 'give-generate-donor-dashboard-page' => '1', |
| 56 | ], |
| 57 | admin_url( 'edit.php' ) |
| 58 | ); |
| 59 | |
| 60 | $generateDonorDashboardPageDesc = $this->donorDashboardPageIsPublished() ? '' : sprintf( __( ' Need helping setting one up? <a href="%s">Generate a new Donor Dashboard page.</a>', 'give' ), $generateDonorDashboardPageUrl ); |
| 61 | |
| 62 | return [ |
| 63 | 'name' => __( 'Donor Dashboard Page', 'give' ), |
| 64 | 'desc' => __( 'This is the page where donors can manage their information, review history and more -- all in one place. The Donor Dashboard block or <code>[give_donor_dashboard]</code> shortcode should be on this page. ', 'give' ) . $generateDonorDashboardPageDesc, |
| 65 | 'id' => 'donor_dashboard_page', |
| 66 | 'type' => 'select', |
| 67 | 'class' => 'give-select give-select-chosen', |
| 68 | 'options' => give_cmb2_get_post_options( |
| 69 | [ |
| 70 | 'post_type' => 'page', |
| 71 | 'numberposts' => 30, |
| 72 | ] |
| 73 | ), |
| 74 | 'attributes' => [ |
| 75 | 'data-search-type' => 'pages', |
| 76 | 'data-placeholder' => esc_html__( 'Choose a page', 'give' ), |
| 77 | ], |
| 78 | ]; |
| 79 | } |
| 80 | |
| 81 | /** |
| 82 | * Return CMB2 compatible array used to render/control override legacy donation manamgent pages setting |
| 83 | * |
| 84 | * @return array |
| 85 | * |
| 86 | * @since 2.10.0 |
| 87 | */ |
| 88 | protected function getOverrideLegacyDonationManagementPagesSetting() { |
| 89 | return [ |
| 90 | 'name' => esc_html__( 'Override Legacy Donation Management Pages', 'give' ), |
| 91 | 'desc' => esc_html__( 'Use the Donor Dashboard instead of the legacy donation management pages (Donation History, Edit Profile, Subscriptions, etc).', 'give' ), |
| 92 | 'id' => 'override_legacy_donation_management_pages', |
| 93 | 'wrapper_class' => 'override-legacy-donation-management-pages', |
| 94 | 'type' => 'radio_inline', |
| 95 | 'default' => 'enabled', |
| 96 | 'options' => [ |
| 97 | 'enabled' => esc_html__( 'Enabled', 'give' ), |
| 98 | 'disabled' => esc_html__( 'Disabled', 'give' ), |
| 99 | ], |
| 100 | ]; |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Generate donor profile page, and update site setting to use it |
| 105 | * |
| 106 | * @return void |
| 107 | * |
| 108 | * @since 2.10.0 |
| 109 | */ |
| 110 | public function generateDonorDashboardPage() { |
| 111 | |
| 112 | $content = $this->getDonorDashboardPageContent(); |
| 113 | |
| 114 | $pageId = wp_insert_post( |
| 115 | [ |
| 116 | 'comment_status' => 'close', |
| 117 | 'ping_status' => 'close', |
| 118 | 'post_author' => 1, |
| 119 | 'post_title' => __( 'Donor Dashboard', 'give' ), |
| 120 | 'post_status' => 'publish', |
| 121 | 'post_content' => $content, |
| 122 | 'post_type' => 'page', |
| 123 | ] |
| 124 | ); |
| 125 | |
| 126 | if ( $pageId ) { |
| 127 | |
| 128 | give_update_option( 'donor_dashboard_page', $pageId ); |
| 129 | |
| 130 | give_update_option( 'override_legacy_donation_management_pages', 'enabled' ); |
| 131 | |
| 132 | $overrideSettingsMap = [ |
| 133 | 'history_page', |
| 134 | 'subscriptions_page', |
| 135 | ]; |
| 136 | |
| 137 | foreach ( $overrideSettingsMap as $setting ) { |
| 138 | if ( give_get_option( $setting ) !== $pageId ) { |
| 139 | give_update_option( $setting, $pageId ); |
| 140 | } |
| 141 | } |
| 142 | } |
| 143 | |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Get default content for donor profile page, based on format (block vs shortcode) |
| 148 | * |
| 149 | * @param string $format |
| 150 | * @return string |
| 151 | * |
| 152 | * @since 2.10.0 |
| 153 | */ |
| 154 | protected function getDonorDashboardPageContent() { |
| 155 | |
| 156 | if ( $this->shouldGenerateWithBlock() ) { |
| 157 | return get_comment_delimited_block_content( |
| 158 | 'give/donor-dashboard', |
| 159 | [ |
| 160 | 'align' => 'wide', |
| 161 | ], |
| 162 | null |
| 163 | ); |
| 164 | } else { |
| 165 | return '[give_donor_dashboard]'; |
| 166 | } |
| 167 | |
| 168 | } |
| 169 | |
| 170 | /** |
| 171 | * Determine whether the Donor Dashboard page should be generated with a block |
| 172 | * |
| 173 | * @return bool |
| 174 | * |
| 175 | * @since 2.10.0 |
| 176 | */ |
| 177 | private function shouldGenerateWithBlock() { |
| 178 | |
| 179 | $usingBlocks = $this->isBlockEditorActive() || $this->isGutenbergEditorActive() ? true : false; |
| 180 | $usingClassicEditor = $this->isClassicEditorActive(); |
| 181 | $usingDisableGutenberg = $this->isDisableGutenbergActive(); |
| 182 | |
| 183 | if ( $usingClassicEditor === false && $usingDisableGutenberg === false && $usingBlocks ) { |
| 184 | return true; |
| 185 | } |
| 186 | |
| 187 | return false; |
| 188 | |
| 189 | } |
| 190 | |
| 191 | /** |
| 192 | * Determine whether the Gutenberg editor is active |
| 193 | * |
| 194 | * @return bool |
| 195 | * |
| 196 | * @since 2.10.0 |
| 197 | */ |
| 198 | private function isGutenbergEditorActive() { |
| 199 | if ( has_filter( 'replace_editor', 'gutenberg_init' ) ) { |
| 200 | // Gutenberg is installed and activated. |
| 201 | return true; |
| 202 | } |
| 203 | return false; |
| 204 | } |
| 205 | |
| 206 | /** |
| 207 | * Determine whether block editor is active |
| 208 | * |
| 209 | * @return bool |
| 210 | * |
| 211 | * @since 2.10.0 |
| 212 | */ |
| 213 | private function isBlockEditorActive() { |
| 214 | if ( version_compare( $GLOBALS['wp_version'], '5.0-beta', '>' ) ) { |
| 215 | // Block editor. |
| 216 | return true; |
| 217 | } |
| 218 | return false; |
| 219 | } |
| 220 | |
| 221 | /** |
| 222 | * Determine whether the Classic editor is active |
| 223 | * |
| 224 | * @return bool |
| 225 | * |
| 226 | * @since 2.10.0 |
| 227 | */ |
| 228 | private function isClassicEditorActive() { |
| 229 | |
| 230 | include_once ABSPATH . 'wp-admin/includes/plugin.php'; |
| 231 | |
| 232 | if ( is_plugin_active( 'classic-editor/classic-editor.php' ) && ( get_option( 'classic-editor-replace' ) !== 'no-replace' ) ) { |
| 233 | return true; |
| 234 | } |
| 235 | |
| 236 | return false; |
| 237 | |
| 238 | } |
| 239 | |
| 240 | /** |
| 241 | * Determine whether the Disable Gutenberg plugin is active |
| 242 | * |
| 243 | * @return bool |
| 244 | * |
| 245 | * @since 2.10.0 |
| 246 | */ |
| 247 | private function isDisableGutenbergActive() { |
| 248 | |
| 249 | include_once ABSPATH . 'wp-admin/includes/plugin.php'; |
| 250 | |
| 251 | if ( is_plugin_active( 'disable-gutenberg/disable-gutenberg.php' ) ) { |
| 252 | return true; |
| 253 | } |
| 254 | |
| 255 | return false; |
| 256 | |
| 257 | } |
| 258 | |
| 259 | /** |
| 260 | * Filter and override legacy donation management page settings |
| 261 | * |
| 262 | * @param array $settings |
| 263 | * @return array |
| 264 | * |
| 265 | * @since 2.10.0 |
| 266 | */ |
| 267 | public function overrideLegacyDonationManagementPageSettings( $settings ) { |
| 268 | |
| 269 | // Only override settings if the the override legacy donation management pages setting is enabled |
| 270 | if ( $this->donorDashboardPageIsPublished() && give_is_setting_enabled( give_get_option( 'override_legacy_donation_management_pages', 'enabled' ) ) ) { |
| 271 | |
| 272 | $pageId = give_get_option( 'donor_dashboard_page' ); |
| 273 | |
| 274 | $overrideSettingsMap = [ |
| 275 | 'history_page', |
| 276 | 'subscriptions_page', |
| 277 | ]; |
| 278 | |
| 279 | foreach ( $overrideSettingsMap as $setting ) { |
| 280 | if ( give_get_option( $setting ) !== $pageId ) { |
| 281 | give_update_option( $setting, $pageId ); |
| 282 | } |
| 283 | } |
| 284 | |
| 285 | // Hide settings that are overriden by Donor Profile setting |
| 286 | $key = 0; |
| 287 | foreach ( $settings as $setting ) { |
| 288 | if ( in_array( $setting['id'], $overrideSettingsMap ) ) { |
| 289 | unset( $settings[ $key ] ); |
| 290 | } |
| 291 | $key++; |
| 292 | } |
| 293 | } |
| 294 | |
| 295 | return $settings; |
| 296 | } |
| 297 | |
| 298 | } |
| 299 |