Renderer
1 month ago
class-coupon-code-generator.php
2 months ago
class-initializer.php
2 months ago
class-initializer.php
120 lines
| 1 | <?php |
| 2 | /** |
| 3 | * This file is part of the WooCommerce Email Editor package |
| 4 | * |
| 5 | * @package Automattic\WooCommerce\EmailEditor |
| 6 | */ |
| 7 | |
| 8 | declare( strict_types = 1 ); |
| 9 | namespace Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce; |
| 10 | |
| 11 | use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; |
| 12 | use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Abstract_Block_Renderer; |
| 13 | use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Fallback; |
| 14 | use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks\Coupon_Code; |
| 15 | use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks\Product_Button; |
| 16 | use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks\Product_Collection; |
| 17 | use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks\Product_Image; |
| 18 | use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks\Product_Price; |
| 19 | use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks\Product_Sale_Badge; |
| 20 | |
| 21 | /** |
| 22 | * Initializes the WooCommerce blocks renderers. |
| 23 | */ |
| 24 | class Initializer { |
| 25 | /** |
| 26 | * List of supported WooCommerce blocks in the email editor. |
| 27 | */ |
| 28 | const ALLOWED_BLOCK_TYPES = array( |
| 29 | 'woocommerce/product-collection', |
| 30 | 'woocommerce/product-image', |
| 31 | 'woocommerce/product-price', |
| 32 | 'woocommerce/product-button', |
| 33 | 'woocommerce/product-sale-badge', |
| 34 | 'woocommerce/coupon-code', |
| 35 | ); |
| 36 | |
| 37 | /** |
| 38 | * Cache renderers by block name. |
| 39 | * |
| 40 | * @var array<string, Abstract_Block_Renderer> |
| 41 | */ |
| 42 | private array $renderers = array(); |
| 43 | |
| 44 | /** |
| 45 | * Set `supports.email = true` and configure render_email_callback for supported blocks. |
| 46 | * |
| 47 | * @param array $settings Block settings. |
| 48 | * @return array |
| 49 | */ |
| 50 | public function update_block_settings( array $settings ): array { |
| 51 | if ( in_array( $settings['name'], self::ALLOWED_BLOCK_TYPES, true ) ) { |
| 52 | $settings['supports']['email'] = true; |
| 53 | $settings['render_email_callback'] = array( $this, 'render_block' ); |
| 54 | } |
| 55 | |
| 56 | // Enable full-width alignment support for the product image block. |
| 57 | if ( 'woocommerce/product-image' === $settings['name'] ) { |
| 58 | $settings['supports']['align'] = array( 'full' ); |
| 59 | } |
| 60 | |
| 61 | return $settings; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Returns the block content rendered by the block renderer. |
| 66 | * |
| 67 | * @param string $block_content Block content. |
| 68 | * @param array $parsed_block Parsed block settings. |
| 69 | * @param Rendering_Context $rendering_context Rendering context. |
| 70 | * @return string |
| 71 | */ |
| 72 | public function render_block( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { |
| 73 | if ( isset( $parsed_block['blockName'] ) ) { |
| 74 | $block_renderer = $this->get_block_renderer( $parsed_block['blockName'] ); |
| 75 | return $block_renderer->render( $block_content, $parsed_block, $rendering_context ); |
| 76 | } |
| 77 | |
| 78 | return $block_content; |
| 79 | } |
| 80 | |
| 81 | /** |
| 82 | * Return an instance of Abstract_Block_Renderer by the block name. |
| 83 | * |
| 84 | * @param string $block_name Block name. |
| 85 | * @return Abstract_Block_Renderer |
| 86 | */ |
| 87 | private function get_block_renderer( string $block_name ): Abstract_Block_Renderer { |
| 88 | if ( isset( $this->renderers[ $block_name ] ) ) { |
| 89 | return $this->renderers[ $block_name ]; |
| 90 | } |
| 91 | |
| 92 | switch ( $block_name ) { |
| 93 | case 'woocommerce/product-image': |
| 94 | $renderer = new Product_Image(); |
| 95 | break; |
| 96 | case 'woocommerce/product-price': |
| 97 | $renderer = new Product_Price(); |
| 98 | break; |
| 99 | case 'woocommerce/product-sale-badge': |
| 100 | $renderer = new Product_Sale_Badge(); |
| 101 | break; |
| 102 | case 'woocommerce/product-collection': |
| 103 | $renderer = new Product_Collection(); |
| 104 | break; |
| 105 | case 'woocommerce/product-button': |
| 106 | $renderer = new Product_Button(); |
| 107 | break; |
| 108 | case 'woocommerce/coupon-code': |
| 109 | $renderer = new Coupon_Code(); |
| 110 | break; |
| 111 | default: |
| 112 | $renderer = new Fallback(); |
| 113 | break; |
| 114 | } |
| 115 | |
| 116 | $this->renderers[ $block_name ] = $renderer; |
| 117 | return $renderer; |
| 118 | } |
| 119 | } |
| 120 |