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

Completed

Push — 8.x-3.x ( fa0adf...118308 )

by Sebastian

created 2018-01-23 18:00 UTC

EntityById::create() A

↳ Parent: EntityById

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	8
nc	1
nop	4
dl	0
loc	10
rs	9.4285
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;

  /**
   * The entity buffer service.
   *
   * @var \Drupal\graphql\GraphQL\Batching\Buffers\EntityBuffer
   */
  protected $entityBuffer;

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

  /**
   * The entity repository service.
   *
   * @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			* The entity buffer service.
37			*
38			* @var \Drupal\graphql\GraphQL\Batching\Buffers\EntityBuffer
39			*/
40			protected $entityBuffer;
41
42			/**
43			* The entity type manager service.
44			*
45			* @var \Drupal\Core\Entity\EntityTypeManagerInterface
46			*/
47			protected $entityTypeManager;
48
49			/**
50			* The entity repository service.
51			*
52			* @var \Drupal\Core\Entity\EntityRepositoryInterface
53			*/
54			protected $entityRepository;
55
56			/**
57			* {@inheritdoc}
58			*/
59			public function __construct(
60			array $configuration,
61			$pluginId,
62			$pluginDefinition,
63			EntityTypeManagerInterface $entityTypeManager,
64			EntityRepositoryInterface $entityRepository,
65			EntityBuffer $entityBuffer
66			) {
67			parent::__construct($configuration, $pluginId, $pluginDefinition);
68			$this->entityBuffer = $entityBuffer;
69			$this->entityTypeManager = $entityTypeManager;
70			$this->entityRepository = $entityRepository;
71			}
72
73			/**
74			* {@inheritdoc}
75			*/
76			public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
77			return new static(
78			$configuration,
79			$pluginId,
80			$pluginDefinition,
81			$container->get('entity_type.manager'),
82			$container->get('entity.repository'),
83			$container->get('graphql.buffer.entity')
84			);
85			}
86
87			/**
88			* {@inheritdoc}
89			*/
90			protected function resolveValues($value, array $args, ResolveInfo $info) {
91			$resolver = $this->entityBuffer->add($this->getPluginDefinition()['entity_type'], $args['id']);
92			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...
93			if (!$entity = $resolver()) {
94			// If there is no entity with this id, add the list cache tags so that the
95			// cache entry is purged whenever a new entity of this type is saved.
96			$pluginDefinition = $this->getPluginDefinition();
97			$entityType = $this->entityTypeManager->getDefinition($pluginDefinition['entity_type']);
98			$metadata = new CacheableMetadata();
99			$metadata->addCacheTags($entityType->getListCacheTags());
100
101			yield new CacheableValue(NULL, [$metadata]);
102			}
103			/** @var \Drupal\Core\Access\AccessResultInterface $access */
104			else if (($access = $entity->access('view', NULL, TRUE)) && $access->isAllowed()) {
105			if (isset($args['language']) && $args['language'] != $entity->language()->getId()) {
106			$entity = $this->entityRepository->getTranslationFromContext($entity, $args['language']);
107			}
108
109			yield new CacheableValue($entity, [$access]);
110			}
111			else {
112			// If the entity exists but we do not grant access to it, we still want
113			// to have it's cache metadata in the output because future changes to
114			// the entity might affect its visibility for the user.
115			yield new CacheableValue(NULL, [$access]);
116			}
117			};
118			}
119
120			}
121

drupal-graphql / graphql

Push — 8.x-3.x ( fa0adf...118308 )

EntityById::create() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like