notice.php
568 lines
| 1 | <?php |
| 2 | namespace Oxaim\Libs; |
| 3 | |
| 4 | defined( 'ABSPATH' ) || exit; |
| 5 | |
| 6 | if(!class_exists('\Oxaim\Libs\Notice')): |
| 7 | |
| 8 | class Notice{ |
| 9 | |
| 10 | /** |
| 11 | * scripts version |
| 12 | * |
| 13 | * @var string |
| 14 | */ |
| 15 | protected $script_version = '2.2.0'; |
| 16 | |
| 17 | /** |
| 18 | * Unique ID to identify each notice |
| 19 | * |
| 20 | * @var string |
| 21 | */ |
| 22 | protected $notice_id; |
| 23 | |
| 24 | /** |
| 25 | * Plugin text-domain |
| 26 | * |
| 27 | * @var string |
| 28 | */ |
| 29 | protected $text_domain; |
| 30 | |
| 31 | |
| 32 | /** |
| 33 | * Unique ID |
| 34 | * |
| 35 | * @var string |
| 36 | */ |
| 37 | protected $unique_id; |
| 38 | |
| 39 | |
| 40 | /** |
| 41 | * Notice div container's class |
| 42 | * |
| 43 | * @var string |
| 44 | */ |
| 45 | protected $class; |
| 46 | |
| 47 | |
| 48 | /** |
| 49 | * Single button's data |
| 50 | * |
| 51 | * @var array |
| 52 | */ |
| 53 | protected $button; |
| 54 | |
| 55 | |
| 56 | /** |
| 57 | * Size class |
| 58 | * |
| 59 | * @var array |
| 60 | */ |
| 61 | protected $size; |
| 62 | |
| 63 | |
| 64 | /** |
| 65 | * List of all buttons with it's config data |
| 66 | * |
| 67 | * @var array |
| 68 | */ |
| 69 | protected $buttons; |
| 70 | |
| 71 | /** |
| 72 | * Notice title |
| 73 | * |
| 74 | * @var string |
| 75 | */ |
| 76 | protected $title; |
| 77 | |
| 78 | |
| 79 | /** |
| 80 | * Notice message |
| 81 | * |
| 82 | * @var string |
| 83 | */ |
| 84 | protected $message; |
| 85 | |
| 86 | /** |
| 87 | * Left logo |
| 88 | * |
| 89 | * @var string |
| 90 | */ |
| 91 | protected $logo; |
| 92 | /** |
| 93 | * Container gutter |
| 94 | * |
| 95 | * @var string |
| 96 | */ |
| 97 | protected $gutter; |
| 98 | |
| 99 | /** |
| 100 | * Left logo style |
| 101 | * |
| 102 | * @var string |
| 103 | */ |
| 104 | protected $logo_style; |
| 105 | |
| 106 | |
| 107 | /** |
| 108 | * Left logo style |
| 109 | * |
| 110 | * @var string |
| 111 | */ |
| 112 | protected $dismissible; |
| 113 | |
| 114 | protected $expired_time; |
| 115 | |
| 116 | |
| 117 | |
| 118 | /** |
| 119 | * html markup for notice |
| 120 | * |
| 121 | * @var string |
| 122 | */ |
| 123 | protected $html; |
| 124 | |
| 125 | |
| 126 | |
| 127 | /** |
| 128 | * get_version |
| 129 | * |
| 130 | * @return string |
| 131 | */ |
| 132 | public function get_version(){ |
| 133 | return $this->script_version; |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * get_script_location |
| 138 | * |
| 139 | * @return string |
| 140 | */ |
| 141 | public function get_script_location(){ |
| 142 | return __FILE__; |
| 143 | } |
| 144 | |
| 145 | // config |
| 146 | |
| 147 | /** |
| 148 | * Configures all setter variables |
| 149 | * |
| 150 | * @param string $prefix |
| 151 | * @return void |
| 152 | */ |
| 153 | public function config($text_domain = '', $unique_id = ''){ |
| 154 | $this->text_domain = $text_domain; |
| 155 | |
| 156 | $this->unique_id = $unique_id; |
| 157 | |
| 158 | $this->notice_id = $text_domain . '-' . $unique_id; |
| 159 | |
| 160 | $this->dismissible = false; // false, user, global |
| 161 | |
| 162 | $this->expired_time = 1; |
| 163 | |
| 164 | $this->html = ''; |
| 165 | |
| 166 | $this->title = ''; |
| 167 | |
| 168 | $this->message = ''; |
| 169 | |
| 170 | $this->class = ''; |
| 171 | |
| 172 | $this->gutter = true; |
| 173 | |
| 174 | $this->logo = ''; |
| 175 | |
| 176 | $this->logo_style = ''; |
| 177 | |
| 178 | $this->size = [ ]; |
| 179 | |
| 180 | $this->button = [ |
| 181 | 'default_class' => 'button', |
| 182 | 'class' => 'button-secondary ', // button-primary button-secondary button-small button-large button-link |
| 183 | 'text' => 'Button', |
| 184 | 'url' => '#', |
| 185 | 'icon' => '' |
| 186 | ]; |
| 187 | |
| 188 | $this->buttons = []; |
| 189 | |
| 190 | return $this; |
| 191 | } |
| 192 | |
| 193 | // setters begin |
| 194 | |
| 195 | /** |
| 196 | * Adds classes to the container |
| 197 | * |
| 198 | * @param string $classname |
| 199 | * @return void |
| 200 | */ |
| 201 | public function set_class($classname = ''){ |
| 202 | $this->class .= $classname; |
| 203 | |
| 204 | return $this; |
| 205 | } |
| 206 | |
| 207 | public function set_type($type = ''){ |
| 208 | $this->class .= ' notice-' . $type; |
| 209 | |
| 210 | return $this; |
| 211 | } |
| 212 | |
| 213 | public function set_button($button = []){ |
| 214 | $button = array_merge($this->button, $button); |
| 215 | $this->buttons[] = $button; |
| 216 | |
| 217 | return $this; |
| 218 | } |
| 219 | |
| 220 | public function set_id($id){ |
| 221 | $this->notice_id = $id; |
| 222 | return $this; |
| 223 | } |
| 224 | |
| 225 | public function set_title($title = ''){ |
| 226 | $this->title .= $title; |
| 227 | |
| 228 | return $this; |
| 229 | } |
| 230 | |
| 231 | public function set_message($message = ''){ |
| 232 | $this->message .= $message; |
| 233 | |
| 234 | return $this; |
| 235 | } |
| 236 | |
| 237 | public function set_gutter($gutter = true){ |
| 238 | $this->gutter .= $gutter; |
| 239 | $this->class .= ($gutter === true ? '' : ' no-gutter'); |
| 240 | |
| 241 | return $this; |
| 242 | } |
| 243 | |
| 244 | public function set_logo($logo = '', $logo_style = ""){ |
| 245 | $this->logo = $logo; |
| 246 | |
| 247 | $this->logo_style = $logo_style; |
| 248 | |
| 249 | return $this; |
| 250 | } |
| 251 | |
| 252 | public function set_html($html = ''){ |
| 253 | $this->html .= $html; |
| 254 | |
| 255 | return $this; |
| 256 | } |
| 257 | |
| 258 | // setters ends |
| 259 | |
| 260 | |
| 261 | // group getter |
| 262 | public function get_data(){ |
| 263 | return [ |
| 264 | 'message' => $this->message, |
| 265 | 'title' => $this->title, |
| 266 | 'buttons' => $this->buttons, |
| 267 | 'class' => $this->class, |
| 268 | 'html' => $this->html, |
| 269 | ]; |
| 270 | } |
| 271 | |
| 272 | |
| 273 | |
| 274 | |
| 275 | public function call(){ |
| 276 | add_action( 'admin_notices', [$this, 'get_notice'] ); |
| 277 | } |
| 278 | |
| 279 | public function get_notice(){ |
| 280 | // dismissible conditions |
| 281 | if ( 'user' === $this->dismissible) { |
| 282 | $expired = get_user_meta( get_current_user_id(), $this->notice_id, true ); |
| 283 | } elseif ( 'global' === $this->dismissible ) { |
| 284 | $expired = get_transient( $this->notice_id ); |
| 285 | }else{ |
| 286 | $expired = ''; |
| 287 | } |
| 288 | |
| 289 | global $oxaim_lib_notice_list; |
| 290 | |
| 291 | if(!isset($oxaim_lib_notice_list[$this->notice_id])){ |
| 292 | $oxaim_lib_notice_list[$this->notice_id] = __FILE__; |
| 293 | |
| 294 | // is transient expired? |
| 295 | if ( false === $expired || empty( $expired ) ) { |
| 296 | $this->generate_html(); |
| 297 | } |
| 298 | } |
| 299 | } |
| 300 | |
| 301 | public function set_dismiss($scope = 'global', $time = (3600 * 24 * 7)){ |
| 302 | $this->dismissible = $scope; |
| 303 | $this->expired_time = $time; |
| 304 | |
| 305 | return $this; |
| 306 | } |
| 307 | |
| 308 | /** |
| 309 | * URL schemes accepted inside notice markup. |
| 310 | */ |
| 311 | public static function allowed_protocols() { |
| 312 | return ['http', 'https', 'mailto']; |
| 313 | } |
| 314 | |
| 315 | /** |
| 316 | * HTML allowed inside a notice body. |
| 317 | * |
| 318 | * Callers may hand this class markup that originated from a remote API |
| 319 | * (see \Wpmet\Libs\Banner), so output is filtered here rather than |
| 320 | * trusted. Kept self-contained on purpose: this file is a shared library |
| 321 | * and whichever wpmet plugin loads first wins the class_exists() guard, |
| 322 | * so it must not depend on any single plugin's helper being present. |
| 323 | * |
| 324 | * Event handler attributes (on*) need no explicit rule -- wp_kses() drops |
| 325 | * every attribute that is not listed below. |
| 326 | */ |
| 327 | public static function allowed_html() { |
| 328 | |
| 329 | $common = [ |
| 330 | 'class' => [], |
| 331 | 'style' => [], |
| 332 | 'title' => [], |
| 333 | 'id' => [], |
| 334 | ]; |
| 335 | |
| 336 | return [ |
| 337 | 'a' => array_merge($common, ['href' => [], 'target' => [], 'rel' => []]), |
| 338 | 'b' => $common, |
| 339 | 'br' => [], |
| 340 | 'div' => $common, |
| 341 | 'em' => $common, |
| 342 | 'h1' => $common, |
| 343 | 'h2' => $common, |
| 344 | 'h3' => $common, |
| 345 | 'h4' => $common, |
| 346 | 'h5' => $common, |
| 347 | 'h6' => $common, |
| 348 | 'i' => $common, |
| 349 | 'img' => array_merge($common, ['src' => [], 'alt' => [], 'width' => [], 'height' => []]), |
| 350 | 'li' => $common, |
| 351 | 'ol' => $common, |
| 352 | 'p' => $common, |
| 353 | 'small' => $common, |
| 354 | 'span' => $common, |
| 355 | 'strong' => $common, |
| 356 | 'u' => $common, |
| 357 | 'ul' => $common, |
| 358 | ]; |
| 359 | } |
| 360 | |
| 361 | public function generate_html() { |
| 362 | |
| 363 | ?> |
| 364 | <div |
| 365 | id="<?php echo esc_attr($this->notice_id); ?>" |
| 366 | class="notice wpmet-notice notice-<?php echo esc_attr($this->notice_id . ' ' .$this->class); ?> <?php echo (false === $this->dismissible ? '' : 'is-dismissible') ;?>" |
| 367 | |
| 368 | expired_time="<?php echo esc_attr($this->expired_time); ?>" |
| 369 | dismissible="<?php echo esc_attr($this->dismissible); ?>" |
| 370 | > |
| 371 | <?php if(!empty($this->logo)):?> |
| 372 | <img class="notice-logo" style="<?php echo esc_attr($this->logo_style); ?>" src="<?php echo esc_url($this->logo);?>" /> |
| 373 | <?php endif; ?> |
| 374 | |
| 375 | <div class="notice-right-container <?php echo (empty($this->logo) ? 'notice-container-full-width' : ''); ?>"> |
| 376 | |
| 377 | <?php if(empty($this->html)): ?> |
| 378 | <?php echo (empty($this->title) ? '' : sprintf('<div class="notice-main-title notice-vert-space">%s</div>', esc_html($this->title))); ?> |
| 379 | |
| 380 | <div class="notice-message notice-vert-space"> |
| 381 | <?php echo wp_kses($this->message, self::allowed_html(), self::allowed_protocols()); ?> |
| 382 | </div> |
| 383 | |
| 384 | <?php if(!empty($this->buttons)): ?> |
| 385 | <div class="button-container notice-vert-space"> |
| 386 | <?php foreach($this->buttons as $button): |
| 387 | $is_target_blank = isset($button['target']) && $button['target'] === '_blank' ? 'target="_blank"' : ''; |
| 388 | ?> |
| 389 | <a <?php echo esc_attr($is_target_blank); ?> id="<?php echo (!isset($button['id']) ? '' : esc_attr($button['id'])); ?>" href="<?php echo esc_url($button['url']); ?>" class="wpmet-notice-button <?php echo esc_attr($button['class']); ?>"> |
| 390 | <?php if(!empty($button['icon'])) :?> |
| 391 | <i class="notice-icon <?php echo esc_attr($button['icon']); ?>"></i> |
| 392 | <?php endif; ?> |
| 393 | <?php echo esc_html($button['text']);?> |
| 394 | </a> |
| 395 | |
| 396 | <?php endforeach; ?> |
| 397 | </div> |
| 398 | <?php endif;?> |
| 399 | |
| 400 | <?php else:?> |
| 401 | <?php echo wp_kses($this->html, self::allowed_html(), self::allowed_protocols()); ?> |
| 402 | <?php endif;?> |
| 403 | |
| 404 | </div> |
| 405 | |
| 406 | <?php if(false !== $this->dismissible): ?> |
| 407 | <button type="button" class="notice-dismiss"> |
| 408 | <span class="screen-reader-text">x</span> |
| 409 | </button> |
| 410 | <?php endif;?> |
| 411 | |
| 412 | <div style="clear:both"></div> |
| 413 | |
| 414 | </div> |
| 415 | <?php |
| 416 | } |
| 417 | |
| 418 | public static function init(){ |
| 419 | add_action( 'wp_ajax_wpmet-notices', [ __CLASS__, 'dismiss_ajax_call' ] ); |
| 420 | add_action( 'admin_head', [ __CLASS__, 'enqueue_scripts' ] ); |
| 421 | } |
| 422 | |
| 423 | public static function dismiss_ajax_call() { |
| 424 | if(empty( $_REQUEST['_wpnonce'] ) || !wp_verify_nonce(sanitize_text_field(wp_unslash($_REQUEST['_wpnonce'])),'wpmet-notices')){ |
| 425 | wp_send_json_error(); |
| 426 | } |
| 427 | |
| 428 | $notice_id = ( isset( $_POST['notice_id'] ) ) ? sanitize_text_field(wp_unslash($_POST['notice_id'])) : ''; |
| 429 | $dismissible = ( isset( $_POST['dismissible'] ) ) ? sanitize_text_field(wp_unslash($_POST['dismissible'])) : ''; |
| 430 | $expired_time = ( isset( $_POST['expired_time'] ) ) ? sanitize_text_field(wp_unslash($_POST['expired_time'])) : ''; |
| 431 | |
| 432 | if ( ! empty( $notice_id ) ) { |
| 433 | if ( 'user' === $dismissible ) { |
| 434 | update_user_meta( get_current_user_id(), $notice_id, true ); |
| 435 | } else { |
| 436 | set_transient( $notice_id, true, $expired_time ); |
| 437 | } |
| 438 | |
| 439 | if( $notice_id == 'shopengine-edit_with_emailkit_banner' ) { |
| 440 | $counter = get_option('shopengine-edit_with_emailkit_banner_dismissed_'.get_current_user_id(), 0); |
| 441 | update_option('shopengine-edit_with_emailkit_banner_dismissed_'.get_current_user_id(), $counter+1); |
| 442 | } |
| 443 | |
| 444 | wp_send_json_success(); |
| 445 | } |
| 446 | |
| 447 | wp_send_json_error(); |
| 448 | } |
| 449 | |
| 450 | public static function enqueue_scripts() { |
| 451 | echo " |
| 452 | <script> |
| 453 | jQuery(document).ready(function ($) { |
| 454 | $( '.wpmet-notice.is-dismissible' ).on( 'click', '.notice-dismiss', function() { |
| 455 | |
| 456 | _this = $( this ).parents('.wpmet-notice').eq(0); |
| 457 | var notice_id = _this.attr( 'id' ) || ''; |
| 458 | var expired_time = _this.attr( 'expired_time' ) || ''; |
| 459 | var dismissible = _this.attr( 'dismissible' ) || ''; |
| 460 | var x = $( this ).attr('class'); |
| 461 | |
| 462 | // console.log({ |
| 463 | // _this, x, notice_id, expired_time, dismissible |
| 464 | // }); |
| 465 | // return; |
| 466 | |
| 467 | _this.hide(); |
| 468 | |
| 469 | $.ajax({ |
| 470 | url: ajaxurl, |
| 471 | type: 'POST', |
| 472 | data: { |
| 473 | action : 'wpmet-notices', |
| 474 | notice_id : notice_id, |
| 475 | dismissible : dismissible, |
| 476 | expired_time : expired_time, |
| 477 | _wpnonce : '".esc_html(wp_create_nonce('wpmet-notices'))."', |
| 478 | }, |
| 479 | }); |
| 480 | }); |
| 481 | }); |
| 482 | </script> |
| 483 | <style> |
| 484 | .wpmet-notice{ |
| 485 | margin: 5px 0 15px; |
| 486 | padding: 0!important; |
| 487 | display: flex; |
| 488 | flex-direction: row; |
| 489 | justify-content: flex-start; |
| 490 | align-items: center; |
| 491 | } |
| 492 | |
| 493 | .wpmet-notice .notice-right-container{ |
| 494 | margin: .7rem .8rem .8rem; |
| 495 | } |
| 496 | |
| 497 | .notice-container-full-width{ |
| 498 | width:100%!important; |
| 499 | } |
| 500 | |
| 501 | .wpmet-notice.no-gutter, .wpmet-notice.no-gutter .notice-right-container{ |
| 502 | padding: 0!important; |
| 503 | margin: 0!important; |
| 504 | } |
| 505 | |
| 506 | .notice-right-container .notice-vert-space{ |
| 507 | margin-bottom: .8rem; |
| 508 | } |
| 509 | |
| 510 | .notice-right-container .notice-vert-space:last-child, |
| 511 | .notice-right-container .notice-vert-space:only-child{ |
| 512 | margin-bottom: 0; |
| 513 | } |
| 514 | |
| 515 | .wpmet-notice .notice-logo{ |
| 516 | padding: .8rem; |
| 517 | max-width: 110px; |
| 518 | max-height: 110px; |
| 519 | } |
| 520 | |
| 521 | .wpmet-notice-button { |
| 522 | text-decoration:none; |
| 523 | } |
| 524 | |
| 525 | .wpmet-notice-button > i{ |
| 526 | margin-right: 3px; |
| 527 | } |
| 528 | |
| 529 | .wpmet-notice-button .notice-icon{ |
| 530 | display:inline-block; |
| 531 | } |
| 532 | |
| 533 | .wpmet-notice-button .notice-icon:before{ |
| 534 | vertical-align: middle!important; |
| 535 | margin-top: -1px; |
| 536 | } |
| 537 | |
| 538 | .wpmet-notice .notice-main-title{ |
| 539 | color: #1d2327; |
| 540 | font-size: 1.2rem; |
| 541 | } |
| 542 | |
| 543 | </style> |
| 544 | "; |
| 545 | } |
| 546 | |
| 547 | |
| 548 | private static $instance; |
| 549 | |
| 550 | /** |
| 551 | * Method: instance -> Return Notice module class instance |
| 552 | * |
| 553 | * @param string|null $text_domain |
| 554 | * @param string|null $unique_id |
| 555 | * @return mixed |
| 556 | */ |
| 557 | public static function instance($text_domain = null, $unique_id = null) { |
| 558 | if($text_domain == null){ |
| 559 | return false; |
| 560 | } |
| 561 | |
| 562 | self::$instance = new self(); |
| 563 | |
| 564 | return self::$instance->config($text_domain, (is_null($unique_id) ? uniqid() : $unique_id)); |
| 565 | } |
| 566 | } |
| 567 | |
| 568 | endif; |