EntityById::resolve() - Code Metrics - Inspection of "Adding entity buffer." - drupal-graphql/graphql - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 8.x-3.x (#478)

by Sebastian

created 2018-01-23 15:48 UTC

EntityById::resolve() B

↳ Parent: EntityById

Complexity

Conditions	5
Paths	4

Size

Total Lines	25
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	13
nc	4
nop	3
dl	0
loc	25
rs	8.439
c	0
b	0
f	0

<?php

namespace Drupal\graphql_core\Plugin\GraphQL\Fields\Entity;

use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\DependencyInjection\DependencySerializationTrait;
use Drupal\Core\Entity\EntityRepositoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\graphql\GraphQL\Batching\Buffers\EntityBuffer;
use Drupal\graphql\GraphQL\Cache\CacheableValue;
use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Youshido\GraphQL\Execution\ResolveInfo;

/**
 * Retrieve an entity by its id.
 *
 * @GraphQLField(
 *   id = "entity_by_id",
 *   secure = true,
 *   name = "entityById",
 *   nullable = true,
 *   multi = false,
 *   weight = -1,
 *   arguments = {
 *     "id" = "String"
 *   },
 *   deriver = "Drupal\graphql_core\Plugin\Deriver\Fields\EntityByIdDeriver"
 * )
 */
class EntityById extends FieldPluginBase implements ContainerFactoryPluginInterface {

  use DependencySerializationTrait;

  /**
   * @var \Drupal\graphql\GraphQL\Batching\Buffers\EntityBuffer
   */
  protected $entityBuffer;

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

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

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

  /**
   * {@inheritdoc}
   */
  protected function resolveValues($value, array $args, ResolveInfo $info) {
    $resolver = $this->entityBuffer->add($this->getPluginDefinition()['entity_type'], $args['id']);
    return function ($value, array $args, ResolveInfo $info) use ($resolver) {
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
      if (!$entity = $resolver()) {
        // If there is no entity with this id, add the list cache tags so that the
        // cache entry is purged whenever a new entity of this type is saved.
        $pluginDefinition = $this->getPluginDefinition();
        $entityType = $this->entityTypeManager->getDefinition($pluginDefinition['entity_type']);
        $metadata = new CacheableMetadata();
        $metadata->addCacheTags($entityType->getListCacheTags());

        yield new CacheableValue(NULL, [$metadata]);
      }
      /** @var \Drupal\Core\Access\AccessResultInterface $access */
      else if (($access = $entity->access('view', NULL, TRUE)) && $access->isAllowed()) {
        if (isset($args['language']) && $args['language'] != $entity->language()->getId()) {
          $entity = $this->entityRepository->getTranslationFromContext($entity, $args['language']);
        }

        yield new CacheableValue($entity, [$access]);
      }
      else {
        // If the entity exists but we do not grant access to it, we still want
        // to have it's cache metadata in the output because future changes to
        // the entity might affect its visibility for the user.
        yield new CacheableValue(NULL, [$access]);
      }
    };
  }

}


1			<?php
2
3			namespace Drupal\graphql_core\Plugin\GraphQL\Fields\Entity;
4
5			use Drupal\Core\Cache\CacheableMetadata;
6			use Drupal\Core\DependencyInjection\DependencySerializationTrait;
7			use Drupal\Core\Entity\EntityRepositoryInterface;
8			use Drupal\Core\Entity\EntityTypeManagerInterface;
9			use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
10			use Drupal\graphql\GraphQL\Batching\Buffers\EntityBuffer;
11			use Drupal\graphql\GraphQL\Cache\CacheableValue;
12			use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
13			use Symfony\Component\DependencyInjection\ContainerInterface;
14			use Youshido\GraphQL\Execution\ResolveInfo;
15
16			/**
17			* Retrieve an entity by its id.
18			*
19			* @GraphQLField(
20			* id = "entity_by_id",
21			* secure = true,
22			* name = "entityById",
23			* nullable = true,
24			* multi = false,
25			* weight = -1,
26			* arguments = {
27			* "id" = "String"
28			* },
29			* deriver = "Drupal\graphql_core\Plugin\Deriver\Fields\EntityByIdDeriver"
30			* )
31			*/
32			class EntityById extends FieldPluginBase implements ContainerFactoryPluginInterface {
			0 ignored issues – show Bug introduced 2017-11-14 15:57 UTC by Report Bug Copy Issue Report There is one abstract method `getPluginDefinition` in this class; you could implement it, or declare this class as abstract. Loading history...
33			use DependencySerializationTrait;
34
35			/**
36			* @var \Drupal\graphql\GraphQL\Batching\Buffers\EntityBuffer
37			*/
38			protected $entityBuffer;
39
40			/**
41			* @var \Drupal\Core\Entity\EntityTypeManagerInterface
42			*/
43			protected $entityTypeManager;
44
45			/**
46			* @var \Drupal\Core\Entity\EntityRepositoryInterface
47			*/
48			protected $entityRepository;
49
50			/**
51			* {@inheritdoc}
52			*/
53			public function __construct(
54			array $configuration,
55			$pluginId,
56			$pluginDefinition,
57			EntityTypeManagerInterface $entityTypeManager,
58			EntityRepositoryInterface $entityRepository,
59			EntityBuffer $entityBuffer
60			) {
61			parent::__construct($configuration, $pluginId, $pluginDefinition);
62			$this->entityBuffer = $entityBuffer;
63			$this->entityTypeManager = $entityTypeManager;
64			$this->entityRepository = $entityRepository;
65			}
66
67			/**
68			* {@inheritdoc}
69			*/
70			public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
71			return new static(
72			$configuration,
73			$pluginId,
74			$pluginDefinition,
75			$container->get('entity_type.manager'),
76			$container->get('entity.repository'),
77			$container->get('graphql.buffer.entity')
78			);
79			}
80
81			/**
82			* {@inheritdoc}
83			*/
84			protected function resolveValues($value, array $args, ResolveInfo $info) {
85			$resolver = $this->entityBuffer->add($this->getPluginDefinition()['entity_type'], $args['id']);
86			return function ($value, array $args, ResolveInfo $info) use ($resolver) {
			0 ignored issues – show Bug Best Practice introduced 2018-01-23 15:46 UTC by Report Bug Copy Issue Report The return type of `return function ($value,...))); } } };` (`Closure`) is incompatible with the return type of the parent method `Drupal\graphql\Plugin\Gr...uginBase::resolveValues` of type `Generator`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history... Unused Code introduced 2018-01-23 14:46 UTC by Report Bug Copy Issue Report The parameter `$info` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
87			if (!$entity = $resolver()) {
88			// If there is no entity with this id, add the list cache tags so that the
89			// cache entry is purged whenever a new entity of this type is saved.
90			$pluginDefinition = $this->getPluginDefinition();
91			$entityType = $this->entityTypeManager->getDefinition($pluginDefinition['entity_type']);
92			$metadata = new CacheableMetadata();
93			$metadata->addCacheTags($entityType->getListCacheTags());
94
95			yield new CacheableValue(NULL, [$metadata]);
96			}
97			/** @var \Drupal\Core\Access\AccessResultInterface $access */
98			else if (($access = $entity->access('view', NULL, TRUE)) && $access->isAllowed()) {
99			if (isset($args['language']) && $args['language'] != $entity->language()->getId()) {
100			$entity = $this->entityRepository->getTranslationFromContext($entity, $args['language']);
101			}
102
103			yield new CacheableValue($entity, [$access]);
104			}
105			else {
106			// If the entity exists but we do not grant access to it, we still want
107			// to have it's cache metadata in the output because future changes to
108			// the entity might affect its visibility for the user.
109			yield new CacheableValue(NULL, [$access]);
110			}
111			};
112			}
113
114			}
115

drupal-graphql / graphql

Pull Request — 8.x-3.x (#478)

EntityById::resolve() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like