Cardinality::validate() - Code Metrics - Inspection of "Issue #2366335 by samuel.mortenson, Primsi, slashr..." - drupal-media/entity_browser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 8.x-1.x ( 563420...b8d656 )

by Janez

created 2016-07-12 22:20 UTC

Cardinality::validate() A

↳ Parent: Cardinality

Complexity

Conditions	3
Paths	2

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	10
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	16
rs	9.4285

<?php

namespace Drupal\entity_browser\Plugin\EntityBrowser\WidgetValidation;

use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\entity_browser\WidgetValidationBase;
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\ConstraintViolationList;

/**
 * Validates that the widget returns the appropriate number of elements.
 *
 * @EntityBrowserWidgetValidation(
 *   id = "cardinality",
 *   label = @Translation("Cardinality validator")
 * )
 */
class Cardinality extends WidgetValidationBase {

  /**
   * {@inheritdoc}
   */
  public function validate(array $entities, $options = []) {
    $violations = new ConstraintViolationList();

    // As this validation happens at a level above the individual entities,
    // we implement logic without using Constraint Plugins.
    $count = count($entities);
    $max = $options['cardinality'];
    if ($max !== FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED && $count > $max) {
      $message = 'You can not select more than %max entities.';
      $parameters = ['%max' => $max];
      $violation = new ConstraintViolation($this->t($message, $parameters), $message, $parameters, $count, '', $count);
      $violations->add($violation);
    }

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

}


1			<?php
2
3			namespace Drupal\entity_browser\Plugin\EntityBrowser\WidgetValidation;
4
5			use Drupal\Core\Field\FieldStorageDefinitionInterface;
6			use Drupal\entity_browser\WidgetValidationBase;
7			use Symfony\Component\Validator\ConstraintViolation;
8			use Symfony\Component\Validator\ConstraintViolationList;
9
10			/**
11			* Validates that the widget returns the appropriate number of elements.
12			*
13			* @EntityBrowserWidgetValidation(
14			* id = "cardinality",
15			* label = @Translation("Cardinality validator")
16			* )
17			*/
18			class Cardinality extends WidgetValidationBase {
19
20			/**
21			* {@inheritdoc}
22			*/
23			public function validate(array $entities, $options = []) {
24			$violations = new ConstraintViolationList();
25
26			// As this validation happens at a level above the individual entities,
27			// we implement logic without using Constraint Plugins.
28			$count = count($entities);
29			$max = $options['cardinality'];
30			if ($max !== FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED && $count > $max) {
31			$message = 'You can not select more than %max entities.';
32			$parameters = ['%max' => $max];
33			$violation = new ConstraintViolation($this->t($message, $parameters), $message, $parameters, $count, '', $count);
34			$violations->add($violation);
35			}
36
37			return $violations;
			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 $violations;` (`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...
38			}
39
40			}
41

drupal-media / entity_browser

Push — 8.x-1.x ( 563420...b8d656 )

Cardinality::validate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like