Add graphql query.

.github/workflows/module-test.yml → .github/workflows/module_test.yml

@@ -30,9 +30,12 @@ jobs:
       with:
         coverage: none
         php-version: ${{ matrix.PHP }}
+        extensions: Imagick, gd, pdo_mysql
 
     - name: Start MySql service
-      run: sudo /etc/init.d/mysql start
+      run: |
+        sudo /etc/init.d/mysql start
+        mysql -uroot -proot -e "ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'root';"
 
     - name: Cache composer dependencies
       uses: actions/cache@v1

.github/workflows/reviewdog.yml

@@ -3,17 +3,6 @@ name: Check coding styles
 on: [pull_request]
 
 jobs:
-  eslint:
-    name: runner / eslint
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-
-      - name: eslint
-        uses: reviewdog/action-eslint@v1
-        with:
-          github_token: ${{ secrets.github_token }}
-
   phpcs:
     name: runner / phpcs
     runs-on: ubuntu-latest
@@ -25,6 +14,7 @@ jobs:
         with:
           github_token: ${{ secrets.github_token }}
           level: error
+          filter_mode: nofilter
 
   misspell:
     name: runner / misspell

graphql/ivw.base.graphqls

@@ -0,0 +1,11 @@
+type Ivw {
+  st: String
+  cp: String
+  sv: String
+  sc: String
+  co: String
+  mobile_cp: String
+  mobile_st: String
+  mobile_sv: String
+  mobile_width: String
+}

graphql/ivw.extension.graphqls

@@ -0,0 +1,3 @@
+extend type Query {
+  ivw(path: String!): Ivw
+}

ivw_integration.tokens.inc

@@ -102,7 +102,7 @@ function ivw_integration_tokens($type, $tokens, array $data, array $options, Bub
     elseif (isset($data['term']) && $data['term'] instanceof TermInterface) {
       $lookupFrom = 'term';
     }
-    /* @var \Drupal\ivw_integration\IvwLookupServiceInterface $lookup */
+    /** @var \Drupal\ivw_integration\IvwLookupServiceInterface $lookup */
     $lookup = \Drupal::service('ivw_integration.lookup');
     foreach ($tokens as $name => $original) {
 

src/IvwLookupService.php

@@ -13,9 +13,7 @@
 use Drupal\taxonomy\TermInterface;
 
 /**
- * Class IvwLookupService.
- *
- * @package Drupal\ivw_integration
+ * Service to get correct values based on the content hierarchy.
  */
 class IvwLookupService implements IvwLookupServiceInterface {
 
@@ -75,11 +73,8 @@ public function byCurrentRoute($name, $parentOnly = FALSE) {
    * {@inheritdoc}
    */
   public function byRoute($name, RouteMatchInterface $route, $parentOnly = FALSE) {
-
-    $entity = NULL;
-
     foreach (self::getSupportedEntityParameters() as $parameter) {
-      /* @var ContentEntityInterface $entity */
+      /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
       if ($entity = $route->getParameter($parameter)) {
 
         if (is_numeric($entity)) {
@@ -116,12 +111,10 @@ public function getCacheTagsByCurrentRoute() {
    * {@inheritdoc}
    */
   public function getCacheTagsByRoute(RouteMatchInterface $route) {
-
-    $entity = NULL;
     $cache_tags = [];
 
     foreach (self::getSupportedEntityParameters() as $parameter) {
-      /* @var ContentEntityInterface $entity */
+      /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
       if ($entity = $route->getParameter($parameter)) {
 
         if (is_numeric($entity)) {
@@ -160,12 +153,11 @@ public function getCacheTagsByRoute(RouteMatchInterface $route) {
    *   The gathered cache tags.
    */
   private function getCacheTagsByTerm(TermInterface $term) {
-    /* @var \Drupal\taxonomy\TermStorage $termStorage  */
+    /** @var \Drupal\taxonomy\TermStorageInterface $termStorage  */
     $termStorage = $this->entityTypeManager->getStorage('taxonomy_term');
 
     $cache_tags = $term->getCacheTags();
 
-    /** @var \Drupal\taxonomy\TermInterface $parent */
     foreach ($termStorage->loadParents($term->id()) as $parent) {
       $parentCacheTags = $this->getCacheTagsByTerm($parent);
       $cache_tags = Cache::mergeTags($cache_tags, $parentCacheTags);
@@ -299,7 +291,7 @@ protected function searchTerm($name, TermInterface $term, $parentOnly = FALSE) {
       }
     }
 
-    /* @var \Drupal\taxonomy\TermStorage $termStorage  */
+    /** @var \Drupal\taxonomy\TermStorageInterface $termStorage  */
     $termStorage = $this->entityTypeManager->getStorage('taxonomy_term');
 
     foreach ($termStorage->loadParents($term->id()) as $parent) {

src/IvwLookupServiceInterface.php

@@ -7,9 +7,7 @@
 use Drupal\taxonomy\TermInterface;
 
 /**
- * Interface IvwLookupServiceInterface.
- *
- * @package Drupal\ivw_integration
+ * Interface for the lookup service.
  */
 interface IvwLookupServiceInterface {
 

src/IvwTracker.php

@@ -5,12 +5,12 @@
 use Drupal\Core\Cache\Cache;
 use Drupal\Core\Cache\CacheableDependencyInterface;
 use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Entity\ContentEntityInterface;
 use Drupal\Core\Utility\Token;
+use Drupal\taxonomy\TermInterface;
 
 /**
- * Class IvwTracker.
- *
- * @package Drupal\ivw_integration
+ * Provides all the IVW tracking information.
  */
 class IvwTracker implements IvwTrackerInterface, CacheableDependencyInterface {
 
@@ -65,18 +65,18 @@ public function __construct(
   /**
    * {@inheritdoc}
    */
-  public function getTrackingInformation() {
+  public function getTrackingInformation(ContentEntityInterface $entity = NULL) {
     if (!isset($this->trackingInformation)) {
       $this->trackingInformation = [
         'st' => $this->getSt(),
         'mobile_st' => $this->getMobileSt(),
-        'cp' => $this->getCp(),
-        'sv' => $this->getSv(),
-        'mobile_sv' => $this->getMobileSv(),
+        'cp' => $this->getCp($entity),
+        'sv' => $this->getSv($entity),
+        'mobile_sv' => $this->getMobileSv($entity),
         'sc' => $this->getSc(),
       ];
       // Calculate cpm based upon cp.
-      // TODO: this is absolutely not generic.
+      // @todo This is absolutely not generic.
       $this->trackingInformation['cpm'] = str_replace('D1A', 'D2A', $this->trackingInformation['cp']);
     }
     return $this->trackingInformation;
@@ -110,11 +110,21 @@ protected function getMobileSt() {
    * @return string
    *   The value of the cp parameter.
    */
-  protected function getCp() {
+  protected function getCp(ContentEntityInterface $entity = NULL) {
     $settings = $this->configFactory->get('ivw_integration.settings');
     $code_template = $settings->get('code_template');
 
-    return $this->token->replace($code_template, [], ['sanitize' => FALSE]);
+    $data = [];
+    if ($entity) {
+      if ($entity instanceof TermInterface) {
+        $data['term'] = $entity;
+      }
+      else {
+        $data['entity'] = $entity;
+      }
+    }
+
+    return $this->token->replace($code_template, $data, ['sanitize' => FALSE]);
   }
 
   /**
@@ -124,8 +134,17 @@ protected function getCp() {
    *   The value of the sv parameter.
    *   If non is defined anywhere 'in' is returned as default.
    */
-  protected function getSv() {
-    $sv = $this->token->replace('[ivw:frabo]', [], ['sanitize' => FALSE]);
+  protected function getSv(ContentEntityInterface $entity = NULL) {
+    $data = [];
+    if ($entity) {
+      if ($entity instanceof TermInterface) {
+        $data['term'] = $entity;
+      }
+      else {
+        $data['entity'] = $entity;
+      }
+    }
+    $sv = $this->token->replace('[ivw:frabo]', $data, ['sanitize' => FALSE]);
     return empty($sv) ? 'in' : $sv;
   }
 
@@ -136,8 +155,17 @@ protected function getSv() {
    *   The value of the sv parameter.
    *   If non is defined anywhere 'mo' is returned as default.
    */
-  protected function getMobileSv() {
-    $sv = $this->token->replace('[ivw:frabo_mobile]', [], ['sanitize' => FALSE]);
+  protected function getMobileSv(ContentEntityInterface $entity = NULL) {
+    $data = [];
+    if ($entity) {
+      if ($entity instanceof TermInterface) {
+        $data['term'] = $entity;
+      }
+      else {
+        $data['entity'] = $entity;
+      }
+    }
+    $sv = $this->token->replace('[ivw:frabo_mobile]', $data, ['sanitize' => FALSE]);
     return empty($sv) ? 'mo' : $sv;
   }
 

src/IvwTrackerInterface.php

@@ -2,10 +2,10 @@
 
 namespace Drupal\ivw_integration;
 
+use Drupal\Core\Entity\ContentEntityInterface;
+
 /**
- * Interface IvwTrackerInterface.
- *
- * @package Drupal\ivw_integration
+ * Interface for the tracking service.
  */
 interface IvwTrackerInterface {
 
@@ -16,6 +16,6 @@ interface IvwTrackerInterface {
    *   Array containing 'st', 'mobile_st', 'cp', 'cpm',
    *   'sv' and 'mobile_sv' parameters.
    */
-  public function getTrackingInformation();
+  public function getTrackingInformation(ContentEntityInterface $entity = NULL);
 
 }