AdminNoticesService.php
182 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\WordPress\Admin\Notices; |
| 4 | |
| 5 | /** |
| 6 | * Admin notices service |
| 7 | */ |
| 8 | class AdminNoticesService { |
| 9 | /** |
| 10 | * Notice key. |
| 11 | * |
| 12 | * @var string |
| 13 | */ |
| 14 | protected $notice_key = 'surecart_dismissed_notice'; |
| 15 | |
| 16 | /** |
| 17 | * Showing the response notice? |
| 18 | * |
| 19 | * @var boolean |
| 20 | */ |
| 21 | protected $showing_response_notice = false; |
| 22 | |
| 23 | /** |
| 24 | * Bootstrap notice dismissal. |
| 25 | * |
| 26 | * @return void |
| 27 | */ |
| 28 | public function bootstrap() { |
| 29 | add_action( 'admin_init', [ $this, 'dismiss' ] ); |
| 30 | } |
| 31 | |
| 32 | /** |
| 33 | * Is the notice dismissed. |
| 34 | * |
| 35 | * @param string $name Notice name. |
| 36 | * |
| 37 | * @return boolean |
| 38 | */ |
| 39 | public function isDismissed( $name ) { |
| 40 | return (bool) get_option( $this->notice_key . '_' . sanitize_text_field( $name ), false ); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * Dismiss the notice. |
| 45 | * |
| 46 | * @return void |
| 47 | */ |
| 48 | public function dismiss() { |
| 49 | // permissions check. |
| 50 | if ( ! current_user_can( 'manage_options' ) ) { |
| 51 | return; |
| 52 | } |
| 53 | |
| 54 | // not our notices, bail. |
| 55 | if ( ! isset( $_GET['surecart_action'] ) || 'dismiss_notices' !== sanitize_text_field( wp_unslash( $_GET['surecart_action'] ) ) ) { |
| 56 | return; |
| 57 | } |
| 58 | |
| 59 | // get notice. |
| 60 | $notice = ! empty( $_GET['surecart_notice'] ) ? sanitize_text_field( wp_unslash( $_GET['surecart_notice'] ) ) : ''; |
| 61 | if ( ! $notice ) { |
| 62 | return; |
| 63 | } |
| 64 | |
| 65 | // verify nonce. |
| 66 | if ( ! wp_verify_nonce( sanitize_text_field( $_GET['surecart_nonce'] ), 'surecart_notice_nonce' ) ) { |
| 67 | wp_die( esc_html__( 'Your session expired - please try again.', 'surecart' ) ); |
| 68 | exit; |
| 69 | } |
| 70 | |
| 71 | // notice is dismissed. |
| 72 | update_option( $this->notice_key . '_' . sanitize_text_field( $notice ), 1 ); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Show the response notice. |
| 77 | * |
| 78 | * @param array $notice Notice data to show. |
| 79 | * |
| 80 | * @return void |
| 81 | */ |
| 82 | public function showResponseNotice( $notice = [] ) { |
| 83 | // already showing it. |
| 84 | if ( $this->showing_response_notice ) { |
| 85 | return; |
| 86 | } |
| 87 | |
| 88 | // phpcs:disable WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode |
| 89 | $notice_data = json_decode( base64_decode( implode( '', (array) $notice ) ) ); |
| 90 | if ( empty( $notice_data->message ) ) { |
| 91 | return; |
| 92 | } |
| 93 | |
| 94 | $this->showing_response_notice = true; |
| 95 | |
| 96 | add_action( |
| 97 | 'admin_notices', |
| 98 | function() use ( $notice_data ) { |
| 99 | echo wp_kses_post( |
| 100 | $this->render( |
| 101 | [ |
| 102 | 'name' => 'update_notice_' . \SureCart::plugin()->version(), |
| 103 | 'type' => sanitize_text_field( $notice_data->type ), |
| 104 | 'title' => esc_html__( 'SureCart', 'surecart' ), |
| 105 | 'text' => wp_kses_post( $notice_data->message ), |
| 106 | ] |
| 107 | ) |
| 108 | ); |
| 109 | } |
| 110 | ); |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * Add the notice. |
| 115 | * |
| 116 | * @return void |
| 117 | */ |
| 118 | public function add( $notice_data ) { |
| 119 | add_action( |
| 120 | 'admin_notices', |
| 121 | function() use ( $notice_data ) { |
| 122 | echo wp_kses_post( |
| 123 | $this->render( $notice_data ) |
| 124 | ); |
| 125 | } |
| 126 | ); |
| 127 | } |
| 128 | |
| 129 | /** |
| 130 | * Render the notice |
| 131 | * |
| 132 | * @return string |
| 133 | */ |
| 134 | public function render( $args = [] ) { |
| 135 | $args = wp_parse_args( |
| 136 | $args, |
| 137 | [ |
| 138 | 'title' => '', |
| 139 | 'type' => 'info', |
| 140 | 'text' => '', |
| 141 | 'name' => '', |
| 142 | ] |
| 143 | ); |
| 144 | |
| 145 | if ( $this->isDismissed( $args['name'] ) ) { |
| 146 | return ''; |
| 147 | } |
| 148 | |
| 149 | ob_start(); ?> |
| 150 | |
| 151 | <div class="notice notice-<?php echo sanitize_html_class( $args['type'] ); ?>" style="position:relative"> |
| 152 | <p> |
| 153 | <strong> |
| 154 | <?php echo esc_html( $args['title'] ); ?> |
| 155 | </strong> |
| 156 | </p> |
| 157 | |
| 158 | <?php echo wp_kses_post( $args['text'] ); ?> |
| 159 | |
| 160 | <?php if ( ! empty( $args['name'] ) ) : ?> |
| 161 | <a href=" |
| 162 | <?php |
| 163 | echo esc_url( |
| 164 | add_query_arg( |
| 165 | [ |
| 166 | 'surecart_action' => 'dismiss_notices', |
| 167 | 'surecart_notice' => sanitize_text_field( $args['name'] ), |
| 168 | 'surecart_nonce' => \wp_create_nonce( 'surecart_notice_nonce' ), |
| 169 | ] |
| 170 | ) |
| 171 | ); |
| 172 | ?> |
| 173 | " type="button" class="notice-dismiss" style="text-decoration:none;"><span class="screen-reader-text">Dismiss this notice.</span></a> |
| 174 | |
| 175 | <?php endif; ?> |
| 176 | </div> |
| 177 | |
| 178 | <?php |
| 179 | return ob_get_clean(); |
| 180 | } |
| 181 | } |
| 182 |