GoogleAnalyticsEventTracker.php in Google Analytics Event Tracking 8.2

Namespace

Drupal\google_analytics_et\Entity

File

src/Entity/GoogleAnalyticsEventTracker.php

<?php

namespace Drupal\google_analytics_et\Entity;

use Drupal\Component\Utility\Unicode;
use Drupal\Console\Bootstrap\Drupal;
use Drupal\Core\Config\Entity\ConfigEntityBase;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;

/**
 * Defines the Google Analytics event tracker entity.
 *
 * @ConfigEntityType(
 *   id = "google_analytics_event_tracker",
 *   label = @Translation("Google Analytics event tracker"),
 *   handlers = {
 *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
 *     "list_builder" = "Drupal\google_analytics_et\GoogleAnalyticsEventTrackerListBuilder",
 *     "form" = {
 *       "add" = "Drupal\google_analytics_et\Form\GoogleAnalyticsEventTrackerForm",
 *       "edit" = "Drupal\google_analytics_et\Form\GoogleAnalyticsEventTrackerForm",
 *       "delete" = "Drupal\google_analytics_et\Form\GoogleAnalyticsEventTrackerDeleteForm"
 *     },
 *     "route_provider" = {
 *       "html" = "Drupal\google_analytics_et\GoogleAnalyticsEventTrackerHtmlRouteProvider",
 *     },
 *   },
 *   config_prefix = "google_analytics_event_tracker",
 *   admin_permission = "administer google analytics trackers",
 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "label",
 *     "uuid" = "uuid"
 *   },
 *   links = {
 *     "canonical" = "/admin/config/system/google_analytics_event_tracker/{google_analytics_event_tracker}",
 *     "add-form" = "/admin/config/system/google_analytics_event_tracker/add",
 *     "edit-form" = "/admin/config/system/google_analytics_event_tracker/{google_analytics_event_tracker}/edit",
 *     "delete-form" = "/admin/config/system/google_analytics_event_tracker/{google_analytics_event_tracker}/delete",
 *     "collection" = "/admin/config/system/google_analytics_event_tracker"
 *   }
 * )
 */
class GoogleAnalyticsEventTracker extends ConfigEntityBase implements GoogleAnalyticsEventTrackerInterface {

  /**
   * The Google Analytics event tracker ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The Google Analytics event tracker label.
   *
   * @var string
   */
  protected $label;
  protected $element_dom_id;
  protected $element_selector;
  protected $dom_event;
  protected $ga_event_category;
  protected $ga_event_action;
  protected $ga_event_label;
  protected $ga_event_value;
  protected $ga_event_noninteraction;
  protected $content_types;
  protected $languages;
  protected $themes;
  protected $preprocess;
  protected $path_negate;
  protected $paths;

  /**
   * {@inheritdoc}
   */
  public function isActive() {
    if (!$this
      ->status()) {
      return FALSE;
    }
    $paths = rtrim($this->paths);

    // If no paths provided this tracker will match all paths.
    if (empty($paths)) {
      return TRUE;
    }
    $path = \Drupal::service('path.current')
      ->getPath();
    $path_alias = \Drupal::service('path.alias_manager')
      ->getAliasByPath($path);
    $path_alias = Unicode::strtolower($path_alias);
    $matcher = \Drupal::service('path.matcher');
    $path_match = $matcher
      ->matchPath($path_alias, $this->paths) || $matcher
      ->matchPath($path, $paths);

    // When $tracker->path_negate has a value of 0, the asset is
    // added on all pages except those listed in $tracker->paths.
    // When set to 1, it is added only on those pages listed in
    // $tracker->paths.
    return !($this->path_negate xor $path_match);
  }

  /**
   * {@inheritdoc}
   */
  public function getJsSettings() {
    return [
      'selector' => $this->element_selector,
      'event' => $this->dom_event,
      'category' => $this->ga_event_category,
      'action' => $this->ga_event_action,
      'label' => $this->ga_event_label,
      'value' => $this->ga_event_value,
      'noninteraction' => $this->ga_event_noninteraction,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getDomEvents() {
    return [
      'click' => 'click',
      'dblclick' => 'dblclick',
      'mousedown' => 'mousedown',
      'mouseup' => 'mouseup',
      'mouseover' => 'mouseover',
      'mousemove' => 'mousemove',
      'mouseout' => 'mouseout',
      'keydown' => 'keydown',
      'keypress' => 'keypress',
      'keyup' => 'keyup',
      'select' => 'select',
      'change' => 'change',
      'submit' => 'submit',
      'reset' => 'reset',
      'focus' => 'focus',
      'scroll' => 'scroll',
      'blur' => 'blur',
    ];
  }

}

Classes

Name	Description
GoogleAnalyticsEventTracker	Defines the Google Analytics event tracker entity.