Automattic\WooCommerce\EmailEditor\Engine\PersonalizationTags

Personalization_Tags_Registry{} │ WC 1.0

Registry for personalization tags.

Usage

$Personalization_Tags_Registry = new Personalization_Tags_Registry();
// use class methods

Methods

1. public __construct( Email_Editor_Logger $logger )
2. public get_all()
3. public get_by_token( string $token )
4. public initialize()
5. public register( Personalization_Tag $tag )
6. public unregister( $token_or_tag )

Personalization_Tags_Registry{} Personalization Tags Registry{} code ^{WC 10.5.0}

class Personalization_Tags_Registry {
	/**
	 * Logger instance.
	 *
	 * @var Email_Editor_Logger
	 */
	private Email_Editor_Logger $logger;

	/**
	 * List of registered personalization tags.
	 *
	 * @var Personalization_Tag[]
	 */
	private $tags = array();

	/**
	 * Constructor.
	 *
	 * @param Email_Editor_Logger $logger Logger instance.
	 */
	public function __construct( Email_Editor_Logger $logger ) {
		$this->logger = $logger;
	}

	/**
	 * Initialize the personalization tags registry.
	 * This method should be called only once.
	 *
	 * @return void
	 */
	public function initialize(): void {
		$this->logger->info( 'Initializing personalization tags registry' );
		apply_filters( 'woocommerce_email_editor_register_personalization_tags', $this );
		$this->logger->info( 'Personalization tags registry initialized', array( 'tags_count' => count( $this->tags ) ) );
	}

	/**
	 * Register a new personalization instance in the registry.
	 *
	 * @param Personalization_Tag $tag The personalization tag to register.
	 * @return void
	 */
	public function register( Personalization_Tag $tag ): void {
		if ( isset( $this->tags[ $tag->get_token() ] ) ) {
			$this->logger->warning(
				'Personalization tag already registered',
				array(
					'token'    => $tag->get_token(),
					'name'     => $tag->get_name(),
					'category' => $tag->get_category(),
				)
			);
			return;
		}

		$this->tags[ $tag->get_token() ] = $tag;

		$this->logger->debug(
			'Personalization tag registered',
			array(
				'token'    => $tag->get_token(),
				'name'     => $tag->get_name(),
				'category' => $tag->get_category(),
			)
		);
	}

	/**
	 * Unregister a personalization tag by its token or tag instance.
	 *
	 * @param string|Personalization_Tag $token_or_tag The token string or Personalization_Tag instance to unregister.
	 * @return Personalization_Tag|null The unregistered tag or null if not found.
	 */
	public function unregister( $token_or_tag ): ?Personalization_Tag {
		// Extract token from the argument.
		if ( $token_or_tag instanceof Personalization_Tag ) {
			$token = $token_or_tag->get_token();
		} elseif ( is_string( $token_or_tag ) ) {
			$token = $token_or_tag;
		} else {
			$this->logger->warning(
				'Invalid argument type for unregister method',
				array(
					'type' => gettype( $token_or_tag ),
				)
			);
			return null;
		}

		$tag = $this->tags[ $token ] ?? null;
		if ( $tag ) {
			unset( $this->tags[ $token ] );
			$this->logger->debug(
				'Personalization tag unregistered',
				array(
					'token'    => $token,
					'name'     => $tag->get_name(),
					'category' => $tag->get_category(),
				)
			);
		}
		return $tag;
	}

	/**
	 * Retrieve a personalization tag by its token.
	 * Example: get_by_token( 'user:first_name' ) will return the instance of Personalization_Tag with identical token.
	 *
	 * @param string $token The token of the personalization tag.
	 * @return Personalization_Tag|null The array data or null if not found.
	 */
	public function get_by_token( string $token ): ?Personalization_Tag {
		return $this->tags[ $token ] ?? null;
	}

	/**
	 * Retrieve all registered personalization tags.
	 *
	 * @return array List of all registered personalization tags.
	 */
	public function get_all() {
		return $this->tags;
	}
}