SubView::extractExposedInput() - Code Metrics - Inspection of "Create new subView to allow embedding a view insid..." - drupal-graphql/graphql-views - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 8.x-1.x (#35)

unknown

created 2020-05-08 01:23 UTC

SubView::extractExposedInput() B

↳ Parent: SubView

Complexity

Conditions	6
Paths	4

Size

Total Lines

Duplication

Lines	25
Ratio	100 %

Importance

Changes

Metric	Value
dl	25
loc	25
rs	8.8977
c	0
b	0
f	0
cc	6
nc	4
nop	3

<?php

namespace Drupal\graphql_views\Plugin\GraphQL\Fields;

use Drupal\Core\DependencyInjection\DependencySerializationTrait;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\graphql\GraphQL\Execution\ResolveContext;
use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
use GraphQL\Type\Definition\ResolveInfo;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Expose views as root fields.
 *
 * @GraphQLField(
 *   id = "subview",
 *   secure = true,
 *   parents = {"Root"},
 *   provider = "views",
 *   deriver = "Drupal\graphql_views\Plugin\Deriver\Fields\SubViewDeriver"
 * )
 */
class SubView extends FieldPluginBase implements ContainerFactoryPluginInterface {

  use DependencySerializationTrait;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(
    array $configuration,
    $pluginId,
    $pluginDefinition,
    EntityTypeManagerInterface $entityTypeManager
  ) {
    $this->entityTypeManager = $entityTypeManager;
    parent::__construct($configuration, $pluginId, $pluginDefinition);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
    return new static(
      $configuration,
      $pluginId,
      $pluginDefinition,
      $container->get('entity_type.manager')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function resolveValues($value, array $args, ResolveContext $context, ResolveInfo $info) {
    $storage = $this->entityTypeManager->getStorage('view');
    $definition = $this->getPluginDefinition();

    /** @var \Drupal\views\Entity\View $view */
    if ($view = $storage->load($definition['view'])) {
      $executable = $view->getExecutable();
      $executable->setDisplay($definition['display']);
      /** @var \Drupal\graphql_views\Plugin\views\display\GraphQL $display */
      $display = $executable->getDisplay($definition['display']);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

      // a subview can only work on an entity, so return null it it is not.

      if (!$value instanceof EntityInterface) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
        return;
      }

      // Set the first argument to the id of the current entity.
      $executable->setArguments([$value->id()]);

      $filters = $executable->getDisplay()->getOption('filters');;
      $input = $this->extractExposedInput($value, $args, $filters);
      $executable->setExposedInput($input);

      // This is a workaround for the Taxonomy Term filter which requires a full
      // exposed form to be sent OR the display being an attachment to just
      // accept input values.
      $executable->is_attachment = TRUE;
      $executable->exposed_raw_input = $input;

      if (!empty($definition['paged'])) {
        // Set paging parameters.
        $executable->setItemsPerPage($args['pageSize']);
        $executable->setCurrentPage($args['page']);
      }

      if (isset($args['offset']) && !empty($args['offset'])) {
        $executable->setOffset($args['offset']);
      }

      $result = $executable->render($definition['display']);
      /** @var \Drupal\Core\Cache\CacheableMetadata $cache */
      if ($cache = $result['cache']) {
        $cache->setCacheContexts(
          array_filter($cache->getCacheContexts(), function ($context) {
            // Don't emit the url cache contexts.
            return $context !== 'url' && strpos($context, 'url.') !== 0;
          })
        );
      }
      yield $result;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function getCacheDependencies(array $result, $value, array $args, ResolveContext $context, ResolveInfo $info) {
    return array_map(function ($item) {
      return $item['cache'];
    }, $result);
  }

  /**
   * Retrieves the contextual filter argument from the parent value or args.
   *
   * @param $value
   *   The resolved parent value.
   * @param $args
   *   The arguments provided to the field.
   *
   * @return array
   *   An array of arguments containing the contextual filter value from the
   *   parent or provided args if any.
   */
  protected function extractContextualFilters($value, $args) {
    $definition = $this->getPluginDefinition();
    $arguments = [];

    foreach ($definition['arguments_info'] as $argumentId => $argumentInfo) {
      if (isset($args['contextualFilter'][$argumentId])) {
        $arguments[$argumentInfo['index']] = $args['contextualFilter'][$argumentId];
      }
      elseif (
        $value instanceof EntityInterface &&
if ($x instanceof DoesNotExist) {
    // Do something.
}
        $value->getEntityTypeId() === $argumentInfo['entity_type'] &&
        (empty($argumentInfo['bundles']) ||
          in_array($value->bundle(), $argumentInfo['bundles'], TRUE))
      ) {
        $arguments[$argumentInfo['index']] = $value->id();
      }
      else {
        $arguments[$argumentInfo['index']] = NULL;
      }
    }

    return $arguments;
  }

  /**
   * Retrieves sort and filter arguments from the provided field args.
   *
   * @param $value
   *   The resolved parent value.
   * @param $args
   *   The array of arguments provided to the field.
   * @param $filters
   *   The available filters for the configured view.
   *
   * @return array
   *   The array of sort and filter arguments to execute the view with.
   */
  protected function extractExposedInput($value, $args, $filters) {
    // Prepare arguments for use as exposed form input.
    $input = array_filter([
      // Sorting arguments.
      'sort_by' => isset($args['sortBy']) ? $args['sortBy'] : NULL,
      'sort_order' => isset($args['sortDirection']) ? $args['sortDirection'] : NULL,
    ]);

    // If some filters are missing from the input, set them to an empty string
    // explicitly. Otherwise views module generates "Undefined index" notice.
    foreach ($filters as $filterKey => $filterRow) {
      if (!isset($filterRow['expose']['identifier'])) {
        continue;
      }

      $inputKey = $filterRow['expose']['identifier'];
      if (!isset($args['filter'][$inputKey])) {
        $input[$inputKey] = $filterRow['value'];
      } else {
        $input[$inputKey] = $args['filter'][$inputKey];
      }
    }

    return $input;
  }

}


Pull Request — 8.x-1.x (#35)

SubView::extractExposedInput() B

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_views\Plugin\GraphQL\Fields;
4
5		use Drupal\Core\DependencyInjection\DependencySerializationTrait;
6		use Drupal\Core\Entity\EntityInterface;
7		use Drupal\Core\Entity\EntityTypeManagerInterface;
8		use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
9		use Drupal\graphql\GraphQL\Execution\ResolveContext;
10		use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
11		use GraphQL\Type\Definition\ResolveInfo;
12		use Symfony\Component\DependencyInjection\ContainerInterface;
13
14		/**
15		* Expose views as root fields.
16		*
17		* @GraphQLField(
18		* id = "subview",
19		* secure = true,
20		* parents = {"Root"},
21		* provider = "views",
22		* deriver = "Drupal\graphql_views\Plugin\Deriver\Fields\SubViewDeriver"
23		* )
24		*/
25	View Code Duplication	class SubView extends FieldPluginBase implements ContainerFactoryPluginInterface {
		0 ignored issues – show Duplication introduced 2020-05-07 07:52 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
26		use DependencySerializationTrait;
27
28		/**
29		* The entity type manager.
30		*
31		* @var \Drupal\Core\Entity\EntityTypeManagerInterface
32		*/
33		protected $entityTypeManager;
34
35		/**
36		* {@inheritdoc}
37		*/
38		public function __construct(
39		array $configuration,
40		$pluginId,
41		$pluginDefinition,
42		EntityTypeManagerInterface $entityTypeManager
43		) {
44		$this->entityTypeManager = $entityTypeManager;
45		parent::__construct($configuration, $pluginId, $pluginDefinition);
46		}
47
48		/**
49		* {@inheritdoc}
50		*/
51		public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
52		return new static(
53		$configuration,
54		$pluginId,
55		$pluginDefinition,
56		$container->get('entity_type.manager')
57		);
58		}
59
60		/**
61		* {@inheritdoc}
62		*/
63		public function resolveValues($value, array $args, ResolveContext $context, ResolveInfo $info) {
64		$storage = $this->entityTypeManager->getStorage('view');
65		$definition = $this->getPluginDefinition();
66
67		/** @var \Drupal\views\Entity\View $view */
68		if ($view = $storage->load($definition['view'])) {
69		$executable = $view->getExecutable();
70		$executable->setDisplay($definition['display']);
71		/** @var \Drupal\graphql_views\Plugin\views\display\GraphQL $display */
72		$display = $executable->getDisplay($definition['display']);
		0 ignored issues – show Unused Code introduced 2020-05-07 07:52 UTC by Report Bug Copy Issue Report `$display` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
73
74		// a subview can only work on an entity, so return null it it is not.
75
76		if (!$value instanceof EntityInterface) {
		0 ignored issues – show Bug introduced 2020-05-07 07:52 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...
77		return;
78		}
79
80		// Set the first argument to the id of the current entity.
81		$executable->setArguments([$value->id()]);
82
83		$filters = $executable->getDisplay()->getOption('filters');;
84		$input = $this->extractExposedInput($value, $args, $filters);
85		$executable->setExposedInput($input);
86
87		// This is a workaround for the Taxonomy Term filter which requires a full
88		// exposed form to be sent OR the display being an attachment to just
89		// accept input values.
90		$executable->is_attachment = TRUE;
91		$executable->exposed_raw_input = $input;
92
93		if (!empty($definition['paged'])) {
94		// Set paging parameters.
95		$executable->setItemsPerPage($args['pageSize']);
96		$executable->setCurrentPage($args['page']);
97		}
98
99		if (isset($args['offset']) && !empty($args['offset'])) {
100		$executable->setOffset($args['offset']);
101		}
102
103		$result = $executable->render($definition['display']);
104		/** @var \Drupal\Core\Cache\CacheableMetadata $cache */
105		if ($cache = $result['cache']) {
106		$cache->setCacheContexts(
107		array_filter($cache->getCacheContexts(), function ($context) {
108		// Don't emit the url cache contexts.
109		return $context !== 'url' && strpos($context, 'url.') !== 0;
110		})
111		);
112		}
113		yield $result;
114		}
115		}
116
117		/**
118		* {@inheritdoc}
119		*/
120		protected function getCacheDependencies(array $result, $value, array $args, ResolveContext $context, ResolveInfo $info) {
121		return array_map(function ($item) {
122		return $item['cache'];
123		}, $result);
124		}
125
126		/**
127		* Retrieves the contextual filter argument from the parent value or args.
128		*
129		* @param $value
130		* The resolved parent value.
131		* @param $args
132		* The arguments provided to the field.
133		*
134		* @return array
135		* An array of arguments containing the contextual filter value from the
136		* parent or provided args if any.
137		*/
138		protected function extractContextualFilters($value, $args) {
139		$definition = $this->getPluginDefinition();
140		$arguments = [];
141
142		foreach ($definition['arguments_info'] as $argumentId => $argumentInfo) {
143		if (isset($args['contextualFilter'][$argumentId])) {
144		$arguments[$argumentInfo['index']] = $args['contextualFilter'][$argumentId];
145		}
146		elseif (
147		$value instanceof EntityInterface &&
		0 ignored issues – show Bug introduced 2020-05-07 07:52 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...
148		$value->getEntityTypeId() === $argumentInfo['entity_type'] &&
149		(empty($argumentInfo['bundles']) \|\|
150		in_array($value->bundle(), $argumentInfo['bundles'], TRUE))
151		) {
152		$arguments[$argumentInfo['index']] = $value->id();
153		}
154		else {
155		$arguments[$argumentInfo['index']] = NULL;
156		}
157		}
158
159		return $arguments;
160		}
161
162		/**
163		* Retrieves sort and filter arguments from the provided field args.
164		*
165		* @param $value
166		* The resolved parent value.
167		* @param $args
168		* The array of arguments provided to the field.
169		* @param $filters
170		* The available filters for the configured view.
171		*
172		* @return array
173		* The array of sort and filter arguments to execute the view with.
174		*/
175		protected function extractExposedInput($value, $args, $filters) {
176		// Prepare arguments for use as exposed form input.
177		$input = array_filter([
178		// Sorting arguments.
179		'sort_by' => isset($args['sortBy']) ? $args['sortBy'] : NULL,
180		'sort_order' => isset($args['sortDirection']) ? $args['sortDirection'] : NULL,
181		]);
182
183		// If some filters are missing from the input, set them to an empty string
184		// explicitly. Otherwise views module generates "Undefined index" notice.
185		foreach ($filters as $filterKey => $filterRow) {
186		if (!isset($filterRow['expose']['identifier'])) {
187		continue;
188		}
189
190		$inputKey = $filterRow['expose']['identifier'];
191		if (!isset($args['filter'][$inputKey])) {
192		$input[$inputKey] = $filterRow['value'];
193		} else {
194		$input[$inputKey] = $args['filter'][$inputKey];
195		}
196		}
197
198		return $input;
199		}
200
201		}
202

drupal-graphql / graphql-views

Pull Request — 8.x-1.x (#35)

SubView::extractExposedInput() B

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