GraphQLTemplateTrait::setDebug() - Code Metrics - Inspection of "Fixed debug handling." - drupal-graphql/graphql-twig - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 8.x-1.x ( c0c90f...8080a4 )

by Philipp

created 2018-09-27 09:41 UTC

GraphQLTemplateTrait::setDebug() A

↳ Parent: GraphQLTemplateTrait::display()

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Drupal\graphql_twig;

use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Template\TwigEnvironment;
use Drupal\graphql\GraphQL\Execution\QueryProcessor;
use GraphQL\Server\OperationParams;

/**
 * Trait that will be attached to all GraphQL enabled Twig templates.
 */
trait GraphQLTemplateTrait {

  /**
   * @return bool
   */
  abstract public static function hasGraphQLOperations();

  /**
   * @var string
   */
  abstract public static function rawGraphQLQuery();

  /**
   * @return string
   */
  abstract public static function rawGraphQLParent();

  /**
   * @return string[]
   */
  abstract public static function rawGraphQLIncludes();

  /**
   * @return string[]
   */
  abstract public static function rawGraphQLArguments();

  /**
   * The GraphQL query processor.
   *
   * @var \Drupal\graphql\GraphQL\Execution\QueryProcessor
   */
  protected $queryProcessor;

  /**
   * Inject the query processor.
   *
   * @param \Drupal\graphql\GraphQL\Execution\QueryProcessor $queryProcessor
   *   The query processor instance.
   */
  public function setQueryProcessor(QueryProcessor $queryProcessor) {
    $this->queryProcessor = $queryProcessor;
  }

  /**
   * {@inheritdoc}
   */
  public function display(array $context, array $blocks = array()) {
    if (!static::hasGraphQLOperations()) {
      parent::display($context, $blocks);
      return;
    }

    if (isset($context['graphql_arguments'])) {
      $context = $context['graphql_arguments'];
    }

    $query = trim($this->getGraphQLQuery());

    if (!$query) {
      parent::display($context, $blocks);
      return;
    }

    $arguments = [];
    foreach (static::rawGraphQLArguments() as $var) {
      if (isset($context[$var])) {
        $arguments[$var] = $context[$var] instanceof EntityInterface ? $context[$var]->id() : $context[$var];
if ($x instanceof DoesNotExist) {
    // Do something.
}
      }
    }


    $queryResult = $this->env->getQueryProcessor()->processQuery('default:default', OperationParams::create([
class MyClass { }

$x = new MyClass();
$x->foo = true;
      'query' => $query,
      'variables' => $arguments,
    ]));

    $build = [
      '#cache' => [
        'contexts' => $queryResult->getCacheContexts(),
        'tags' => $queryResult->getCacheTags(),
        'max-age' => $queryResult->getCacheMaxAge(),
      ],
    ];

    $this->env->getRenderer()->render($build);

    if ($this->env->isDebug()) {
      printf(
        '<div class="%s" data-graphql-query="%s" data-graphql-variables="%s">',
        'graphql-twig-debug-wrapper',
        htmlspecialchars($query),
        htmlspecialchars(json_encode($arguments))
      );
    }

    if ($queryResult->errors) {
      print('<ul class="graphql-twig-errors">');
      foreach ($queryResult->errors as $error) {
        printf('<li>%s</li>', $error->message);
      }
      print('</ul>');
    }
    else {
      $context['graphql'] = $queryResult->data;
      parent::display($context, $blocks);
    }

    if ($this->env->isDebug()) {
      print('</div>');
    }
  }

  /**
   * Recursively build the GraphQL query.
   *
   * Builds the templates GraphQL query by iterating through all included or
   * embedded templates recursively.
   */
  public function getGraphQLQuery() {

    $query = '';
    $includes = [];

    if ($this instanceof \Twig_Template) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
      $query = $this->getGraphQLFragment();

      $includes = array_keys($this->getGraphQLIncludes());

      // Recursively collect all included fragments.
      $includes = array_map(function ($template) {
        return $this->env->loadTemplate($template)->getGraphQLFragment();
      }, $includes);

      // Always add includes from parent templates.
      if ($parent = $this->getGraphQLParent()) {
        $includes += array_map(function ($template) {
          return $this->env->loadTemplate($template)->getGraphQLQuery();
        }, array_keys($parent->getGraphQLIncludes()));
      }
    }


    return implode("\n", [-1 => $query] + $includes);
  }

  /**
   * Get the files parent template.
   *
   * @return \Twig_Template|null
   *   The parent template or null.
   */
  protected function getGraphQLParent() {
    return static::rawGraphQLParent() ? $this->env->loadTemplate(static::rawGraphQLParent()) : NULL;
  }

  /**
   * Retrieve the files graphql fragment.
   *
   * @return string
   *   The GraphQL fragment.
   */
  public function getGraphQLFragment() {
    // If there is no query for this template, try to get one from the
    // parent template.
    if (!($query = static::rawGraphQLQuery()) && ($parent = $this->getGraphQLParent())) {
      $query = $parent->getGraphQLFragment();
    }
    return $query;
  }

  /**
   * Retrieve a list of all direct or indirect included templates.
   *
   * @param string[] $recursed
   *   The list of templates already recursed into. Used internally.
   *
   * @return string[]
   *   The list of included templates.
   */
  public function getGraphQLIncludes(&$recursed = []) {

    $includes = array_flip(static::rawGraphQLIncludes());
    foreach ($includes as $include => $key) {
      if (in_array($include, $recursed)) {
        continue;
      }

      $recursed[] = $include;

      // TODO: operate on template class instead.
      $includes += $this->env->loadTemplate($include)->getGraphQLIncludes($recursed);
    }

    return $includes;
  }
}


Push — 8.x-1.x ( c0c90f...8080a4 )

GraphQLTemplateTrait::setDebug() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			namespace Drupal\graphql_twig;
4
5			use Drupal\Core\Entity\EntityInterface;
6			use Drupal\Core\Template\TwigEnvironment;
7			use Drupal\graphql\GraphQL\Execution\QueryProcessor;
8			use GraphQL\Server\OperationParams;
9
10			/**
11			* Trait that will be attached to all GraphQL enabled Twig templates.
12			*/
13			trait GraphQLTemplateTrait {
14
15			/**
16			* @return bool
17			*/
18			abstract public static function hasGraphQLOperations();
19
20			/**
21			* @var string
22			*/
23			abstract public static function rawGraphQLQuery();
24
25			/**
26			* @return string
27			*/
28			abstract public static function rawGraphQLParent();
29
30			/**
31			* @return string[]
32			*/
33			abstract public static function rawGraphQLIncludes();
34
35			/**
36			* @return string[]
37			*/
38			abstract public static function rawGraphQLArguments();
39
40			/**
41			* The GraphQL query processor.
42			*
43			* @var \Drupal\graphql\GraphQL\Execution\QueryProcessor
44			*/
45			protected $queryProcessor;
46
47			/**
48			* Inject the query processor.
49			*
50			* @param \Drupal\graphql\GraphQL\Execution\QueryProcessor $queryProcessor
51			* The query processor instance.
52			*/
53			public function setQueryProcessor(QueryProcessor $queryProcessor) {
54			$this->queryProcessor = $queryProcessor;
55			}
56
57			/**
58			* {@inheritdoc}
59			*/
60			public function display(array $context, array $blocks = array()) {
61			if (!static::hasGraphQLOperations()) {
62			parent::display($context, $blocks);
63			return;
64			}
65
66			if (isset($context['graphql_arguments'])) {
67			$context = $context['graphql_arguments'];
68			}
69
70			$query = trim($this->getGraphQLQuery());
71
72			if (!$query) {
73			parent::display($context, $blocks);
74			return;
75			}
76
77			$arguments = [];
78			foreach (static::rawGraphQLArguments() as $var) {
79			if (isset($context[$var])) {
80			$arguments[$var] = $context[$var] instanceof EntityInterface ? $context[$var]->id() : $context[$var];
			0 ignored issues – show Bug introduced 2018-04-30 09:00 UTC by Report Bug Copy Issue Report The class `Drupal\Core\Entity\EntityInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
81			}
82			}
83
84
85			$queryResult = $this->env->getQueryProcessor()->processQuery('default:default', OperationParams::create([
			0 ignored issues – show Bug introduced 2018-04-30 09:00 UTC by Report Bug Copy Issue Report The property `env` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
86			'query' => $query,
87			'variables' => $arguments,
88			]));
89
90			$build = [
91			'#cache' => [
92			'contexts' => $queryResult->getCacheContexts(),
93			'tags' => $queryResult->getCacheTags(),
94			'max-age' => $queryResult->getCacheMaxAge(),
95			],
96			];
97
98			$this->env->getRenderer()->render($build);
99
100			if ($this->env->isDebug()) {
101			printf(
102			'<div class="%s" data-graphql-query="%s" data-graphql-variables="%s">',
103			'graphql-twig-debug-wrapper',
104			htmlspecialchars($query),
105			htmlspecialchars(json_encode($arguments))
106			);
107			}
108
109			if ($queryResult->errors) {
110			print('<ul class="graphql-twig-errors">');
111			foreach ($queryResult->errors as $error) {
112			printf('<li>%s</li>', $error->message);
113			}
114			print('</ul>');
115			}
116			else {
117			$context['graphql'] = $queryResult->data;
118			parent::display($context, $blocks);
119			}
120
121			if ($this->env->isDebug()) {
122			print('</div>');
123			}
124			}
125
126			/**
127			* Recursively build the GraphQL query.
128			*
129			* Builds the templates GraphQL query by iterating through all included or
130			* embedded templates recursively.
131			*/
132			public function getGraphQLQuery() {
133
134			$query = '';
135			$includes = [];
136
137			if ($this instanceof \Twig_Template) {
			0 ignored issues – show Bug introduced 2017-10-17 14:56 UTC by Report Bug Copy Issue Report The class `Twig_Template` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
138			$query = $this->getGraphQLFragment();
139
140			$includes = array_keys($this->getGraphQLIncludes());
141
142			// Recursively collect all included fragments.
143			$includes = array_map(function ($template) {
144			return $this->env->loadTemplate($template)->getGraphQLFragment();
145			}, $includes);
146
147			// Always add includes from parent templates.
148			if ($parent = $this->getGraphQLParent()) {
149			$includes += array_map(function ($template) {
150			return $this->env->loadTemplate($template)->getGraphQLQuery();
151			}, array_keys($parent->getGraphQLIncludes()));
152			}
153			}
154
155
156			return implode("\n", [-1 => $query] + $includes);
157			}
158
159			/**
160			* Get the files parent template.
161			*
162			* @return \Twig_Template\|null
163			* The parent template or null.
164			*/
165			protected function getGraphQLParent() {
166			return static::rawGraphQLParent() ? $this->env->loadTemplate(static::rawGraphQLParent()) : NULL;
167			}
168
169			/**
170			* Retrieve the files graphql fragment.
171			*
172			* @return string
173			* The GraphQL fragment.
174			*/
175			public function getGraphQLFragment() {
176			// If there is no query for this template, try to get one from the
177			// parent template.
178			if (!($query = static::rawGraphQLQuery()) && ($parent = $this->getGraphQLParent())) {
179			$query = $parent->getGraphQLFragment();
180			}
181			return $query;
182			}
183
184			/**
185			* Retrieve a list of all direct or indirect included templates.
186			*
187			* @param string[] $recursed
188			* The list of templates already recursed into. Used internally.
189			*
190			* @return string[]
191			* The list of included templates.
192			*/
193			public function getGraphQLIncludes(&$recursed = []) {
194
195			$includes = array_flip(static::rawGraphQLIncludes());
196			foreach ($includes as $include => $key) {
197			if (in_array($include, $recursed)) {
198			continue;
199			}
200
201			$recursed[] = $include;
202
203			// TODO: operate on template class instead.
204			$includes += $this->env->loadTemplate($include)->getGraphQLIncludes($recursed);
205			}
206
207			return $includes;
208			}
209			}
210

drupal-graphql / graphql-twig

Push — 8.x-1.x ( c0c90f...8080a4 )

GraphQLTemplateTrait::setDebug() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like