MemcacheFactory::decorateWithConnectable() - Code Metrics - Inspection of "Merge pull request #2 from pcelta/refactoring" - pcelta/doctrine-cache-factory - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9da291...9cb0b0 )

by Pedro

created 2016-06-24 22:26 UTC

MemcacheFactory::decorateWithConnectable() A

↳ Parent: MemcacheFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	1	Features	0

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

<?php

namespace Pcelta\Doctrine\Cache\Factory;

use Doctrine\Common\Cache\CacheProvider;
use Pcelta\Doctrine\Cache\Entity\Config;

class MemcacheFactory extends AbstractFactory
{
    const MODULE_NAME = 'memcache';

    public function getModuleName()
    {
        return self::MODULE_NAME;
    }

    /**
     * @return \Memcache
     */
    public function getMemcacheAdapter()
    {
        return new \Memcache();
    }

    /**
     * @param CacheProvider $cacheProvider
     *
     * @return CacheProvider
     */
    protected function decorateWithConnectable(CacheProvider $cacheProvider)
    {
        $memcache = $this->getMemcacheAdapter();
        $settings = $this->config->getSettings();
        $memcache->connect($settings['host'], $settings['port']);

        $cacheProvider->setMemcache($memcache);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}

        return $cacheProvider;
    }

    /**
     * @param Config $config
     *
     * @return bool
     */
    protected function isValidConfig(Config $config)
    {
        $settings = $config->getSettings();
        if (!isset($settings['host'])) {
            return false;
        }

        if (!isset($settings['port'])) {
            return false;
        }

        return true;
    }
}


1			<?php
2
3			namespace Pcelta\Doctrine\Cache\Factory;
4
5			use Doctrine\Common\Cache\CacheProvider;
6			use Pcelta\Doctrine\Cache\Entity\Config;
7
8			class MemcacheFactory extends AbstractFactory
9			{
10			const MODULE_NAME = 'memcache';
11
12			public function getModuleName()
13			{
14			return self::MODULE_NAME;
15			}
16
17			/**
18			* @return \Memcache
19			*/
20			public function getMemcacheAdapter()
21			{
22			return new \Memcache();
23			}
24
25			/**
26			* @param CacheProvider $cacheProvider
27			*
28			* @return CacheProvider
29			*/
30			protected function decorateWithConnectable(CacheProvider $cacheProvider)
31			{
32			$memcache = $this->getMemcacheAdapter();
33			$settings = $this->config->getSettings();
34			$memcache->connect($settings['host'], $settings['port']);
35
36			$cacheProvider->setMemcache($memcache);
			0 ignored issues – show Bug introduced 2016-06-24 21:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Doctrine\Common\Cache\CacheProvider` as the method `setMemcache()` does only exist in the following sub-classes of `Doctrine\Common\Cache\CacheProvider`: `Doctrine\Common\Cache\MemcacheCache`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
37
38			return $cacheProvider;
39			}
40
41			/**
42			* @param Config $config
43			*
44			* @return bool
45			*/
46			protected function isValidConfig(Config $config)
47			{
48			$settings = $config->getSettings();
49			if (!isset($settings['host'])) {
50			return false;
51			}
52
53			if (!isset($settings['port'])) {
54			return false;
55			}
56
57			return true;
58			}
59			}
60

pcelta / doctrine-cache-factory

Push — master ( 9da291...9cb0b0 )

MemcacheFactory::decorateWithConnectable() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like