update

wp-content/plugins/google-site-kit/includes/Modules/Analytics_4/Advanced_Tracking.php

@@ -0,0 +1,171 @@
+<?php
+/**
+ * Class Google\Site_Kit\Modules\Analytics_4\Advanced_Tracking
+ *
+ * @package   Google\Site_Kit\Modules\Analytics_4
+ * @copyright 2024 Google LLC
+ * @license   https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
+ * @link      https://sitekit.withgoogle.com
+ */
+
+namespace Google\Site_Kit\Modules\Analytics_4;
+
+use Google\Site_Kit\Context;
+use Google\Site_Kit\Modules\Analytics_4\Advanced_Tracking\Event_List;
+use Google\Site_Kit\Modules\Analytics_4\Advanced_Tracking\Script_Injector;
+use Google\Site_Kit\Modules\Analytics_4\Advanced_Tracking\AMP_Config_Injector;
+use Google\Site_Kit\Modules\Analytics_4\Advanced_Tracking\Event_List_Registry;
+use Google\Site_Kit\Modules\Analytics_4;
+
+/**
+ * Class for Google Analytics Advanced Event Tracking.
+ *
+ * @since 1.18.0.
+ * @since 1.121.0 Migrated from the Analytics (UA) namespace.
+ * @access private
+ * @ignore
+ */
+final class Advanced_Tracking {
+
+	/**
+	 * Plugin context.
+	 *
+	 * @since 1.18.0.
+	 * @var Context
+	 */
+	protected $context;
+
+	/**
+	 * Map of events to be tracked.
+	 *
+	 * @since 1.18.0.
+	 * @var array Map of Event instances, keyed by their unique ID.
+	 */
+	private $events;
+
+	/**
+	 * Main class event list registry instance.
+	 *
+	 * @since 1.18.0.
+	 * @var Event_List_Registry
+	 */
+	private $event_list_registry;
+
+	/**
+	 * Advanced_Tracking constructor.
+	 *
+	 * @since 1.18.0.
+	 *
+	 * @param Context $context Plugin context.
+	 */
+	public function __construct( Context $context ) {
+		$this->context             = $context;
+		$this->event_list_registry = new Event_List_Registry();
+	}
+
+	/**
+	 * Registers functionality through WordPress hooks.
+	 *
+	 * @since 1.18.0.
+	 * @since 1.118.0 Renamed hooks to target Analytics 4 module.
+	 */
+	public function register() {
+		$slug_name = Analytics_4::MODULE_SLUG;
+
+		add_action(
+			"googlesitekit_{$slug_name}_init_tag",
+			function() {
+				$this->register_event_lists();
+				add_action(
+					'wp_footer',
+					function() {
+						$this->set_up_advanced_tracking();
+					}
+				);
+			}
+		);
+		add_action(
+			"googlesitekit_{$slug_name}_init_tag_amp",
+			function() {
+				$this->register_event_lists();
+				add_filter(
+					'googlesitekit_amp_gtag_opt',
+					function( $gtag_amp_opt ) {
+						return $this->set_up_advanced_tracking_amp( $gtag_amp_opt );
+					}
+				);
+			}
+		);
+	}
+
+	/**
+	 * Returns the map of unique events.
+	 *
+	 * @since 1.18.0.
+	 *
+	 * @return array Map of Event instances, keyed by their unique ID.
+	 */
+	public function get_events() {
+		return $this->events;
+	}
+
+	/**
+	 * Injects javascript to track active events.
+	 *
+	 * @since 1.18.0.
+	 */
+	private function set_up_advanced_tracking() {
+		$this->compile_events();
+		( new Script_Injector( $this->context ) )->inject_event_script( $this->events );
+	}
+
+	/**
+	 * Adds triggers to AMP configuration.
+	 *
+	 * @since 1.18.0.
+	 *
+	 * @param array $gtag_amp_opt gtag config options for AMP.
+	 * @return array Filtered $gtag_amp_opt.
+	 */
+	private function set_up_advanced_tracking_amp( $gtag_amp_opt ) {
+		$this->compile_events();
+		return ( new AMP_Config_Injector() )->inject_event_configurations( $gtag_amp_opt, $this->events );
+	}
+
+	/**
+	 * Instantiates and registers event lists.
+	 *
+	 * @since 1.18.0.
+	 */
+	private function register_event_lists() {
+		/**
+		 * Fires when the Advanced_Tracking class is ready to receive event lists.
+		 *
+		 * This means that Advanced_Tracking class stores the event lists in the Event_List_Registry instance.
+		 *
+		 * @since 1.18.0.
+		 *
+		 * @param Event_List_Registry $event_list_registry
+		 */
+		do_action( 'googlesitekit_analytics_register_event_lists', $this->event_list_registry );
+
+		foreach ( $this->event_list_registry->get_lists() as $event_list ) {
+			$event_list->register();
+		}
+	}
+
+	/**
+	 * Compiles the list of Event objects.
+	 *
+	 * @since 1.18.0.
+	 */
+	private function compile_events() {
+		$this->events = array_reduce(
+			$this->event_list_registry->get_lists(),
+			function ( $events, Event_List $event_list ) {
+				return array_merge( $events, $event_list->get_events() );
+			},
+			array()
+		);
+	}
+}