class DefaultCommandSubscriber in Googalytics - Google Analytics 8

Class DefaultCommandSubscriber.

Hierarchy

• class \Drupal\ga\EventSubscriber\DefaultCommandSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'DefaultCommandSubscriber'

ga.services.yml in ./ga.services.yml

ga.services.yml

1 service uses DefaultCommandSubscriber

ga.default_command_subscriber in ./ga.services.yml

Drupal\ga\EventSubscriber\DefaultCommandSubscriber

File

src/EventSubscriber/DefaultCommandSubscriber.php, line 21

Namespace

Drupal\ga\EventSubscriber

class DefaultCommandSubscriber implements EventSubscriberInterface {

  /**
   * The ga Command Registry service.
   *
   * @var \Drupal\ga\CommandRegistryService
   */
  protected $commandRegistry;

  /**
   * The config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The current user service.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * User Entity Storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $userStorage;

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    return [
      AnalyticsEvents::COLLECT => [
        [
          'onCollectDefaultCommands',
        ],
        [
          'onCollectRegisteredCommands',
        ],
      ],
    ];
  }

  /**
   * DefaultCommandSubscriber constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The config factory service.
   * @param \Drupal\ga\CommandRegistryService $commandRegistry
   *   The command registry service.
   * @param \Drupal\Core\Session\AccountInterface $currentUser
   *   The current user service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager service.
   */
  public function __construct(ConfigFactoryInterface $configFactory, CommandRegistryService $commandRegistry, AccountInterface $currentUser, EntityTypeManagerInterface $entityTypeManager) {
    $this->configFactory = $configFactory;
    $this->commandRegistry = $commandRegistry;
    $this->currentUser = $currentUser;
    $this->userStorage = $entityTypeManager
      ->getStorage('user');
  }

  /**
   * Add commands registered with the command registry service.
   *
   * @param \Drupal\ga\Event\CollectEvent $event
   *   The AnalyticsEvents::COLLECT event.
   */
  public function onCollectRegisteredCommands(CollectEvent $event) {
    foreach ($this->commandRegistry
      ->getCommands() as $command) {
      $event
        ->addCommand($command);
    }
  }

  /**
   * Add default events according to configuration.
   *
   * @param \Drupal\ga\Event\CollectEvent $event
   *   The AnalyticsEvents::COLLECT event.
   */
  public function onCollectDefaultCommands(CollectEvent $event) {
    $config = $this->configFactory
      ->get('ga.settings');
    if ($config
      ->get('add_default_commands')) {

      // Check user role restrictions.
      if (!$this
        ->checkRole($config
        ->get('user_roles.mode'), $config
        ->get('user_roles.roles'), $this->currentUser
        ->getRoles())) {
        return;
      }

      // Initialize tracker or set tracker options.
      if ($tracking_id = $config
        ->get('tracking_id')) {

        // Add options which can be provided when initializing the tracker.
        $fieldsObject = [];
        if ($config
          ->get('sample_rate') !== 100) {
          $fieldsObject['sampleRate'] = $config
            ->get('sample_rate');
        }
        if ($config
          ->get('site_speed_sample_rate') !== 1) {
          $fieldsObject['site_speed_sample_rate'] = $config
            ->get('site_speed_sample_rate');
        }
        if ($config
          ->get('force_ssl')) {
          $fieldsObject['forceSSL'] = TRUE;
        }
        if ($config
          ->get('plugins.linker.enable')) {
          $fieldsObject['allowLinker'] = TRUE;
        }
        if ($config
          ->get('track_user_id') && $this->currentUser
          ->isAuthenticated()) {
          $account = $this->userStorage
            ->load($this->currentUser
            ->id());
          $fieldsObject['userId'] = $account
            ->uuid();
        }
        if ($config
          ->get('anonymize_ip')) {
          $fieldsObject['anonymizeIp'] = TRUE;
        }
        $event
          ->addCommand(new Create($tracking_id, 'auto', NULL, $fieldsObject));
      }
      else {
        if ($config
          ->get('force_ssl')) {
          $event
            ->addCommand(new Set('forceSSL', TRUE));
        }

        // If a trackingId isn't provided for initializing a tracker, these
        // options can be provided via set commands instead.
        if ($config
          ->get('track_user_id') && $this->currentUser
          ->isAuthenticated()) {
          $account = $this->userStorage
            ->load($this->currentUser
            ->id());
          $event
            ->addCommand(new Set('userId', $account
            ->uuid()));
        }
        if ($config
          ->get('anonymize_ip')) {
          $event
            ->addCommand(new Set('anonymizeIp', TRUE));
        }
      }
      if ($config
        ->get('send_pageview')) {
        $event
          ->addCommand(new Pageview());
      }

      // Enable Plugins.
      if ($config
        ->get('plugins.linkid')) {
        $event
          ->addCommand(new RequirePlugin('linkid'));
      }
      if ($config
        ->get('plugins.displayfeatures')) {
        $event
          ->addCommand(new RequirePlugin('displayfeatures'));
      }
      if ($config
        ->get('plugins.linker.enable')) {

        // Note: 'allowLinker' must be set when creating the tracker for this
        // plugin to have an effect.
        $event
          ->addCommand(new RequirePlugin('linker'));
        if ($domains = $config
          ->get('plugins.linker.domains')) {
          $event
            ->addCommand(new AutoLink($domains));
        }
      }
    }
  }

  /**
   * Check role restrictions.
   *
   * @param string $mode
   *   The role mode; either 'include' or 'exclude'.
   * @param array $limitRoles
   *   An array of roles to check against.
   * @param array $userRoles
   *   The array of roles a user belongs to.
   *
   * @return bool
   *   TRUE if the provided restriction is passed.
   */
  private function checkRole($mode, array $limitRoles, array $userRoles) {
    switch ($mode) {
      case 'disabled':
        return TRUE;
      case 'include':
        $userRoleMode = TRUE;
        break;
      case 'exclude':
        $userRoleMode = FALSE;
        break;
      default:
        throw new \InvalidArgumentException("Mode must be one of 'include' or 'exclude'");
    }
    $userRoleCommon = array_intersect($limitRoles, $userRoles);
    if ($userRoleMode ^ !empty($userRoleCommon)) {
      return FALSE;
    }
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultCommandSubscriber::$commandRegistry	protected	property	The ga Command Registry service.
DefaultCommandSubscriber::$configFactory	protected	property	The config factory service.
DefaultCommandSubscriber::$currentUser	protected	property	The current user service.
DefaultCommandSubscriber::$userStorage	protected	property	User Entity Storage.
DefaultCommandSubscriber::checkRole	private	function	Check role restrictions.
DefaultCommandSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
DefaultCommandSubscriber::onCollectDefaultCommands	public	function	Add default events according to configuration.
DefaultCommandSubscriber::onCollectRegisteredCommands	public	function	Add commands registered with the command registry service.
DefaultCommandSubscriber::__construct	public	function	DefaultCommandSubscriber constructor.