Image::assign() - Code Metrics - Inspection of "Refactoring tracking partner and product venture" - tricae-br/iris - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

by Rafael

created 2016-01-06 12:50 UTC

Image::assign() A

↳ Parent: Image

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	13
rs	9.4286
cc	2
eloc	7
nc	2
nop	1

<?php

namespace Iris\Mapping;

class Image extends Base
{
    /**
     * @var \Iris\Mapping\OrderCustomer
     */
    private $customerMapping;


    /**
     * @var \Iris\Mapping\OrderAddress
     */
    private $addressMapping;


    /**
     * @var \Iris\Mapping\OrderItem
     */
    private $itemMapping;


    /**
     * {@inheritdoc}
     */
    public function assign(array $externalData)
    {
        $images = [];

        foreach ($externalData as $image) {
            $images[] = new \Iris\Transfer\Catalog\Image([
                'url'      => $image['url'],
                'position' => $image['position']
            ]);
        }

         return $imageCollection = new \Iris\Transfer\Catalog\ImageCollection($images);
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 map($internalData)
    {
        $externalData = [];
        foreach ($internalData as $image) {
            $externalData[] = [
                'url'      => $image->getUrl(),
                'position' => $image->getPosition()
            ];
        }

        return $externalData;
    }
}


1			<?php
2
3			namespace Iris\Mapping;
4
5			class Image extends Base
6			{
7			/**
8			* @var \Iris\Mapping\OrderCustomer
9			*/
10			private $customerMapping;
			0 ignored issues – show Unused Code introduced 2016-01-05 19:58 UTC by Report Bug Copy Issue Report The property `$customerMapping` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
11
12			/**
13			* @var \Iris\Mapping\OrderAddress
14			*/
15			private $addressMapping;
			0 ignored issues – show Unused Code introduced 2016-01-05 19:58 UTC by Report Bug Copy Issue Report The property `$addressMapping` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
16
17			/**
18			* @var \Iris\Mapping\OrderItem
19			*/
20			private $itemMapping;
			0 ignored issues – show Unused Code introduced 2016-01-05 19:58 UTC by Report Bug Copy Issue Report The property `$itemMapping` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
21
22			/**
23			* {@inheritdoc}
24			*/
25			public function assign(array $externalData)
26			{
27			$images = [];
28
29			foreach ($externalData as $image) {
30			$images[] = new \Iris\Transfer\Catalog\Image([
31			'url' => $image['url'],
32			'position' => $image['position']
33			]);
34			}
35
36			return $imageCollection = new \Iris\Transfer\Catalog\ImageCollection($images);
			0 ignored issues – show Bug Best Practice introduced 2016-01-05 19:58 UTC by Report Bug Copy Issue Report The return type of `return $imageCollection ...ageCollection($images);` (`Iris\Transfer\Catalog\ImageCollection`) is incompatible with the return type declared by the abstract method `Iris\Mapping\Base::assign` of type `Iris\Transfer\Catalog\ConfigCollection`. 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 2016-01-05 19:58 UTC by Report Bug Copy Issue Report `$imageCollection` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
37			}
38
39			/**
40			* {@inheritdoc}
41			*/
42			public function map($internalData)
43			{
44			$externalData = [];
45			foreach ($internalData as $image) {
46			$externalData[] = [
47			'url' => $image->getUrl(),
48			'position' => $image->getPosition()
49			];
50			}
51
52			return $externalData;
53			}
54			}
55

tricae-br / iris

Pull Request — master (#7)

Image::assign() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like