HEX
Server: Apache/2.4.58 (Ubuntu)
System: Linux ubuntu-8gb-hel1-1 6.8.0-55-generic #57-Ubuntu SMP PREEMPT_DYNAMIC Wed Feb 12 23:42:21 UTC 2025 x86_64
User: www-data (33)
PHP: 8.1.32
Disabled: NONE
Upload Files
File: /var/www/agighana.org_backup/Conversion_Reporting_New_Badge_Events_Sync.php
<?php
/**
 * Class Google\Site_Kit\Modules\Analytics_4\Conversion_Reporting\Conversion_Reporting_New_Badge_Events_Sync
 *
 * @package   Google\Site_Kit
 * @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\Conversion_Reporting;

use Google\Site_Kit\Core\Storage\Transients;

/**
 * Class providing implementation of "new" badge for detected conversion reporting events.
 *
 * @since 1.144.0
 * @access private
 * @ignore
 */
class Conversion_Reporting_New_Badge_Events_Sync {

	/**
	 * The detected events transient name.
	 */
	public const NEW_EVENTS_BADGE_TRANSIENT = 'googlesitekit_conversion_reporting_new_badge_events';

	/**
	 * The skip new badge events transient name.
	 */
	public const SKIP_NEW_BADGE_TRANSIENT = 'googlesitekit_conversion_reporting_skip_new_badge_events';

	/**
	 * Transients instance.
	 *
	 * @since 1.144.0
	 * @var Transients
	 */
	protected $transients;

	/**
	 * Constructor.
	 *
	 * @since 1.144.0
	 *
	 * @param Transients $transients  Transients instance.
	 */
	public function __construct(
		Transients $transients
	) {
		$this->transients = $transients;
	}

	/**
	 * Saves new events badge to the expirable items.
	 *
	 * @since 1.144.0
	 *
	 * @param array $new_events New events array.
	 */
	public function sync_new_badge_events( $new_events ) {
		$skip_events_badge = $this->transients->get( self::SKIP_NEW_BADGE_TRANSIENT );
		if ( $skip_events_badge ) {
			$this->transients->delete( self::SKIP_NEW_BADGE_TRANSIENT );
			return;
		}

		$new_events_badge         = $this->transients->get( self::NEW_EVENTS_BADGE_TRANSIENT );
		$save_new_badge_transient = fn( $events ) => $this->transients->set(
			self::NEW_EVENTS_BADGE_TRANSIENT,
			array(
				'created_at' => time(),
				'events'     => $events,
			),
			7 * DAY_IN_SECONDS
		);

		if ( ! $new_events_badge ) {
			$save_new_badge_transient( $new_events );
			return;
		}

		$new_events_badge_elapsed_time = time() - $new_events_badge['created_at'];
		// If the transient existed for 3 days or less, prevent scenarios where
		// a new event is detected shortly after (within 1-3 days) the previous events.
		// This avoids shortening the "new badge" time for previous events.
		// Instead, we merge the new events with the previous ones to ensure the user sees all of them.
		if ( $new_events_badge_elapsed_time > ( 3 * DAY_IN_SECONDS ) ) {
			$save_new_badge_transient( $new_events );
			return;
		}

		$events = array_merge( $new_events_badge['events'], $new_events );
		$save_new_badge_transient( $events );
	}
}