MapperRegistry::getAliasNamespace() - Code Metrics - Inspection of "2.0" - bankiru/doctrine-api-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4)

by Pavel

created 2017-05-05 12:58 UTC

MapperRegistry::getAliasNamespace() A

↳ Parent: MapperRegistry

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	2

<?php

namespace Bankiru\Api\Adapters\Sensio;

use Bankiru\Api\Doctrine\ApiEntityManager;
use Doctrine\Common\Persistence\ManagerRegistry;

final class MapperRegistry implements ManagerRegistry
{
    /** @var ApiEntityManager */
    private $manager;

    /**
     * MapperRegistry constructor.
     *
     * @param ApiEntityManager $manager
     */
    public function __construct(ApiEntityManager $manager)
    {
        $this->manager = $manager;
    }

    /** {@inheritdoc} */
    public function getDefaultConnectionName()
    {
        return null;
    }

    /** {@inheritdoc} */
    public function getConnection($name = null)
    {
        return null;
    }

    /**
     * Gets an array of all registered connections.
     *
     * @return array An array of Connection instances.
     */
    public function getConnections()
    {
        return [];
    }

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

    /** {@inheritdoc} */
    public function getDefaultManagerName()
    {
        return 'default';
    }

    /** {@inheritdoc} */
    public function getManager($name = null)
    {
        if (null === $name || $this->getDefaultManagerName() === $name) {
            return $this->manager;
        }

        throw new \OutOfBoundsException('Invalid API entity manager: ' . $name);
    }

    /** {@inheritdoc} */
    public function getManagers()
    {
        return [$this->getDefaultManagerName() => $this->manager];
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 resetManager($name = null)
    {
        return $this->getManager($name);
    }

    /** {@inheritdoc} */
    public function getAliasNamespace($alias)
    {
        throw new \OutOfBoundsException('Unable to resolve alias ' . $alias);
    }

    /** {@inheritdoc} */
    public function getManagerNames()
    {
        return [$this->getDefaultManagerName()];
    }

    /** {@inheritdoc} */
    public function getRepository($persistentObject, $persistentManagerName = null)
    {
        return $this->getManager($persistentManagerName)->getRepository($persistentObject);
    }

    /** {@inheritdoc} */
    public function getManagerForClass($class)
    {
        if (!$this->manager->getMetadataFactory()->isTransient($class)) {
            return $this->manager;
        }

        return null;
    }
}


1		<?php
2
3		namespace Bankiru\Api\Adapters\Sensio;
4
5		use Bankiru\Api\Doctrine\ApiEntityManager;
6		use Doctrine\Common\Persistence\ManagerRegistry;
7
8		final class MapperRegistry implements ManagerRegistry
9		{
10		/** @var ApiEntityManager */
11		private $manager;
12
13		/**
14		* MapperRegistry constructor.
15		*
16		* @param ApiEntityManager $manager
17		*/
18	1	public function __construct(ApiEntityManager $manager)
19		{
20	1	$this->manager = $manager;
21	1	}
22
23		/** {@inheritdoc} */
24		public function getDefaultConnectionName()
25		{
26		return null;
27		}
28
29		/** {@inheritdoc} */
30		public function getConnection($name = null)
31		{
32		return null;
33		}
34
35		/**
36		* Gets an array of all registered connections.
37		*
38		* @return array An array of Connection instances.
39		*/
40		public function getConnections()
41		{
42		return [];
43		}
44
45		/** {@inheritdoc} */
46		public function getConnectionNames()
47		{
48		return [];
49		}
50
51		/** {@inheritdoc} */
52	1	public function getDefaultManagerName()
53		{
54	1	return 'default';
55		}
56
57		/** {@inheritdoc} */
58		public function getManager($name = null)
59		{
60		if (null === $name \|\| $this->getDefaultManagerName() === $name) {
61		return $this->manager;
62		}
63
64		throw new \OutOfBoundsException('Invalid API entity manager: ' . $name);
65		}
66
67		/** {@inheritdoc} */
68	1	public function getManagers()
69		{
70	1	return [$this->getDefaultManagerName() => $this->manager];
		0 ignored issues – show Bug Best Practice introduced 2017-05-05 13:08 UTC by Report Bug Copy Issue Report The return type of `return array($this->getD...e() => $this->manager);` (`array<string,Bankiru\Api...trine\ApiEntityManager>`) is incompatible with the return type declared by the interface `Doctrine\Common\Persiste...erRegistry::getManagers` of type `Doctrine\Common\Persistence\ObjectManager[]`. 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...
71		}
72
73		/** {@inheritdoc} */
74		public function resetManager($name = null)
75		{
76		return $this->getManager($name);
77		}
78
79		/** {@inheritdoc} */
80		public function getAliasNamespace($alias)
81		{
82		throw new \OutOfBoundsException('Unable to resolve alias ' . $alias);
83		}
84
85		/** {@inheritdoc} */
86		public function getManagerNames()
87		{
88		return [$this->getDefaultManagerName()];
89		}
90
91		/** {@inheritdoc} */
92		public function getRepository($persistentObject, $persistentManagerName = null)
93		{
94		return $this->getManager($persistentManagerName)->getRepository($persistentObject);
95		}
96
97		/** {@inheritdoc} */
98	1	public function getManagerForClass($class)
99		{
100	1	if (!$this->manager->getMetadataFactory()->isTransient($class)) {
101	1	return $this->manager;
102		}
103
104		return null;
105		}
106		}
107

bankiru / doctrine-api-bundle

Pull Request — master (#4)

MapperRegistry::getAliasNamespace() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like