ParsingResult - Code Metrics - Inspection of "Added item instantiation" - jkphl/micrometa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — v2 ( 75137a...384bdd )

by Joschi

created 2017-03-05 21:30 UTC

ParsingResult A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
dl	0
loc	48
c	0
b	0
f	0
ccs	8
cts	8
cp	1
rs	10
wmc	3
lcom	0
cbo	1

3 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	getItems()	4	1
A	getExtra()	4	1

<?php

/**
 * micrometa
 *
 * @category Jkphl
 * @package Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Infrastructure\Parser
 * @author Joschi Kuphal <[email protected]> / @jkphl
 * @copyright Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
 * @license http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Jkphl\Micrometa\Infrastructure\Parser;


use Jkphl\Micrometa\Application\Contract\ParsingResultInterface;
use Jkphl\Micrometa\Application\Factory\ItemFactory;
use Jkphl\Micrometa\Application\Item\ItemInterface;

/**
 * Parsing result
 *
 * @package Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Infrastructure
 */
class ParsingResult implements ParsingResultInterface
{
    /**
     * Extracted items
     *
     * @var \stdClass[]
     */
    protected $items;
    /**
     * Extra results
     *
     * @var array[]
     */
    protected $extra;

    /**
     * Parsing result constructor
     *
     * @param int $format Parser format
     * @param \stdClass[] $items Extracted items
     * @param array[] $extra Extra results
     */
    public function __construct($format, array $items, array $extra = [])
    {
        $this->items = array_map(new ItemFactory($format), $items);
        $this->extra = $extra;
    }

    /**
     * Return all extracted items
     *
     * @return ItemInterface[] Extracted items
     */
    public function getItems()
    {
        return $this->items;
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());
}
    }

    /**
     * Return all extra results
     *
     * @return array[] Extra results
     */
    public function getExtra()
    {
        return $this->extra;
    }
}


1		<?php
2
3		/**
4		* micrometa
5		*
6		* @category Jkphl
7		* @package Jkphl\Micrometa
8		* @subpackage Jkphl\Micrometa\Infrastructure\Parser
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Jkphl\Micrometa\Infrastructure\Parser;
38
39
40		use Jkphl\Micrometa\Application\Contract\ParsingResultInterface;
41		use Jkphl\Micrometa\Application\Factory\ItemFactory;
42		use Jkphl\Micrometa\Application\Item\ItemInterface;
43
44		/**
45		* Parsing result
46		*
47		* @package Jkphl\Micrometa
48		* @subpackage Jkphl\Micrometa\Infrastructure
49		*/
50		class ParsingResult implements ParsingResultInterface
51		{
52		/**
53		* Extracted items
54		*
55		* @var \stdClass[]
56		*/
57		protected $items;
58		/**
59		* Extra results
60		*
61		* @var array[]
62		*/
63		protected $extra;
64
65		/**
66		* Parsing result constructor
67		*
68		* @param int $format Parser format
69		* @param \stdClass[] $items Extracted items
70		* @param array[] $extra Extra results
71		*/
72	2	public function __construct($format, array $items, array $extra = [])
73		{
74	2	$this->items = array_map(new ItemFactory($format), $items);
75	2	$this->extra = $extra;
76	2	}
77
78		/**
79		* Return all extracted items
80		*
81		* @return ItemInterface[] Extracted items
82		*/
83	2	public function getItems()
84		{
85	2	return $this->items;
		0 ignored issues – show Bug Best Practice introduced 2017-03-05 21:34 UTC by Report Bug Copy Issue Report The return type of `return $this->items;` (`stdClass[]`) is incompatible with the return type declared by the interface `Jkphl\Micrometa\Applicat...sultInterface::getItems` of type `Jkphl\Micrometa\Application\Item\ItemInterface[]`. 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...
86		}
87
88		/**
89		* Return all extra results
90		*
91		* @return array[] Extra results
92		*/
93	1	public function getExtra()
94		{
95	1	return $this->extra;
96		}
97		}
98

jkphl / micrometa

Push — v2 ( 75137a...384bdd )

ParsingResult A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Duplication Side-by-Side

Filter issues like