EmailContent.php — WooCommerce 10.9.1

woocommerce / src / Blocks / BlockTypes / EmailContent.php

woocommerce / src / Blocks / BlockTypes Last commit date

EmailContent.php

103 lines

1	<?php // phpcs:ignore Generic.PHP.RequireStrictTypes.MissingDeclaration
2
3	namespace Automattic\WooCommerce\Blocks\BlockTypes;
4
5	use Automattic\WooCommerce\Blocks\BlockTypes\AbstractBlock;
6	use Automattic\WooCommerce\Internal\EmailEditor\BlockEmailRenderer;
7	use Automattic\WooCommerce\Internal\Admin\EmailPreview\EmailPreview;
8	use Automattic\WooCommerce\Internal\EmailEditor\WCTransactionalEmails\WCTransactionalEmailPostsManager;
9
10	/**
11	* EmailContent class.
12	*/
13	class EmailContent extends AbstractBlock {
14	/**
15	* Block name.
16	*
17	* @var string
18	*/
19	protected $block_name = 'email-content';
20
21	/**
22	* Get the frontend style handle for this block type.
23	*
24	* @return null
25	*/
26	protected function get_block_type_style() {
27	return null;
28	}
29
30	/**
31	* Get the editor script handle for this block type.
32	*
33	* @param string $key Data to get, or default to everything.
34	* @return array\|string
35	*/
36	protected function get_block_type_editor_script( $key = null ) {
37	$script = [
38	'handle' => 'wc-' . $this->block_name . '-block',
39	'path' => $this->asset_api->get_block_asset_build_path( $this->block_name ),
40	'dependencies' => [ 'wc-blocks' ],
41	];
42	return $key ? $script[ $key ] : $script;
43	}
44
45	/**
46	* Get the frontend script handle for this block type.
47	*
48	* @param string $key Data to get, or default to everything.
49	*/
50	protected function get_block_type_script( $key = null ) {
51	return null;
52	}
53
54	/**
55	* Renders the block preview for the editor.
56	*
57	* @param array $attributes Block attributes.
58	* @return string Rendered block output.
59	*/
60	protected function render_preview( $attributes ) {
61	/**
62	* Email preview instance for rendering dummy content.
63	*
64	* @var EmailPreview $email_preview - email preview instance
65	*/
66	$email_preview = wc_get_container()->get( EmailPreview::class );
67
68	$type_param = EmailPreview::DEFAULT_EMAIL_TYPE;
69
70	if ( isset( $attributes['postId'] ) ) {
71	$email_type_class_name = WCTransactionalEmailPostsManager::get_instance()->get_email_type_class_name_from_post_id( $attributes['postId'] );
72	$type_param = ! empty( $email_type_class_name ) ? $email_type_class_name : $type_param;
73	} elseif ( isset( $attributes['emailType'] ) ) {
74	$type_param = sanitize_text_field( wp_unslash( $attributes['emailType'] ) );
75	}
76
77	try {
78	return $email_preview->generate_placeholder_content( $type_param );
79	} catch ( \Exception $e ) {
80	// Catch other potential errors during content generation.
81	return esc_html__( 'There was an error rendering the email preview.', 'woocommerce' );
82	}
83	}
84
85	/**
86	* Renders Woo content placeholder to be replaced by content during sending.
87	*
88	* @param array $attributes Block attributes.
89	* @param string $content Block content.
90	* @param \WP_Block $block Block instance.
91	* @return string Rendered block output.
92	*/
93	protected function render( $attributes, $content, $block ) {
94	// phpcs:disable WordPress.Security.NonceVerification.Recommended
95	if ( defined( 'REST_REQUEST' ) && REST_REQUEST && isset( $_GET['context'] ) && 'edit' === sanitize_text_field( wp_unslash( $_GET['context'] ) ) ) {
96	// Block is being rendered for ServerSideRender editor preview.
97	return $this->render_preview( $attributes );
98	}
99
100	return BlockEmailRenderer::WOO_EMAIL_CONTENT_PLACEHOLDER;
101	}
102	}
103