JenssegersAgent::hydrateBrowser() - Code Metrics - Inspection of "adding jenssegersAgent" - ThaDafinser/UserAgentParser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#65)

by Martin

created 2016-03-08 10:17 UTC

JenssegersAgent::hydrateBrowser() A

↳ Parent: JenssegersAgent

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
rs	9.4285
cc	3
eloc	5
nc	3
nop	2

<?php
namespace UserAgentParser\Provider;

use Jenssegers\Agent\Agent;
use UserAgentParser\Exception\NoResultFoundException;
use UserAgentParser\Exception\PackageNotLoadedException;
use UserAgentParser\Model;

class JenssegersAgent extends AbstractProvider
{
    /**
     * Name of the provider
     *
     * @var string
     */
    protected $name = 'JenssegersAgent';

    /**
     * Homepage of the provider
     *
     * @var string
     */
    protected $homepage = 'https://github.com/jenssegers/agent';

    /**
     * Composer package name
     *
     * @var string
     */
    protected $packageName = 'jenssegers/agent';

    protected $detectionCapabilities = [

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

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

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

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

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

    /**
     * Used for unitTests mocking
     *
     * @var Agent
     */
    private $parser;

    /**
     *
     * @throws PackageNotLoadedException
     */
    public function __construct()
    {
        if (! file_exists('vendor/' . $this->getPackageName() . '/composer.json')) {
            throw new PackageNotLoadedException('You need to install the package ' . $this->getPackageName() . ' to use this provider');
        }
    }

    /**
     *
     * @return Agent
     */
    public function getParser()
    {
        if ($this->parser !== null) {
            return $this->parser;
        }

        return new Agent();
    }

    /**
     *
     * @param array $resultRaw
     *
     * @return bool
     */
    private function hasResult(array $resultRaw)
    {
        if ($resultRaw['isMobile'] === true || $resultRaw['isRobot'] === true) {
            return true;
        }

        if ($this->isRealResult($resultRaw['browserName']) === true || $this->isRealResult($resultRaw['osName']) === true || $this->isRealResult($resultRaw['deviceModel']) === true || $this->isRealResult($resultRaw['botName']) === true) {
            return true;
        }

        return false;
    }

    /**
     *
     * @param Model\Bot $bot
     * @param array     $browserRaw
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    private function hydrateBot(Model\Bot $bot, array $resultRaw)
    {
        $bot->setIsBot(true);

        if ($this->isRealResult($resultRaw['botName']) === true) {
            $bot->setName($resultRaw['botName']);
        }
    }

    /**
     *
     * @param Model\Browser $browser
     * @param array         $resultRaw
     */
    private function hydrateBrowser(Model\Browser $browser, array $resultRaw)
    {
        if ($this->isRealResult($resultRaw['browserName']) === true) {
            $browser->setName($resultRaw['browserName']);

            if ($this->isRealResult($resultRaw['browserVersion']) === true) {
                $browser->getVersion()->setComplete($resultRaw['browserVersion']);
            }
        }
    }

    /**
     *
     * @param Model\OperatingSystem $os
     * @param array                 $resultRaw
     */
    private function hydrateOperatingSystem(Model\OperatingSystem $os, array $resultRaw)
    {
        if ($this->isRealResult($resultRaw['osName']) === true) {
            $os->setName($resultRaw['osName']);

            if ($this->isRealResult($resultRaw['osVersion']) === true) {
                $os->getVersion()->setComplete($resultRaw['osVersion']);
            }
        }
    }

    /**
     *
     * @param Model\Device $device
     * @param array        $resultRaw
     */
    private function hydrateDevice(Model\Device $device, array $resultRaw)
    {
        if ($this->isRealResult($resultRaw['deviceModel']) === true) {
            $device->setModel($resultRaw['deviceModel']);
        }

        if ($resultRaw['isMobile'] === true) {
            $device->setIsMobile(true);
        }
    }

    public function parse($userAgent, array $headers = [])
    {
        $parser = $this->getParser();
        $parser->setHttpHeaders($headers);
        $parser->setUserAgent($userAgent);

        /*
         * Since Mobile_Detect to a regex comparison on every call
         * We cache it here for all checks and hydration
         */
        $browserName = $parser->browser();
        $osName      = $parser->platform();

        $resultCache = [
            'browserName'    => $browserName,
            'browserVersion' => $parser->version($browserName),

            'osName'    => $osName,
            'osVersion' => $parser->version($osName),

            'deviceModel' => $parser->device(),
            'isMobile'    => $parser->isMobile(),

            'isRobot' => $parser->isRobot(),
            'botName' => $parser->robot(),
        ];

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

        /*
         * Hydrate the model
         */
        $result = new Model\UserAgent();
        $result->setProviderResultRaw($resultCache);

        /*
         * Bot detection
         */
        if ($resultCache['isRobot'] === true) {
            $this->hydrateBot($result->getBot(), $resultCache);

            return $result;
        }

        /*
         * hydrate the result
         */
        $this->hydrateBrowser($result->getBrowser(), $resultCache);
        $this->hydrateOperatingSystem($result->getOperatingSystem(), $resultCache);
        $this->hydrateDevice($result->getDevice(), $resultCache);

        return $result;
    }
}


1			<?php
2			namespace UserAgentParser\Provider;
3
4			use Jenssegers\Agent\Agent;
5			use UserAgentParser\Exception\NoResultFoundException;
6			use UserAgentParser\Exception\PackageNotLoadedException;
7			use UserAgentParser\Model;
8
9			class JenssegersAgent extends AbstractProvider
10			{
11			/**
12			* Name of the provider
13			*
14			* @var string
15			*/
16			protected $name = 'JenssegersAgent';
17
18			/**
19			* Homepage of the provider
20			*
21			* @var string
22			*/
23			protected $homepage = 'https://github.com/jenssegers/agent';
24
25			/**
26			* Composer package name
27			*
28			* @var string
29			*/
30			protected $packageName = 'jenssegers/agent';
31
32			protected $detectionCapabilities = [
33
34			'browser' => [
35			'name' => true,
36			'version' => true,
37			],
38
39			'renderingEngine' => [
40			'name' => false,
41			'version' => false,
42			],
43
44			'operatingSystem' => [
45			'name' => true,
46			'version' => true,
47			],
48
49			'device' => [
50			'model' => true,
51			'brand' => false,
52			'type' => false,
53			'isMobile' => true,
54			'isTouch' => false,
55			],
56
57			'bot' => [
58			'isBot' => true,
59			'name' => true,
60			'type' => false,
61			],
62			];
63
64			/**
65			* Used for unitTests mocking
66			*
67			* @var Agent
68			*/
69			private $parser;
70
71			/**
72			*
73			* @throws PackageNotLoadedException
74			*/
75			public function __construct()
76			{
77			if (! file_exists('vendor/' . $this->getPackageName() . '/composer.json')) {
78			throw new PackageNotLoadedException('You need to install the package ' . $this->getPackageName() . ' to use this provider');
79			}
80			}
81
82			/**
83			*
84			* @return Agent
85			*/
86			public function getParser()
87			{
88			if ($this->parser !== null) {
89			return $this->parser;
90			}
91
92			return new Agent();
93			}
94
95			/**
96			*
97			* @param array $resultRaw
98			*
99			* @return bool
100			*/
101			private function hasResult(array $resultRaw)
102			{
103			if ($resultRaw['isMobile'] === true \|\| $resultRaw['isRobot'] === true) {
104			return true;
105			}
106
107			if ($this->isRealResult($resultRaw['browserName']) === true \|\| $this->isRealResult($resultRaw['osName']) === true \|\| $this->isRealResult($resultRaw['deviceModel']) === true \|\| $this->isRealResult($resultRaw['botName']) === true) {
108			return true;
109			}
110
111			return false;
112			}
113
114			/**
115			*
116			* @param Model\Bot $bot
117			* @param array $browserRaw
			0 ignored issues – show Bug introduced 2016-03-08 10:22 UTC by Report Bug Copy Issue Report There is no parameter named `$browserRaw`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
118			*/
119			private function hydrateBot(Model\Bot $bot, array $resultRaw)
120			{
121			$bot->setIsBot(true);
122
123			if ($this->isRealResult($resultRaw['botName']) === true) {
124			$bot->setName($resultRaw['botName']);
125			}
126			}
127
128			/**
129			*
130			* @param Model\Browser $browser
131			* @param array $resultRaw
132			*/
133			private function hydrateBrowser(Model\Browser $browser, array $resultRaw)
134			{
135			if ($this->isRealResult($resultRaw['browserName']) === true) {
136			$browser->setName($resultRaw['browserName']);
137
138			if ($this->isRealResult($resultRaw['browserVersion']) === true) {
139			$browser->getVersion()->setComplete($resultRaw['browserVersion']);
140			}
141			}
142			}
143
144			/**
145			*
146			* @param Model\OperatingSystem $os
147			* @param array $resultRaw
148			*/
149			private function hydrateOperatingSystem(Model\OperatingSystem $os, array $resultRaw)
150			{
151			if ($this->isRealResult($resultRaw['osName']) === true) {
152			$os->setName($resultRaw['osName']);
153
154			if ($this->isRealResult($resultRaw['osVersion']) === true) {
155			$os->getVersion()->setComplete($resultRaw['osVersion']);
156			}
157			}
158			}
159
160			/**
161			*
162			* @param Model\Device $device
163			* @param array $resultRaw
164			*/
165			private function hydrateDevice(Model\Device $device, array $resultRaw)
166			{
167			if ($this->isRealResult($resultRaw['deviceModel']) === true) {
168			$device->setModel($resultRaw['deviceModel']);
169			}
170
171			if ($resultRaw['isMobile'] === true) {
172			$device->setIsMobile(true);
173			}
174			}
175
176			public function parse($userAgent, array $headers = [])
177			{
178			$parser = $this->getParser();
179			$parser->setHttpHeaders($headers);
180			$parser->setUserAgent($userAgent);
181
182			/*
183			* Since Mobile_Detect to a regex comparison on every call
184			* We cache it here for all checks and hydration
185			*/
186			$browserName = $parser->browser();
187			$osName = $parser->platform();
188
189			$resultCache = [
190			'browserName' => $browserName,
191			'browserVersion' => $parser->version($browserName),
192
193			'osName' => $osName,
194			'osVersion' => $parser->version($osName),
195
196			'deviceModel' => $parser->device(),
197			'isMobile' => $parser->isMobile(),
198
199			'isRobot' => $parser->isRobot(),
200			'botName' => $parser->robot(),
201			];
202
203			/*
204			* No result found?
205			*/
206			if ($this->hasResult($resultCache) !== true) {
207			throw new NoResultFoundException('No result found for user agent: ' . $userAgent);
208			}
209
210			/*
211			* Hydrate the model
212			*/
213			$result = new Model\UserAgent();
214			$result->setProviderResultRaw($resultCache);
215
216			/*
217			* Bot detection
218			*/
219			if ($resultCache['isRobot'] === true) {
220			$this->hydrateBot($result->getBot(), $resultCache);
221
222			return $result;
223			}
224
225			/*
226			* hydrate the result
227			*/
228			$this->hydrateBrowser($result->getBrowser(), $resultCache);
229			$this->hydrateOperatingSystem($result->getOperatingSystem(), $resultCache);
230			$this->hydrateDevice($result->getDevice(), $resultCache);
231
232			return $result;
233			}
234			}
235

ThaDafinser / UserAgentParser

GitHub Access Token became invalid

Pull Request — master (#65)

JenssegersAgent::hydrateBrowser() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like