<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Class for handling transactional email personalization.

[2] Fix | Delete

*

[3] Fix | Delete

* @package Automattic\WooCommerce\Internal\EmailEditor

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

declare(strict_types = 1);

[7] Fix | Delete

[8] Fix | Delete

namespace Automattic\WooCommerce\Internal\EmailEditor;

[9] Fix | Delete

[10] Fix | Delete

use Automattic\WooCommerce\EmailEditor\Email_Editor_Container;

[11] Fix | Delete

use Automattic\WooCommerce\EmailEditor\Engine\Personalizer;

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Class TransactionalEmailPersonalizer that internally uses the Personalizer class.

[15] Fix | Delete

* The inheritance is not used here because Personalizer needs to pass Personalization_Tags_Registry and

[16] Fix | Delete

* the combination of two different dependency injection containers is not possible.

[17] Fix | Delete

*/

[18] Fix | Delete

class TransactionalEmailPersonalizer {

[19] Fix | Delete

/**

[20] Fix | Delete

* Personalizer instance for handling email content personalization.

[21] Fix | Delete

*

[22] Fix | Delete

* @var Personalizer

[23] Fix | Delete

*/

[24] Fix | Delete

private Personalizer $personalizer;

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Constructor.

[28] Fix | Delete

*/

[29] Fix | Delete

public function __construct() {

[30] Fix | Delete

$editor_container = Email_Editor_Container::container();

[31] Fix | Delete

$this->personalizer = $editor_container->get( Personalizer::class );

[32] Fix | Delete

}

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Personalize transactional email content with specific handling.

[36] Fix | Delete

*

[37] Fix | Delete

* @param string $content The content to personalize.

[38] Fix | Delete

* @param \WC_Email $email The WooCommerce email object.

[39] Fix | Delete

* @return string The personalized content.

[40] Fix | Delete

*/

[41] Fix | Delete

public function personalize_transactional_content( string $content, \WC_Email $email ): string {

[42] Fix | Delete

$this->configure_context_by_email( $email );

[43] Fix | Delete

return $this->personalizer->personalize_content( $content );

[44] Fix | Delete

}

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Configure personalization context based on WooCommerce email object.

[48] Fix | Delete

*

[49] Fix | Delete

* @param \WC_Email $email The WooCommerce email object.

[50] Fix | Delete

* @return void

[51] Fix | Delete

*/

[52] Fix | Delete

public function configure_context_by_email( \WC_Email $email ): void {

[53] Fix | Delete

$prepared_context = $this->prepare_context_data( $this->personalizer->get_context(), $email );

[54] Fix | Delete

$this->personalizer->set_context( $prepared_context );

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Prepare context data for email personalization.

[59] Fix | Delete

* Adds new order specific context data.

[60] Fix | Delete

*

[61] Fix | Delete

* @param array $previous_context Previous version of context data.

[62] Fix | Delete

* @param \WC_Email $email The WooCommerce email object.

[63] Fix | Delete

* @return array Context data for personalization

[64] Fix | Delete

*/

[65] Fix | Delete

public function prepare_context_data( array $previous_context, \WC_Email $email ): array {

[66] Fix | Delete

$context = $previous_context;

[67] Fix | Delete

[68] Fix | Delete

$context['recipient_email'] = $email->get_recipient();

[69] Fix | Delete

$context['order'] = $email->object instanceof \WC_Order ? $email->object : null;

[70] Fix | Delete

// For emails of type new_user or reset_password we want to set user directly from the object.

[71] Fix | Delete

if ( $email->object instanceof \WP_User ) {

[72] Fix | Delete

$context['wp_user'] = $email->object;

[73] Fix | Delete

} elseif ( $email->object instanceof \WC_Order ) {

[74] Fix | Delete

$context['wp_user'] = $email->object->get_user();

[75] Fix | Delete

} else {

[76] Fix | Delete

$context['wp_user'] = null;

[77] Fix | Delete

}

[78] Fix | Delete

$context['wc_email'] = $email;

[79] Fix | Delete

[80] Fix | Delete

$core_context = $context;

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Filters the context data for email personalization.

[84] Fix | Delete

*

[85] Fix | Delete

* This filter fires after core defaults are set, allowing extensions

[86] Fix | Delete

* to override values like wp_user for custom email types (e.g., WooCommerce Bookings).

[87] Fix | Delete

*

[88] Fix | Delete

* @since 10.5.0

[89] Fix | Delete

* @param array $context Context data including core defaults.

[90] Fix | Delete

* @param \WC_Email $email The WooCommerce email object.

[91] Fix | Delete

* @return array Context data for personalization

[92] Fix | Delete

*/

[93] Fix | Delete

$context = apply_filters( 'woocommerce_email_editor_integration_personalizer_context_data', $context, $email );

[94] Fix | Delete

[95] Fix | Delete

if ( ! is_array( $context ) ) {

[96] Fix | Delete

$context = $core_context;

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

return $context;

[100] Fix | Delete

}

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete