ParserGeneric::factory() - Code Metrics - Inspection of "Merge pull request #1 from graze/functioning-clien..." - graze/unicontroller-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 411d94...8fae9a )

by John

created 2016-11-16 22:49 UTC

ParserGeneric::factory() A

↳ Parent: ParserGeneric

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
ccs	0
cts	6
cp	0
cc	1
eloc	3
nc	1
nop	0
crap	2

<?php
/**
 * This file is part of graze/unicontroller-client.
 *
 * Copyright (c) 2016 Nature Delivered Ltd. <https://www.graze.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license https://github.com/graze/unicontroller-client/blob/master/LICENSE.md
 * @link https://github.com/graze/unicontroller-client
 */
namespace Graze\UnicontrollerClient\Parser\Parser;

use Graze\UnicontrollerClient\Parser\Parser\ParserInterface;
use Graze\UnicontrollerClient\Entity\EntityHydrator;
use Graze\UnicontrollerClient\Entity\Entity\EntityGeneric;

class ParserGeneric implements ParserInterface
{
    /**
     * @var EntityHydrator
     */
    private $entityHydrator;

    /**
     * @param EntityHydrator $entityHydrator
     */
    public function __construct(EntityHydrator $entityHydrator)
    {
        $this->entityHydrator = $entityHydrator;
    }

    /**
     * @param string $string
     * @return Graze\UnicontrollerClient\Entity\Entity\EntityInterface

     */
    public function parse($string)
    {
        return $this->entityHydrator->hydrate(
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());
}
            new EntityGeneric(),
            ['success' => $string == "\r\n"]
        );
    }

    /**
     * @return ParserGeneric
     */
    public static function factory()
    {
        return new static(
            new EntityHydrator()
        );
    }
}


1			<?php
2			/**
3			* This file is part of graze/unicontroller-client.
4			*
5			* Copyright (c) 2016 Nature Delivered Ltd. <https://www.graze.com>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*
10			* @license https://github.com/graze/unicontroller-client/blob/master/LICENSE.md
11			* @link https://github.com/graze/unicontroller-client
12			*/
13			namespace Graze\UnicontrollerClient\Parser\Parser;
14
15			use Graze\UnicontrollerClient\Parser\Parser\ParserInterface;
16			use Graze\UnicontrollerClient\Entity\EntityHydrator;
17			use Graze\UnicontrollerClient\Entity\Entity\EntityGeneric;
18
19			class ParserGeneric implements ParserInterface
20			{
21			/**
22			* @var EntityHydrator
23			*/
24			private $entityHydrator;
25
26			/**
27			* @param EntityHydrator $entityHydrator
28			*/
29			public function __construct(EntityHydrator $entityHydrator)
30			{
31			$this->entityHydrator = $entityHydrator;
32			}
33
34			/**
35			* @param string $string
36			* @return Graze\UnicontrollerClient\Entity\Entity\EntityInterface
			0 ignored issues – show Documentation introduced 2016-11-16 17:14 UTC by Report Bug Copy Issue Report Should the return type not be `\Graze\UnicontrollerClie...\Entity\EntityInterface`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
37			*/
38			public function parse($string)
39			{
40			return $this->entityHydrator->hydrate(
			0 ignored issues – show Bug Best Practice introduced 2016-11-16 17:14 UTC by Report Bug Copy Issue Report The return type of `return $this->entityHydr...' => $string == ' '));` (`Graze\UnicontrollerClien...\Entity\EntityInterface`) is incompatible with the return type declared by the interface `Graze\UnicontrollerClien...\ParserInterface::parse` of type `Graze\UnicontrollerClien...\Entity\EntityInterface`. 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...
41			new EntityGeneric(),
42			['success' => $string == "\r\n"]
43			);
44			}
45
46			/**
47			* @return ParserGeneric
48			*/
49			public static function factory()
50			{
51			return new static(
52			new EntityHydrator()
53			);
54			}
55			}
56

graze / unicontroller-client

Push — master ( 411d94...8fae9a )

ParserGeneric::factory() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like