WidgetValidationBase::__construct() - Code Metrics - drupal-media/entity_browser - Measure and Improve Code Quality continuously with Scrutinizer

WidgetValidationBase::__construct() A
last analyzed 2017-11-30 13:19 UTC

↳ Parent: WidgetValidationBase

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	4
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php

namespace Drupal\entity_browser;

use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Plugin\PluginBase;
use Drupal\Core\TypedData\DataDefinitionInterface;
use Drupal\Core\TypedData\TypedDataManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Validator\ConstraintViolationList;

/**
 * Base implementation for widget validation plugins.
 */
abstract class WidgetValidationBase extends PluginBase implements WidgetValidationInterface, ContainerFactoryPluginInterface {

  /**
   * Plugin label.
   *
   * @var string
   */
  protected $label;

  /**
   * The Typed Data Manager service.
   *
   * @var \Drupal\Core\TypedData\TypedDataManagerInterface
   */
  protected $typedDataManager;

  public function __construct(array $configuration, $plugin_id, $plugin_definition, TypedDataManagerInterface $typed_data_manager) {
    $plugin_definition += [
      'constraint' => NULL,
    ];
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->typedDataManager = $typed_data_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('typed_data_manager')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    $this->label;
  }

  /**
   * {@inheritdoc}
   */
  public function validate(array $entities, $options = []) {
    $plugin_definition = $this->getPluginDefinition();
    $data_definition = $this->getDataDefinition($plugin_definition['data_type'], $plugin_definition['constraint'], $options);
    return $this->validateDataDefinition($data_definition, $entities);
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 getConfiguration() {
    return $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

  /**
   * Gets a data definition and optionally adds a constraint.
   *
   * @param string $data_type
   *   The data type plugin ID, for which a constraint should be added.
   * @param string $constraint_name
   *   The name of the constraint to add, i.e. its plugin id.
   * @param $options
   *   Array of options needed by the constraint validator.
   *
   * @return \Drupal\Core\TypedData\DataDefinitionInterface
   *   A data definition object for the given data type.
   */
  protected function getDataDefinition($data_type, $constraint_name = NULL, $options = []) {
    $data_definition = $this->typedDataManager->createDataDefinition($data_type);
    if ($constraint_name) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
      $data_definition->addConstraint($constraint_name, $options);
    }
    return $data_definition;
  }

  /**
   * Creates and validates instances of typed data for each Entity.
   *
   * @param \Drupal\Core\TypedData\DataDefinitionInterface $data_definition
   *   The data definition generated from ::getDataDefinition().
   * @param array $entities
   *   An array of Entities to validate the definition against
   *
   * @return \Symfony\Component\Validator\ConstraintViolationListInterface
   *   A list of violations.
   */
  protected function validateDataDefinition(DataDefinitionInterface $data_definition, array $entities) {
    $violations = new ConstraintViolationList();
    foreach ($entities as $entity) {
      $validation_result = $this->typedDataManager->create($data_definition, $entity)->validate();
      $violations->addAll($validation_result);
    }

    return $violations;
  }
}


1			<?php
2
3			namespace Drupal\entity_browser;
4
5			use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
6			use Drupal\Core\Plugin\PluginBase;
7			use Drupal\Core\TypedData\DataDefinitionInterface;
8			use Drupal\Core\TypedData\TypedDataManagerInterface;
9			use Symfony\Component\DependencyInjection\ContainerInterface;
10			use Symfony\Component\Validator\ConstraintViolationList;
11
12			/**
13			* Base implementation for widget validation plugins.
14			*/
15			abstract class WidgetValidationBase extends PluginBase implements WidgetValidationInterface, ContainerFactoryPluginInterface {
16
17			/**
18			* Plugin label.
19			*
20			* @var string
21			*/
22			protected $label;
23
24			/**
25			* The Typed Data Manager service.
26			*
27			* @var \Drupal\Core\TypedData\TypedDataManagerInterface
28			*/
29			protected $typedDataManager;
30
31			public function __construct(array $configuration, $plugin_id, $plugin_definition, TypedDataManagerInterface $typed_data_manager) {
32			$plugin_definition += [
33			'constraint' => NULL,
34			];
35			parent::__construct($configuration, $plugin_id, $plugin_definition);
36			$this->typedDataManager = $typed_data_manager;
37			}
38
39			/**
40			* {@inheritdoc}
41			*/
42			public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
43			return new static(
44			$configuration,
45			$plugin_id,
46			$plugin_definition,
47			$container->get('typed_data_manager')
48			);
49			}
50
51			/**
52			* {@inheritdoc}
53			*/
54			public function defaultConfiguration() {
55			return [];
56			}
57
58			/**
59			* {@inheritdoc}
60			*/
61			public function label() {
62			$this->label;
63			}
64
65			/**
66			* {@inheritdoc}
67			*/
68			public function validate(array $entities, $options = []) {
69			$plugin_definition = $this->getPluginDefinition();
70			$data_definition = $this->getDataDefinition($plugin_definition['data_type'], $plugin_definition['constraint'], $options);
71			return $this->validateDataDefinition($data_definition, $entities);
			0 ignored issues – show Bug Best Practice introduced 2016-07-12 22:23 UTC by Report Bug Copy Issue Report The return type of `return $this->validateDa...definition, $entities);` (`Symfony\Component\Valida...ConstraintViolationList`) is incompatible with the return type declared by the interface `Drupal\entity_browser\Wi...tionInterface::validate` of type `Symfony\Component\Valida...tViolationListInterface`. 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...
72			}
73
74			/**
75			* {@inheritdoc}
76			*/
77			public function getConfiguration() {
78			return $this->configuration;
79			}
80
81			/**
82			* {@inheritdoc}
83			*/
84			public function setConfiguration(array $configuration) {
85			$this->configuration = $configuration;
86			}
87
88			/**
89			* {@inheritdoc}
90			*/
91			public function calculateDependencies() {
92			return [];
93			}
94
95			/**
96			* Gets a data definition and optionally adds a constraint.
97			*
98			* @param string $data_type
99			* The data type plugin ID, for which a constraint should be added.
100			* @param string $constraint_name
101			* The name of the constraint to add, i.e. its plugin id.
102			* @param $options
103			* Array of options needed by the constraint validator.
104			*
105			* @return \Drupal\Core\TypedData\DataDefinitionInterface
106			* A data definition object for the given data type.
107			*/
108			protected function getDataDefinition($data_type, $constraint_name = NULL, $options = []) {
109			$data_definition = $this->typedDataManager->createDataDefinition($data_type);
110			if ($constraint_name) {
			0 ignored issues – show Bug Best Practice introduced 2016-07-12 22:23 UTC by Report Bug Copy Issue Report The expression `$constraint_name` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
111			$data_definition->addConstraint($constraint_name, $options);
112			}
113			return $data_definition;
114			}
115
116			/**
117			* Creates and validates instances of typed data for each Entity.
118			*
119			* @param \Drupal\Core\TypedData\DataDefinitionInterface $data_definition
120			* The data definition generated from ::getDataDefinition().
121			* @param array $entities
122			* An array of Entities to validate the definition against
123			*
124			* @return \Symfony\Component\Validator\ConstraintViolationListInterface
125			* A list of violations.
126			*/
127			protected function validateDataDefinition(DataDefinitionInterface $data_definition, array $entities) {
128			$violations = new ConstraintViolationList();
129			foreach ($entities as $entity) {
130			$validation_result = $this->typedDataManager->create($data_definition, $entity)->validate();
131			$violations->addAll($validation_result);
132			}
133
134			return $violations;
135			}
136			}
137

drupal-media / entity_browser

WidgetValidationBase::__construct() A last analyzed 2017-11-30 13:19 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WidgetValidationBase::__construct() A
last analyzed 2017-11-30 13:19 UTC