class VisiblityTracker in Google Analytics 4.x

Defines the Path Matcher class.

Hierarchy

• class \Drupal\google_analytics\Helpers\VisiblityTracker

1 string reference to 'VisiblityTracker'

google_analytics.services.yml in ./google_analytics.services.yml

google_analytics.services.yml

1 service uses VisiblityTracker

google_analytics.visibility in ./google_analytics.services.yml

Drupal\google_analytics\Helpers\VisiblityTracker

File

src/Helpers/VisiblityTracker.php, line 14

Namespace

Drupal\google_analytics\Helpers

class VisiblityTracker {

  /**
   * @var \Drupal\path_alias\AliasManagerInterface
   */
  private $aliasManager;

  /**
   * @var \Drupal\Core\Path\PathMatcherInterface
   */
  private $pathMatcher;

  /**
   * @var \Drupal\user\UserDataInterface
   */
  private $userData;

  /**
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  private $config;

  /**
   * @var \Drupal\Core\Path\CurrentPathStack
   */
  private $currentPath;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Drupal\path_alias\AliasManagerInterface $alias_manager
   *   The alias manager service.
   * @param \Drupal\Core\Path\PathMatcherInterface $path_matcher
   *   The path matcher service.
   * @param \Drupal\user\UserDataInterface $user_data
   *   The user data service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, AliasManagerInterface $alias_manager, PathMatcherInterface $path_matcher, UserDataInterface $user_data, CurrentPathStack $current_path) {
    $this->config = $config_factory
      ->get('google_analytics.settings');
    $this->aliasManager = $alias_manager;
    $this->pathMatcher = $path_matcher;
    $this->userData = $user_data;
    $this->currentPath = $current_path;
  }

  /**
   * Tracking visibility check for an user object.
   *
   * @param object $account
   *   A user object containing an array of roles to check.
   *
   * @return bool
   *   TRUE if the current user is being tracked by Google Analytics,
   *   otherwise FALSE.
   */
  public function getUserVisibilty($account) {
    $enabled = FALSE;

    // Is current user a member of a role that should be tracked?
    if ($this
      ->getVisibilityRoles($account)) {

      // Use the user's block visibility setting, if necessary.
      if (($visibility_user_account_mode = $this->config
        ->get('visibility.user_account_mode')) != 0) {
        $user_data_google_analytics = $this->userData
          ->get('google_analytics', $account
          ->id());
        if ($account
          ->id() && isset($user_data_google_analytics['user_account_users'])) {
          $enabled = $user_data_google_analytics['user_account_users'];
        }
        else {
          $enabled = $visibility_user_account_mode == 1;
        }
      }
      else {
        $enabled = TRUE;
      }
    }
    return $enabled;
  }

  /**
   * Tracking visibility check for user roles.
   *
   * Based on visibility setting this function returns TRUE if JS code should
   * be added for the current role and otherwise FALSE.
   *
   * @param object $account
   *   A user object containing an array of roles to check.
   *
   * @return bool
   *   TRUE if JS code should be added for the current role and otherwise FALSE.
   */
  public function getVisibilityRoles($account) {
    $enabled = $visibility_user_role_mode = $this->config
      ->get('visibility.user_role_mode');
    $visibility_user_role_roles = $this->config
      ->get('visibility.user_role_roles');
    if (count($visibility_user_role_roles) > 0) {

      // One or more roles are selected.
      foreach (array_values($account
        ->getRoles()) as $user_role) {

        // Is the current user a member of one of these roles?
        if (in_array($user_role, $visibility_user_role_roles)) {

          // Current user is a member of a role that should be tracked/excluded
          // from tracking.
          $enabled = !$visibility_user_role_mode;
          break;
        }
      }
    }
    else {

      // No role is selected for tracking, therefore all roles should be tracked.
      $enabled = TRUE;
    }
    return $enabled;
  }

  /**
   * Tracking visibility check for pages.
   *
   * Based on visibility setting this function returns TRUE if JS code should
   * be added to the current page and otherwise FALSE.
   */
  public function getVisibilityPages() {
    static $page_match;

    // Cache visibility result if function is called more than once.
    if (!isset($page_match)) {
      $visibility_request_path_mode = $this->config
        ->get('visibility.request_path_mode');
      $visibility_request_path_pages = $this->config
        ->get('visibility.request_path_pages');

      // Match path if necessary.
      if (!empty($visibility_request_path_pages)) {

        // Convert path to lowercase. This allows comparison of the same path
        // with different case. Ex: /Page, /page, /PAGE.
        $pages = mb_strtolower($visibility_request_path_pages);
        if ($visibility_request_path_mode < 2) {

          // Compare the lowercase path alias (if any) and internal path.
          $path = $this->currentPath
            ->getPath();
          $path_alias = mb_strtolower($this->aliasManager
            ->getAliasByPath($path));
          $page_match = $this->pathMatcher
            ->matchPath($path_alias, $pages) || $path != $path_alias && $this->pathMatcher
            ->matchPath($path, $pages);

          // When $visibility_request_path_mode has a value of 0, the tracking
          // code is displayed on all pages except those listed in $pages. When
          // set to 1, it is displayed only on those pages listed in $pages.
          $page_match = !($visibility_request_path_mode xor $page_match);
        }
        else {
          $page_match = FALSE;
        }
      }
      else {
        $page_match = TRUE;
      }
    }
    return $page_match;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
VisiblityTracker::$aliasManager	private	property
VisiblityTracker::$config	private	property
VisiblityTracker::$currentPath	private	property
VisiblityTracker::$pathMatcher	private	property
VisiblityTracker::$userData	private	property
VisiblityTracker::getUserVisibilty	public	function	Tracking visibility check for an user object.
VisiblityTracker::getVisibilityPages	public	function	Tracking visibility check for pages.
VisiblityTracker::getVisibilityRoles	public	function	Tracking visibility check for user roles.
VisiblityTracker::__construct	public	function	Constructor.