EntityRendered - Code Metrics - Inspection of "Adding rendered entity field. (#495)" - drupal-graphql/graphql - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 8.x-3.x ( b9f7cd...f28ad9 )

by Sebastian

created 2018-02-02 16:22 UTC

EntityRendered A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
dl	0
loc	81
rs	10
c	0
b	0
f	0
wmc	9
lcom	1
cbo	5

4 Methods

Rating	Name	Size	Complexity
A	__construct()	11	1
A	create()	9	1
A	buildArguments()	17	3
A	resolveValues()	10	4

<?php

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

use Drupal\Core\DependencyInjection\DependencySerializationTrait;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Render\RendererInterface;
use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
use Drupal\graphql\Plugin\GraphQL\PluggableSchemaBuilderInterface;
use Drupal\graphql\Utility\StringHelper;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Youshido\GraphQL\Execution\ResolveInfo;
use Youshido\GraphQL\Field\InputField;

/**
 * @GraphQLField(
 *   id = "entity_rendered",
 *   name = "entityRendered",
 *   type = "String",
 *   secure = true,
 *   deriver = "Drupal\graphql_core\Plugin\Deriver\Fields\EntityRenderedDeriver",
 * )
 */
class EntityRendered extends FieldPluginBase  implements ContainerFactoryPluginInterface {

  use DependencySerializationTrait;

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

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

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

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

  /**
   * {@inheritdoc}
   */
  protected function buildArguments(PluggableSchemaBuilderInterface $schemaBuilder) {
    $arguments = parent::buildArguments($schemaBuilder);

    if (empty($arguments['mode'])) {
      $definition = $this->getPluginDefinition();
      $type = StringHelper::camelCase($definition['entity_type'], 'display', 'mode', 'id');

      if ($type = $schemaBuilder->findByName($type, [GRAPHQL_ENUM_PLUGIN])) {
        $arguments['mode'] = new InputField([
          'name' => 'mode',
          'type' => $type->getDefinition($schemaBuilder),
        ]);
      }
    }

    return $arguments;
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());
}
  }

  /**
   * {@inheritdoc}
   */
  public function resolveValues($value, array $args, ResolveInfo $info) {
    if ($value instanceof ContentEntityInterface) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
      $mode = isset($args['mode']) ? $args['mode'] : 'full';
      $language = isset($args['language']) ? $args['language'] : $value->language()->getId();

      $builder = $this->entityTypeManager->getViewBuilder($value->getEntityTypeId());
      $rendered = $builder->view($value, $mode, $language);
      yield $this->renderer->render($rendered);
    }
  }

}


Push — 8.x-3.x ( b9f7cd...f28ad9 )

EntityRendered A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			namespace Drupal\graphql_core\Plugin\GraphQL\Fields\Entity;
4
5			use Drupal\Core\DependencyInjection\DependencySerializationTrait;
6			use Drupal\Core\Entity\ContentEntityInterface;
7			use Drupal\Core\Entity\EntityTypeManagerInterface;
8			use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
9			use Drupal\Core\Render\RendererInterface;
10			use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
11			use Drupal\graphql\Plugin\GraphQL\PluggableSchemaBuilderInterface;
12			use Drupal\graphql\Utility\StringHelper;
13			use Symfony\Component\DependencyInjection\ContainerInterface;
14			use Youshido\GraphQL\Execution\ResolveInfo;
15			use Youshido\GraphQL\Field\InputField;
16
17			/**
18			* @GraphQLField(
19			* id = "entity_rendered",
20			* name = "entityRendered",
21			* type = "String",
22			* secure = true,
23			* deriver = "Drupal\graphql_core\Plugin\Deriver\Fields\EntityRenderedDeriver",
24			* )
25			*/
26			class EntityRendered extends FieldPluginBase implements ContainerFactoryPluginInterface {
			0 ignored issues – show Bug introduced 2018-01-24 16:56 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... Coding Style introduced 2018-02-02 13:51 UTC by Report Bug Copy Issue Report Expected 1 space before implements keyword; 2 found Loading history...
27			use DependencySerializationTrait;
28
29			/**
30			* The entity type manager service.
31			*
32			* @var \Drupal\Core\Entity\EntityTypeManagerInterface
33			*/
34			protected $entityTypeManager;
35
36			/**
37			* The renderer service.
38			*
39			* @var \Drupal\Core\Render\RendererInterface
40			*/
41			protected $renderer;
42
43			/**
44			* {@inheritdoc}
45			*/
46			public function __construct(
47			array $configuration,
48			$pluginId,
49			$pluginDefinition,
50			EntityTypeManagerInterface $entityTypeManager,
51			RendererInterface $renderer
52			) {
53			parent::__construct($configuration, $pluginId, $pluginDefinition);
54			$this->entityTypeManager = $entityTypeManager;
55			$this->renderer = $renderer;
56			}
57
58			/**
59			* {@inheritdoc}
60			*/
61			public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
62			return new static(
63			$configuration,
64			$pluginId,
65			$pluginDefinition,
66			$container->get('entity_type.manager'),
67			$container->get('renderer')
68			);
69			}
70
71			/**
72			* {@inheritdoc}
73			*/
74			protected function buildArguments(PluggableSchemaBuilderInterface $schemaBuilder) {
75			$arguments = parent::buildArguments($schemaBuilder);
76
77			if (empty($arguments['mode'])) {
78			$definition = $this->getPluginDefinition();
79			$type = StringHelper::camelCase($definition['entity_type'], 'display', 'mode', 'id');
80
81			if ($type = $schemaBuilder->findByName($type, [GRAPHQL_ENUM_PLUGIN])) {
82			$arguments['mode'] = new InputField([
83			'name' => 'mode',
84			'type' => $type->getDefinition($schemaBuilder),
85			]);
86			}
87			}
88
89			return $arguments;
			0 ignored issues – show Bug Best Practice introduced 2018-02-02 13:51 UTC by Report Bug Copy Issue Report The return type of `return $arguments;` (`array<,Youshido\GraphQL...ld\InputFieldInterface>`) is incompatible with the return type of the parent method `Drupal\graphql\Plugin\Gr...ginBase::buildArguments` of type `Youshido\GraphQL\Field\InputFieldInterface[]`. 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...
90			}
91
92			/**
93			* {@inheritdoc}
94			*/
95			public function resolveValues($value, array $args, ResolveInfo $info) {
96			if ($value instanceof ContentEntityInterface) {
			0 ignored issues – show Bug introduced 2017-10-17 14:57 UTC by Report Bug Copy Issue Report The class `Drupal\Core\Entity\ContentEntityInterface` 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...
97			$mode = isset($args['mode']) ? $args['mode'] : 'full';
98			$language = isset($args['language']) ? $args['language'] : $value->language()->getId();
99
100			$builder = $this->entityTypeManager->getViewBuilder($value->getEntityTypeId());
101			$rendered = $builder->view($value, $mode, $language);
102			yield $this->renderer->render($rendered);
103			}
104			}
105
106			}
107

drupal-graphql / graphql

Push — 8.x-3.x ( b9f7cd...f28ad9 )

EntityRendered A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like