Browscap::setCache() - Code Metrics - Inspection of "Merge pull request #214 from mimmi20/master" - browscap/browscap-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 41d47b...c28fef )

by James

created 2017-08-29 19:19 UTC

Browscap::setCache() A

↳ Parent: Browscap

Complexity

Conditions	3
Paths	3

Size

Total Lines	16
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Importance

Changes

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

<?php
declare(strict_types = 1);

namespace BrowscapPHP;

use BrowscapPHP\Cache\BrowscapCache;
use BrowscapPHP\Cache\BrowscapCacheInterface;
use BrowscapPHP\Formatter\FormatterInterface;
use BrowscapPHP\Helper\Quoter;
use BrowscapPHP\Parser\ParserInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use WurflCache\Adapter\AdapterInterface;
use WurflCache\Adapter\File;

/**
 * Browscap.ini parsing class with caching and update capabilities
 */
final class Browscap
{
    /**
     * Parser to use
     *
     * @var \BrowscapPHP\Parser\ParserInterface|null
     */
    private $parser;

    /**
     * Formatter to use
     *
     * @var \BrowscapPHP\Formatter\FormatterInterface|null
     */
    private $formatter;

    /**
     * The cache instance
     *
     * @var \BrowscapPHP\Cache\BrowscapCacheInterface|null
     */
    private $cache;

    /**
     * @var \Psr\Log\LoggerInterface|null
     */
    private $logger;

    /**
     * Set theformatter instance to use for the getBrowser() result
     *
     * @param \BrowscapPHP\Formatter\FormatterInterface $formatter
     *
     * @return \BrowscapPHP\Browscap
     */
    public function setFormatter(Formatter\FormatterInterface $formatter) : self
    {
        $this->formatter = $formatter;

        return $this;
    }

    /**
     * @return \BrowscapPHP\Formatter\FormatterInterface
     */
    public function getFormatter() : FormatterInterface
    {
        if (null === $this->formatter) {
            $this->setFormatter(new Formatter\PhpGetBrowser());
        }

        return $this->formatter;
    }

    /**
     * Gets a cache instance
     *
     * @return \BrowscapPHP\Cache\BrowscapCacheInterface
     */
    public function getCache() : BrowscapCacheInterface
    {
        if (null === $this->cache) {
            $cacheDirectory = __DIR__ . '/../resources/';

            $cacheAdapter = new File(
                [File::DIR => $cacheDirectory]
            );

            $this->cache = new BrowscapCache($cacheAdapter);
        }

        return $this->cache;
    }

    /**
     * Sets a cache instance
     *
     * @param \BrowscapPHP\Cache\BrowscapCacheInterface|\WurflCache\Adapter\AdapterInterface $cache
     *
     * @throws \BrowscapPHP\Exception
     * @return \BrowscapPHP\Browscap
     */
    public function setCache($cache) : self
    {
        if ($cache instanceof BrowscapCacheInterface) {
            $this->cache = $cache;
        } elseif ($cache instanceof AdapterInterface) {
            $this->cache = new BrowscapCache($cache);
        } else {
            throw new Exception(
                'the cache has to be an instance of \BrowscapPHP\Cache\BrowscapCacheInterface or '
                . 'an instanceof of \WurflCache\Adapter\AdapterInterface',
                Exception::CACHE_INCOMPATIBLE
            );
        }

        return $this;
    }

    /**
     * Sets the parser instance to use
     *
     * @param \BrowscapPHP\Parser\ParserInterface $parser
     *
     * @return \BrowscapPHP\Browscap
     */
    public function setParser(ParserInterface $parser) : self
    {
        $this->parser = $parser;

        return $this;
    }

    /**
     * returns an instance of the used parser class
     *
     * @return \BrowscapPHP\Parser\ParserInterface
     */
    public function getParser() : ParserInterface
    {
        if (null === $this->parser) {
            $cache = $this->getCache();
            $logger = $this->getLogger();
            $quoter = new Quoter();

            $patternHelper = new Parser\Helper\GetPattern($cache, $logger);
            $dataHelper = new Parser\Helper\GetData($cache, $logger, $quoter);

            $this->parser = new Parser\Ini($patternHelper, $dataHelper, $this->getFormatter());
        }

        return $this->parser;
    }

    /**
     * Sets a logger instance
     *
     * @param \Psr\Log\LoggerInterface $logger
     *
     * @return \BrowscapPHP\Browscap
     */
    public function setLogger(LoggerInterface $logger) : self
    {
        $this->logger = $logger;

        return $this;
    }

    /**
     * returns a logger instance
     *
     * @return \Psr\Log\LoggerInterface
     */
    public function getLogger() : LoggerInterface
    {
        if (null === $this->logger) {
            $this->logger = new NullLogger();
        }

        return $this->logger;
    }

    /**
     * parses the given user agent to get the information about the browser
     *
     * if no user agent is given, it uses {@see \BrowscapPHP\Helper\Support} to get it
     *
     * @param string $userAgent the user agent string
     *
     * @throws \BrowscapPHP\Exception
     * @return \stdClass              the object containing the browsers details. Array if
     *                                $return_array is set to true.
     */
    public function getBrowser(string $userAgent = null) : ?\stdClass
    {
        if (null === $this->getCache()->getVersion()) {
            // there is no active/warm cache available
            throw new Exception('there is no active cache available, please run the update command');
        }

        // Automatically detect the useragent
        if (! isset($userAgent)) {
            $support = new Helper\Support($_SERVER);
            $userAgent = $support->getUserAgent();
        }

        // try to get browser data
        $formatter = $this->getParser()->getBrowser($userAgent);

        // if return is still NULL, updates are disabled... in this
        // case we return an empty formatter instance
        if ($formatter === null) {
            return $this->getFormatter()->getData();
        }

        return $formatter->getData();
    }
}


1		<?php
2		declare(strict_types = 1);
3
4		namespace BrowscapPHP;
5
6		use BrowscapPHP\Cache\BrowscapCache;
7		use BrowscapPHP\Cache\BrowscapCacheInterface;
8		use BrowscapPHP\Formatter\FormatterInterface;
9		use BrowscapPHP\Helper\Quoter;
10		use BrowscapPHP\Parser\ParserInterface;
11		use Psr\Log\LoggerInterface;
12		use Psr\Log\NullLogger;
13		use WurflCache\Adapter\AdapterInterface;
14		use WurflCache\Adapter\File;
15
16		/**
17		* Browscap.ini parsing class with caching and update capabilities
18		*/
19		final class Browscap
20		{
21		/**
22		* Parser to use
23		*
24		* @var \BrowscapPHP\Parser\ParserInterface\|null
25		*/
26		private $parser;
27
28		/**
29		* Formatter to use
30		*
31		* @var \BrowscapPHP\Formatter\FormatterInterface\|null
32		*/
33		private $formatter;
34
35		/**
36		* The cache instance
37		*
38		* @var \BrowscapPHP\Cache\BrowscapCacheInterface\|null
39		*/
40		private $cache;
41
42		/**
43		* @var \Psr\Log\LoggerInterface\|null
44		*/
45		private $logger;
46
47		/**
48		* Set theformatter instance to use for the getBrowser() result
49		*
50		* @param \BrowscapPHP\Formatter\FormatterInterface $formatter
51		*
52		* @return \BrowscapPHP\Browscap
53		*/
54	6	public function setFormatter(Formatter\FormatterInterface $formatter) : self
55		{
56	6	$this->formatter = $formatter;
57
58	6	return $this;
59		}
60
61		/**
62		* @return \BrowscapPHP\Formatter\FormatterInterface
63		*/
64	4	public function getFormatter() : FormatterInterface
65		{
66	4	if (null === $this->formatter) {
67	2	$this->setFormatter(new Formatter\PhpGetBrowser());
68		}
69
70	4	return $this->formatter;
71		}
72
73		/**
74		* Gets a cache instance
75		*
76		* @return \BrowscapPHP\Cache\BrowscapCacheInterface
77		*/
78	9	public function getCache() : BrowscapCacheInterface
79		{
80	9	if (null === $this->cache) {
81	3	$cacheDirectory = __DIR__ . '/../resources/';
82
83	3	$cacheAdapter = new File(
84	3	[File::DIR => $cacheDirectory]
85		);
86
87	3	$this->cache = new BrowscapCache($cacheAdapter);
88		}
89
90	9	return $this->cache;
91		}
92
93		/**
94		* Sets a cache instance
95		*
96		* @param \BrowscapPHP\Cache\BrowscapCacheInterface\|\WurflCache\Adapter\AdapterInterface $cache
97		*
98		* @throws \BrowscapPHP\Exception
99		* @return \BrowscapPHP\Browscap
100		*/
101	7	public function setCache($cache) : self
102		{
103	7	if ($cache instanceof BrowscapCacheInterface) {
104	5	$this->cache = $cache;
105	2	} elseif ($cache instanceof AdapterInterface) {
106	1	$this->cache = new BrowscapCache($cache);
107		} else {
108	1	throw new Exception(
109		'the cache has to be an instance of \BrowscapPHP\Cache\BrowscapCacheInterface or '
110	1	. 'an instanceof of \WurflCache\Adapter\AdapterInterface',
111	1	Exception::CACHE_INCOMPATIBLE
112		);
113		}
114
115	6	return $this;
116		}
117
118		/**
119		* Sets the parser instance to use
120		*
121		* @param \BrowscapPHP\Parser\ParserInterface $parser
122		*
123		* @return \BrowscapPHP\Browscap
124		*/
125	4	public function setParser(ParserInterface $parser) : self
126		{
127	4	$this->parser = $parser;
128
129	4	return $this;
130		}
131
132		/**
133		* returns an instance of the used parser class
134		*
135		* @return \BrowscapPHP\Parser\ParserInterface
136		*/
137	6	public function getParser() : ParserInterface
138		{
139	6	if (null === $this->parser) {
140	2	$cache = $this->getCache();
141	2	$logger = $this->getLogger();
142	2	$quoter = new Quoter();
143
144	2	$patternHelper = new Parser\Helper\GetPattern($cache, $logger);
145	2	$dataHelper = new Parser\Helper\GetData($cache, $logger, $quoter);
146
147	2	$this->parser = new Parser\Ini($patternHelper, $dataHelper, $this->getFormatter());
148		}
149
150	6	return $this->parser;
151		}
152
153		/**
154		* Sets a logger instance
155		*
156		* @param \Psr\Log\LoggerInterface $logger
157		*
158		* @return \BrowscapPHP\Browscap
159		*/
160	2	public function setLogger(LoggerInterface $logger) : self
161		{
162	2	$this->logger = $logger;
163
164	2	return $this;
165		}
166
167		/**
168		* returns a logger instance
169		*
170		* @return \Psr\Log\LoggerInterface
171		*/
172	4	public function getLogger() : LoggerInterface
173		{
174	4	if (null === $this->logger) {
175	2	$this->logger = new NullLogger();
176		}
177
178	4	return $this->logger;
179		}
180
181		/**
182		* parses the given user agent to get the information about the browser
183		*
184		* if no user agent is given, it uses {@see \BrowscapPHP\Helper\Support} to get it
185		*
186		* @param string $userAgent the user agent string
187		*
188		* @throws \BrowscapPHP\Exception
189		* @return \stdClass the object containing the browsers details. Array if
190		* $return_array is set to true.
191		*/
192	5	public function getBrowser(string $userAgent = null) : ?\stdClass
193		{
194	5	if (null === $this->getCache()->getVersion()) {
195		// there is no active/warm cache available
196	1	throw new Exception('there is no active cache available, please run the update command');
197		}
198
199		// Automatically detect the useragent
200	4	if (! isset($userAgent)) {
201	2	$support = new Helper\Support($_SERVER);
202	2	$userAgent = $support->getUserAgent();
203		}
204
205		// try to get browser data
206	4	$formatter = $this->getParser()->getBrowser($userAgent);
207
208		// if return is still NULL, updates are disabled... in this
209		// case we return an empty formatter instance
210	4	if ($formatter === null) {
211	2	return $this->getFormatter()->getData();
212		}
213
214	2	return $formatter->getData();
215		}
216		}
217

browscap / browscap-php

Push — master ( 41d47b...c28fef )

Browscap::setCache() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like