View   A
last analyzed

Complexity

Total Complexity 24

Size/Duplication

Total Lines 173
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 0

Importance

Changes 0
Metric Value
wmc 24
lcom 1
cbo 0
dl 0
loc 173
rs 10
c 0
b 0
f 0

6 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 9 1
A create() 0 8 1
B resolveValues() 0 49 8
A getCacheDependencies() 0 5 1
B extractContextualFilters() 0 23 7
B extractExposedInput() 0 25 6
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 = "view",
19
 *   secure = true,
20
 *   parents = {"Root"},
21
 *   provider = "views",
22
 *   deriver = "Drupal\graphql_views\Plugin\Deriver\Fields\ViewDeriver"
23
 * )
24
 */
25
class View extends FieldPluginBase implements ContainerFactoryPluginInterface {
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
72
      // Set view contextual filters.
73
      /* @see \Drupal\graphql_views\ViewDeriverHelperTrait::getArgumentsInfo() */
74
      if (!empty($definition['arguments_info'])) {
75
        $arguments = $this->extractContextualFilters($value, $args);
76
        $executable->setArguments($arguments);
77
      }
78
79
      $filters = $executable->getDisplay()->getOption('filters');;
80
      $input = $this->extractExposedInput($value, $args, $filters);
81
      $executable->setExposedInput($input);
82
83
      // This is a workaround for the Taxonomy Term filter which requires a full
84
      // exposed form to be sent OR the display being an attachment to just
85
      // accept input values.
86
      $executable->is_attachment = TRUE;
87
      $executable->exposed_raw_input = $input;
88
89
      if (!empty($definition['paged'])) {
90
        // Set paging parameters.
91
        $executable->setItemsPerPage($args['pageSize']);
92
        $executable->setCurrentPage($args['page']);
93
      }
94
95
      if (isset($args['offset']) && !empty($args['offset'])) {
96
        $executable->setOffset($args['offset']);
97
      }
98
99
      $result = $executable->render($definition['display']);
100
      /** @var \Drupal\Core\Cache\CacheableMetadata $cache */
101
      if ($cache = $result['cache']) {
102
        $cache->setCacheContexts(
103
          array_filter($cache->getCacheContexts(), function ($context) {
104
            // Don't emit the url cache contexts.
105
            return $context !== 'url' && strpos($context, 'url.') !== 0;
106
          })
107
        );
108
      }
109
      yield $result;
110
    }
111
  }
112
113
  /**
114
   * {@inheritdoc}
115
   */
116
  protected function getCacheDependencies(array $result, $value, array $args, ResolveContext $context, ResolveInfo $info) {
117
    return array_map(function ($item) {
118
      return $item['cache'];
119
    }, $result);
120
  }
121
122
  /**
123
   * Retrieves the contextual filter argument from the parent value or args.
124
   *
125
   * @param $value
126
   *   The resolved parent value.
127
   * @param $args
128
   *   The arguments provided to the field.
129
   *
130
   * @return array
131
   *   An array of arguments containing the contextual filter value from the
132
   *   parent or provided args if any.
133
   */
134
  protected function extractContextualFilters($value, $args) {
135
    $definition = $this->getPluginDefinition();
136
    $arguments = [];
137
138
    foreach ($definition['arguments_info'] as $argumentId => $argumentInfo) {
139
      if (isset($args['contextualFilter'][$argumentId])) {
140
        $arguments[$argumentInfo['index']] = $args['contextualFilter'][$argumentId];
141
      }
142
      elseif (
143
        $value instanceof EntityInterface &&
0 ignored issues
show
Bug introduced by
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...
144
        $value->getEntityTypeId() === $argumentInfo['entity_type'] &&
145
        (empty($argumentInfo['bundles']) ||
146
          in_array($value->bundle(), $argumentInfo['bundles'], TRUE))
147
      ) {
148
        $arguments[$argumentInfo['index']] = $value->id();
149
      }
150
      else {
151
        $arguments[$argumentInfo['index']] = NULL;
152
      }
153
    }
154
155
    return $arguments;
156
  }
157
158
  /**
159
   * Retrieves sort and filter arguments from the provided field args.
160
   *
161
   * @param $value
162
   *   The resolved parent value.
163
   * @param $args
164
   *   The array of arguments provided to the field.
165
   * @param $filters
166
   *   The available filters for the configured view.
167
   *
168
   * @return array
169
   *   The array of sort and filter arguments to execute the view with.
170
   */
171
  protected function extractExposedInput($value, $args, $filters) {
172
    // Prepare arguments for use as exposed form input.
173
    $input = array_filter([
174
      // Sorting arguments.
175
      'sort_by' => isset($args['sortBy']) ? $args['sortBy'] : NULL,
176
      'sort_order' => isset($args['sortDirection']) ? $args['sortDirection'] : NULL,
177
    ]);
178
179
    // If some filters are missing from the input, set them to an empty string
180
    // explicitly. Otherwise views module generates "Undefined index" notice.
181
    foreach ($filters as $filterKey => $filterRow) {
182
      if (!isset($filterRow['expose']['identifier'])) {
183
        continue;
184
      }
185
186
      $inputKey = $filterRow['expose']['identifier'];
187
      if (!isset($args['filter'][$inputKey])) {
188
        $input[$inputKey] = $filterRow['value'];
189
      } else {
190
        $input[$inputKey] = $args['filter'][$inputKey];
191
      }
192
    }
193
194
    return $input;
195
  }
196
197
}
198