DriverManager::__construct() - Code Metrics - Inspection of "Refactoring, cleaning and fixing doc comments" - ARCANEDEV/GeoIP - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6c5932...f55ac0 )

by ARCANEDEV

created 2016-12-11 03:57 UTC

DriverManager::__construct() A

↳ Parent: DriverManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php namespace Arcanedev\GeoIP;

use Arcanedev\GeoIP\Contracts\DriverFactory;
use Arcanedev\Support\Manager;
use Illuminate\Contracts\Foundation\Application;

/**
 * Class     DriverManager
 *
 * @package  Arcanedev\GeoIP
 * @author   ARCANEDEV <[email protected]>
 */
class DriverManager extends Manager implements DriverFactory
{
    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * DriverManager constructor.
     *
     * @param  \Illuminate\Contracts\Foundation\Application  $app
     */
    public function __construct(Application $app)
    {
        parent::__construct($app);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the default driver name.
     *
     * @return string
     */
    public function getDefaultDriver()
    {
        return $this->getConfig('default');
    }

    /**
     * Get the driver class.
     *
     * @param  string  $key
     *
     * @return string
     */
    private function getDriverClass($key)
    {
        return $this->getConfig("supported.$key.driver");
    }

    /**
     * Get the driver options.
     *
     * @param  string  $key
     *
     * @return array
     */
    private function getDriverOptions($key)
    {
        return $this->getConfig("supported.$key.options", []);
    }

    /**
     * Get the config.
     *
     * @param  string      $key
     * @param  mixed|null  $default
     *
     * @return mixed
     */
    public function getConfig($key, $default = null)
    {
        return $this->config()->get("geoip.$key", $default);
    }

    /**
     * Get the config instance.
     *
     * @return \Illuminate\Contracts\Config\Repository
     */
    private function config()
    {
        return $this->app['config'];
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Build the 'ip-api' driver.
     *
     * @return Drivers\IpApiDriver
     */
    protected function createIpApiDriver()
    {
        return $this->buildDriver('ip-api');
    }

    /**
     * Build the 'freegeoip' driver.
     *
     * @return Drivers\FreeGeoIpDriver
     */
    protected function createFreegeoipDriver()
    {
        return $this->buildDriver('freegeoip');
    }

    /**
     * Get the 'maxmind-database' driver.
     *
     * @return mixed
     */
    protected function createMaxmindDatabaseDriver()
    {
        return $this->buildDriver('maxmind-database');
    }

    /**
     * Get the 'maxmind-api' driver.
     *
     * @return Drivers\MaxmindApiDriver
     */
    protected function createMaxmindApiDriver()
    {
        return $this->buildDriver('maxmind-api');
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Build the driver.
     *
     * @param  string  $key
     *
     * @return mixed
     */
    private function buildDriver($key)
    {
        $class = $this->getDriverClass($key);

        return new $class($this->getDriverOptions($key));
    }
}


1		<?php namespace Arcanedev\GeoIP;
2
3		use Arcanedev\GeoIP\Contracts\DriverFactory;
4		use Arcanedev\Support\Manager;
5		use Illuminate\Contracts\Foundation\Application;
6
7		/**
8		* Class DriverManager
9		*
10		* @package Arcanedev\GeoIP
11		* @author ARCANEDEV <[email protected]>
12		*/
13		class DriverManager extends Manager implements DriverFactory
14		{
15		/* ------------------------------------------------------------------------------------------------
16		\| Constructor
17		\| ------------------------------------------------------------------------------------------------
18		*/
19		/**
20		* DriverManager constructor.
21		*
22		* @param \Illuminate\Contracts\Foundation\Application $app
23		*/
24	96	public function __construct(Application $app)
25		{
26	96	parent::__construct($app);
		0 ignored issues – show Documentation introduced 2016-12-11 04:04 UTC by Report Bug Copy Issue Report `$app` is of type `object<Illuminate\Contra...Foundation\Application>`, but the function expects a `object<Illuminate\Foundation\Application>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
27	96	}
28
29		/* ------------------------------------------------------------------------------------------------
30		\| Getters & Setters
31		\| ------------------------------------------------------------------------------------------------
32		*/
33		/**
34		* Get the default driver name.
35		*
36		* @return string
37		*/
38	42	public function getDefaultDriver()
39		{
40	42	return $this->getConfig('default');
41		}
42
43		/**
44		* Get the driver class.
45		*
46		* @param string $key
47		*
48		* @return string
49		*/
50	90	private function getDriverClass($key)
51		{
52	90	return $this->getConfig("supported.$key.driver");
53		}
54
55		/**
56		* Get the driver options.
57		*
58		* @param string $key
59		*
60		* @return array
61		*/
62	90	private function getDriverOptions($key)
63		{
64	90	return $this->getConfig("supported.$key.options", []);
65		}
66
67		/**
68		* Get the config.
69		*
70		* @param string $key
71		* @param mixed\|null $default
72		*
73		* @return mixed
74		*/
75	90	public function getConfig($key, $default = null)
76		{
77	90	return $this->config()->get("geoip.$key", $default);
78		}
79
80		/**
81		* Get the config instance.
82		*
83		* @return \Illuminate\Contracts\Config\Repository
84		*/
85	90	private function config()
86		{
87	90	return $this->app['config'];
88		}
89
90		/* ------------------------------------------------------------------------------------------------
91		\| Main Functions
92		\| ------------------------------------------------------------------------------------------------
93		*/
94		/**
95		* Build the 'ip-api' driver.
96		*
97		* @return Drivers\IpApiDriver
98		*/
99	18	protected function createIpApiDriver()
100		{
101	18	return $this->buildDriver('ip-api');
102		}
103
104		/**
105		* Build the 'freegeoip' driver.
106		*
107		* @return Drivers\FreeGeoIpDriver
108		*/
109	60	protected function createFreegeoipDriver()
110		{
111	60	return $this->buildDriver('freegeoip');
112		}
113
114		/**
115		* Get the 'maxmind-database' driver.
116		*
117		* @return mixed
118		*/
119	24	protected function createMaxmindDatabaseDriver()
120		{
121	24	return $this->buildDriver('maxmind-database');
122		}
123
124		/**
125		* Get the 'maxmind-api' driver.
126		*
127		* @return Drivers\MaxmindApiDriver
128		*/
129	6	protected function createMaxmindApiDriver()
130		{
131	6	return $this->buildDriver('maxmind-api');
132		}
133
134		/* ------------------------------------------------------------------------------------------------
135		\| Other Functions
136		\| ------------------------------------------------------------------------------------------------
137		*/
138		/**
139		* Build the driver.
140		*
141		* @param string $key
142		*
143		* @return mixed
144		*/
145	90	private function buildDriver($key)
146		{
147	90	$class = $this->getDriverClass($key);
148
149	90	return new $class($this->getDriverOptions($key));
150		}
151		}
152

ARCANEDEV / GeoIP

Push — master ( 6c5932...f55ac0 )

DriverManager::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like