<?php

[0] Fix | Delete

namespace Automattic\WooCommerce\Blocks\Domain\Services;

[1] Fix | Delete

[2] Fix | Delete

use Automattic\WooCommerce\Blocks\Domain\Package;

[3] Fix | Delete

use Automattic\WooCommerce\Blocks\Utils\CartCheckoutUtils;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Service class for adding new-style Notices to WooCommerce core.

[7] Fix | Delete

*

[8] Fix | Delete

* @internal

[9] Fix | Delete

*/

[10] Fix | Delete

class Notices {

[11] Fix | Delete

/**

[12] Fix | Delete

* Holds the Package instance

[13] Fix | Delete

*

[14] Fix | Delete

* @var Package

[15] Fix | Delete

*/

[16] Fix | Delete

private $package;

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Templates used for notices.

[20] Fix | Delete

*

[21] Fix | Delete

* @var array

[22] Fix | Delete

*/

[23] Fix | Delete

private $notice_templates = array(

[24] Fix | Delete

'notices/error.php',

[25] Fix | Delete

'notices/notice.php',

[26] Fix | Delete

'notices/success.php',

[27] Fix | Delete

);

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Constructor

[31] Fix | Delete

*

[32] Fix | Delete

* @param Package $package An instance of the package class.

[33] Fix | Delete

*/

[34] Fix | Delete

public function __construct( Package $package ) {

[35] Fix | Delete

$this->package = $package;

[36] Fix | Delete

}

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Initialize notice hooks.

[40] Fix | Delete

*/

[41] Fix | Delete

public function init() {

[42] Fix | Delete

add_action(

[43] Fix | Delete

'after_setup_theme',

[44] Fix | Delete

function () {

[45] Fix | Delete

/**

[46] Fix | Delete

* Allow classic theme developers to opt-in to using block notices.

[47] Fix | Delete

*

[48] Fix | Delete

* @since 8.8.0

[49] Fix | Delete

* @param bool $use_block_notices_in_classic_theme Whether to use block notices in classic theme.

[50] Fix | Delete

* @return bool

[51] Fix | Delete

*/

[52] Fix | Delete

if ( wp_is_block_theme() || apply_filters( 'woocommerce_use_block_notices_in_classic_theme', false ) ) {

[53] Fix | Delete

add_filter( 'wc_get_template', [ $this, 'get_notices_template' ], 10, 5 );

[54] Fix | Delete

}

[55] Fix | Delete

}

[56] Fix | Delete

);

[57] Fix | Delete

[58] Fix | Delete

add_filter( 'woocommerce_kses_notice_allowed_tags', [ $this, 'add_kses_notice_allowed_tags' ] );

[59] Fix | Delete

add_action( 'wp_head', [ $this, 'enqueue_notice_styles' ] );

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Allow SVG icon in notices.

[64] Fix | Delete

*

[65] Fix | Delete

* @param array $allowed_tags Allowed tags.

[66] Fix | Delete

* @return array

[67] Fix | Delete

*/

[68] Fix | Delete

public function add_kses_notice_allowed_tags( $allowed_tags ) {

[69] Fix | Delete

$svg_args = array(

[70] Fix | Delete

'svg' => array(

[71] Fix | Delete

'aria-hidden' => true,

[72] Fix | Delete

'xmlns' => true,

[73] Fix | Delete

'width' => true,

[74] Fix | Delete

'height' => true,

[75] Fix | Delete

'viewbox' => true,

[76] Fix | Delete

'focusable' => true,

[77] Fix | Delete

),

[78] Fix | Delete

'path' => array(

[79] Fix | Delete

'd' => true,

[80] Fix | Delete

),

[81] Fix | Delete

);

[82] Fix | Delete

return array_merge( $allowed_tags, $svg_args );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* Replaces core notice templates with those from blocks.

[87] Fix | Delete

*

[88] Fix | Delete

* The new notice templates match block components with matching icons and styling. The differences are:

[89] Fix | Delete

* 1. Core has notices for info, success, and error notices, blocks has notices for info, success, error,

[90] Fix | Delete

* warning, and a default notice type.

[91] Fix | Delete

* 2. The block notices use different CSS classes to the core notices. Core uses `woocommerce-message`, `is-info`

[92] Fix | Delete

* and `is-error` classes, blocks uses `wc-block-components-notice-banner is-error`,

[93] Fix | Delete

* `wc-block-components-notice-banner is-info`, and `wc-block-components-notice-banner is-success`.

[94] Fix | Delete

* 3. The markup of the notices is different, with the block notices using SVG icons and a slightly different

[95] Fix | Delete

* structure to accommodate this.

[96] Fix | Delete

*

[97] Fix | Delete

* @param string $template Located template path.

[98] Fix | Delete

* @param string $template_name Template name.

[99] Fix | Delete

* @param array $args Template arguments.

[100] Fix | Delete

* @param string $template_path Template path.

[101] Fix | Delete

* @param string $default_path Default path.

[102] Fix | Delete

* @return string

[103] Fix | Delete

*/

[104] Fix | Delete

public function get_notices_template( $template, $template_name, $args, $template_path, $default_path ) {

[105] Fix | Delete

if ( in_array( $template_name, $this->notice_templates, true ) ) {

[106] Fix | Delete

$directory = get_stylesheet_directory();

[107] Fix | Delete

$file = $directory . '/woocommerce/' . $template_name;

[108] Fix | Delete

[109] Fix | Delete

if ( file_exists( $file ) ) {

[110] Fix | Delete

return $file;

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

$template = $this->package->get_path( 'templates/block-' . $template_name );

[114] Fix | Delete

wp_enqueue_style( 'wc-blocks-style' );

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

return $template;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

/**

[121] Fix | Delete

* Replaces all notices with the new block-based notices.

[122] Fix | Delete

*

[123] Fix | Delete

* @return void

[124] Fix | Delete

*/

[125] Fix | Delete

public function enqueue_notice_styles() {

[126] Fix | Delete

wp_enqueue_style( 'wc-blocks-style' );

[127] Fix | Delete

}

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete