ServiceLocator - Code Metrics - Inspection of "Merge pull request #317 from Schlaefer/feature/1.9..." - PhileCMS/Phile - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 91c1d2...446210 )

by Schlaefer

created 2018-03-01 20:32 UTC

ServiceLocator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	3
lcom	0
cbo	2
dl	0
loc	40
ccs	7
cts	7
cp	1
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	registerService()	4	1
A	hasService()	4	1
A	getService()	4	1

<?php
/*
 * @author  PhileCMS
 * @link    https://philecms.com
 * @license http://opensource.org/licenses/MIT
 */

namespace Phile\Core;

use Phile\Core\Container;
use Phile\Exception\ServiceLocatorException;

/**
 * the Service Locator class
 */
class ServiceLocator
{
    /**
     * method to register a service
     *
     * @param string $serviceKey the key for the service
     * @param mixed  $object
     *
     * @throws ServiceLocatorException
     */
    public static function registerService($serviceKey, $object)
    {
        Container::getInstance()->set($serviceKey, $object);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * checks if a service is registered
     *
     * @param string $serviceKey
     *
     * @return bool
     */
    public static function hasService($serviceKey)
    {
        return Container::getInstance()->has($serviceKey);
    }

    /**
     * returns a service
     *
     * @param string $serviceKey the service key
     *
     * @return mixed
     * @throws ServiceLocatorException
     */
    public static function getService($serviceKey)
    {
        return Container::getInstance()->get($serviceKey);
    }
}


1		<?php
2		/*
3		* @author PhileCMS
4		* @link https://philecms.com
5		* @license http://opensource.org/licenses/MIT
6		*/
7
8		namespace Phile\Core;
9
10		use Phile\Core\Container;
11		use Phile\Exception\ServiceLocatorException;
12
13		/**
14		* the Service Locator class
15		*/
16		class ServiceLocator
17		{
18		/**
19		* method to register a service
20		*
21		* @param string $serviceKey the key for the service
22		* @param mixed $object
23		*
24		* @throws ServiceLocatorException
25		*/
26	26	public static function registerService($serviceKey, $object)
27		{
28	26	Container::getInstance()->set($serviceKey, $object);
		0 ignored issues – show Bug introduced 2018-02-26 12:40 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Container\ContainerInterface` as the method `set()` does only exist in the following implementations of said interface: `Phile\Core\Container`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
29	26	}
30
31		/**
32		* checks if a service is registered
33		*
34		* @param string $serviceKey
35		*
36		* @return bool
37		*/
38	31	public static function hasService($serviceKey)
39		{
40	31	return Container::getInstance()->has($serviceKey);
41		}
42
43		/**
44		* returns a service
45		*
46		* @param string $serviceKey the service key
47		*
48		* @return mixed
49		* @throws ServiceLocatorException
50		*/
51	29	public static function getService($serviceKey)
52		{
53	29	return Container::getInstance()->get($serviceKey);
54		}
55		}
56

PhileCMS / Phile

Push — develop ( 91c1d2...446210 )

ServiceLocator A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like