HandsetDetection::parse() - Code Metrics - Inspection of "[WIP] handset" - ThaDafinser/UserAgentParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#96)

by Martin

created 2016-06-20 12:53 UTC

HandsetDetection::parse() B

↳ Parent: HandsetDetection

Complexity

Conditions	4
Paths	3

Size

Total Lines	41
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

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

<?php
namespace UserAgentParser\Provider;

use HandsetDetection as Parser;
use UserAgentParser\Exception\NoResultFoundException;
use UserAgentParser\Model;

/**
 * Abstraction for ua-parser/uap-php
 *
 * @author Martin Keckeis <[email protected]>
 * @license MIT
 * @see https://github.com/HandsetDetection/php-apikit
 */
class HandsetDetection extends AbstractProvider
{
    /**
     * Name of the provider
     *
     * @var string
     */
    protected $name = 'HandsetDetection';

    /**
     * Homepage of the provider
     *
     * @var string
     */
    protected $homepage = 'https://github.com/HandsetDetection/php-apikit';

    /**
     * Composer package name
     *
     * @var string
     */
    protected $packageName = 'handsetdetection/php-apikit';

    protected $detectionCapabilities = [

        'browser' => [
            'name'    => true,
            'version' => true,
        ],

        'renderingEngine' => [
            'name'    => false,
            'version' => false,
        ],

        'operatingSystem' => [
            'name'    => true,
            'version' => true,
        ],

        'device' => [
            'model'    => true,
            'brand'    => true,
            'type'     => false,
            'isMobile' => false,
            'isTouch'  => false,
        ],

        'bot' => [
            'isBot' => false,
            'name'  => false,
            'type'  => false,
        ],
    ];

    protected $defaultValues = [

        'general' => [
            '/^generic$/i',
        ],

        'device' => [
            'model' => [
                '/analyzer/i',
                '/bot/i',
                '/crawler/i',
                '/library/i',
                '/spider/i',
            ],
        ],
    ];

    /**
     *
     * @var Parser\HD4
     */
    private $parser;

    /**
     *
     * @param Parser\HD4 $parser
     */
    public function __construct(Parser\HD4 $parser)
    {
        $this->parser = $parser;
    }

    /**
     *
     * @return Parser\HD4
     */
    public function getParser()
    {
        return $this->parser;
    }

    /**
     *
     * @param array $resultRaw
     *
     * @return bool
     */
    private function hasResult(array $resultRaw)
    {
        if (isset($resultRaw['general_browser']) && $this->isRealResult($resultRaw['general_browser'])) {
            return true;
        }

        if (isset($resultRaw['general_platform']) && $this->isRealResult($resultRaw['general_platform'])) {
            return true;
        }

        if (isset($resultRaw['general_model']) && $this->isRealResult($resultRaw['general_model'], 'device', 'model') && $this->isRealResult($resultRaw['general_vendor'], 'device', 'brand')) {
            return true;
        }

        return false;
    }

    /**
     *
     * @param Model\Browser $browser
     * @param array         $resultRaw
     */
    private function hydrateBrowser(Model\Browser $browser, array $resultRaw)
    {
        if (isset($resultRaw['general_browser'])) {
            $browser->setName($this->getRealResult($resultRaw['general_browser']));
        }
        if (isset($resultRaw['general_browser_version'])) {
            $browser->getVersion()->setComplete($this->getRealResult($resultRaw['general_browser_version']));
        }
    }

    /**
     *
     * @param Model\OperatingSystem $os
     * @param array                 $resultRaw
     */
    private function hydrateOperatingSystem(Model\OperatingSystem $os, array $resultRaw)
    {
        if (isset($resultRaw['general_platform'])) {
            $os->setName($this->getRealResult($resultRaw['general_platform']));
        }
        if (isset($resultRaw['general_platform_version'])) {
            $os->getVersion()->setComplete($this->getRealResult($resultRaw['general_platform_version']));
        }
    }

    /**
     *
     * @param Model\UserAgent $device
     * @param array           $resultRaw
     */
    private function hydrateDevice(Model\Device $device, array $resultRaw)
    {
        if (isset($resultRaw['general_model']) && $this->isRealResult($resultRaw['general_model'], 'device', 'model') && isset($resultRaw['general_vendor']) && $this->isRealResult($resultRaw['general_vendor'], 'device', 'brand')) {
            $device->setModel($this->getRealResult($resultRaw['general_model'], 'device', 'model'));
            $device->setBrand($this->getRealResult($resultRaw['general_vendor'], 'device', 'brand'));
        }
    }

    public function parse($userAgent, array $headers = [])
    {
        $headers['User-Agent'] = $userAgent;

        $parser = $this->getParser();
        // $config = $parser->config;


        // $parser = new Parser\HD4($config);


        /*
         * No result found?
         */
        if ($parser->deviceDetect($headers) !== true) {
            throw new NoResultFoundException('No result found for user agent: ' . $userAgent);
        }

        $resultRaw = $parser->getReply();

        /*
         * No result found?
         */
        if (! isset($resultRaw['hd_specs']) || $this->hasResult($resultRaw['hd_specs']) !== true) {
            throw new NoResultFoundException('No result found for user agent: ' . $userAgent);
        }

        /*
         * Hydrate the model
         */
        $result = new Model\UserAgent();
        $result->setProviderResultRaw($resultRaw['hd_specs']);

        /*
         * hydrate the result
         */
        $this->hydrateBrowser($result->getBrowser(), $resultRaw['hd_specs']);
        // renderingEngine not available
        $this->hydrateOperatingSystem($result->getOperatingSystem(), $resultRaw['hd_specs']);
        $this->hydrateDevice($result->getDevice(), $resultRaw['hd_specs']);

        return $result;
    }
}


1		<?php
2		namespace UserAgentParser\Provider;
3
4		use HandsetDetection as Parser;
5		use UserAgentParser\Exception\NoResultFoundException;
6		use UserAgentParser\Model;
7
8		/**
9		* Abstraction for ua-parser/uap-php
10		*
11		* @author Martin Keckeis <[email protected]>
12		* @license MIT
13		* @see https://github.com/HandsetDetection/php-apikit
14		*/
15		class HandsetDetection extends AbstractProvider
16		{
17		/**
18		* Name of the provider
19		*
20		* @var string
21		*/
22		protected $name = 'HandsetDetection';
23
24		/**
25		* Homepage of the provider
26		*
27		* @var string
28		*/
29		protected $homepage = 'https://github.com/HandsetDetection/php-apikit';
30
31		/**
32		* Composer package name
33		*
34		* @var string
35		*/
36		protected $packageName = 'handsetdetection/php-apikit';
37
38		protected $detectionCapabilities = [
39
40		'browser' => [
41		'name' => true,
42		'version' => true,
43		],
44
45		'renderingEngine' => [
46		'name' => false,
47		'version' => false,
48		],
49
50		'operatingSystem' => [
51		'name' => true,
52		'version' => true,
53		],
54
55		'device' => [
56		'model' => true,
57		'brand' => true,
58		'type' => false,
59		'isMobile' => false,
60		'isTouch' => false,
61		],
62
63		'bot' => [
64		'isBot' => false,
65		'name' => false,
66		'type' => false,
67		],
68		];
69
70		protected $defaultValues = [
71
72		'general' => [
73		'/^generic$/i',
74		],
75
76		'device' => [
77		'model' => [
78		'/analyzer/i',
79		'/bot/i',
80		'/crawler/i',
81		'/library/i',
82		'/spider/i',
83		],
84		],
85		];
86
87		/**
88		*
89		* @var Parser\HD4
90		*/
91		private $parser;
92
93		/**
94		*
95		* @param Parser\HD4 $parser
96		*/
97	12	public function __construct(Parser\HD4 $parser)
98		{
99	12	$this->parser = $parser;
100	12	}
101
102		/**
103		*
104		* @return Parser\HD4
105		*/
106	5	public function getParser()
107		{
108	5	return $this->parser;
109		}
110
111		/**
112		*
113		* @param array $resultRaw
114		*
115		* @return bool
116		*/
117	4	private function hasResult(array $resultRaw)
118		{
119	4	if (isset($resultRaw['general_browser']) && $this->isRealResult($resultRaw['general_browser'])) {
120	1	return true;
121		}
122
123	3	if (isset($resultRaw['general_platform']) && $this->isRealResult($resultRaw['general_platform'])) {
124	1	return true;
125		}
126
127	2	if (isset($resultRaw['general_model']) && $this->isRealResult($resultRaw['general_model'], 'device', 'model') && $this->isRealResult($resultRaw['general_vendor'], 'device', 'brand')) {
128	1	return true;
129		}
130
131	1	return false;
132		}
133
134		/**
135		*
136		* @param Model\Browser $browser
137		* @param array $resultRaw
138		*/
139	3	private function hydrateBrowser(Model\Browser $browser, array $resultRaw)
140		{
141	3	if (isset($resultRaw['general_browser'])) {
142	1	$browser->setName($this->getRealResult($resultRaw['general_browser']));
143		}
144	3	if (isset($resultRaw['general_browser_version'])) {
145	1	$browser->getVersion()->setComplete($this->getRealResult($resultRaw['general_browser_version']));
146		}
147	3	}
148
149		/**
150		*
151		* @param Model\OperatingSystem $os
152		* @param array $resultRaw
153		*/
154	3	private function hydrateOperatingSystem(Model\OperatingSystem $os, array $resultRaw)
155		{
156	3	if (isset($resultRaw['general_platform'])) {
157	1	$os->setName($this->getRealResult($resultRaw['general_platform']));
158		}
159	3	if (isset($resultRaw['general_platform_version'])) {
160	1	$os->getVersion()->setComplete($this->getRealResult($resultRaw['general_platform_version']));
161		}
162	3	}
163
164		/**
165		*
166		* @param Model\UserAgent $device
167		* @param array $resultRaw
168		*/
169	3	private function hydrateDevice(Model\Device $device, array $resultRaw)
170		{
171	3	if (isset($resultRaw['general_model']) && $this->isRealResult($resultRaw['general_model'], 'device', 'model') && isset($resultRaw['general_vendor']) && $this->isRealResult($resultRaw['general_vendor'], 'device', 'brand')) {
172	1	$device->setModel($this->getRealResult($resultRaw['general_model'], 'device', 'model'));
173	1	$device->setBrand($this->getRealResult($resultRaw['general_vendor'], 'device', 'brand'));
174		}
175	3	}
176
177	5	public function parse($userAgent, array $headers = [])
178		{
179	5	$headers['User-Agent'] = $userAgent;
180
181	5	$parser = $this->getParser();
182		// $config = $parser->config;
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-06-07 06:57 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
183
184		// $parser = new Parser\HD4($config);
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-06-07 06:57 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
185
186		/*
187		* No result found?
188		*/
189	5	if ($parser->deviceDetect($headers) !== true) {
190	1	throw new NoResultFoundException('No result found for user agent: ' . $userAgent);
191		}
192
193	4	$resultRaw = $parser->getReply();
194
195		/*
196		* No result found?
197		*/
198	4	if (! isset($resultRaw['hd_specs']) \|\| $this->hasResult($resultRaw['hd_specs']) !== true) {
199	1	throw new NoResultFoundException('No result found for user agent: ' . $userAgent);
200		}
201
202		/*
203		* Hydrate the model
204		*/
205	3	$result = new Model\UserAgent();
206	3	$result->setProviderResultRaw($resultRaw['hd_specs']);
207
208		/*
209		* hydrate the result
210		*/
211	3	$this->hydrateBrowser($result->getBrowser(), $resultRaw['hd_specs']);
212		// renderingEngine not available
213	3	$this->hydrateOperatingSystem($result->getOperatingSystem(), $resultRaw['hd_specs']);
214	3	$this->hydrateDevice($result->getDevice(), $resultRaw['hd_specs']);
215
216	3	return $result;
217		}
218		}
219

ThaDafinser / UserAgentParser

GitHub Access Token became invalid

Pull Request — master (#96)

HandsetDetection::parse() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like