UserAgentParser\Provider\YzalisUAParser

Complexity

Total Complexity

31

Size/Duplication

Total Lines	236
Duplicated Lines	11.86 %

Coupling/Cohesion

Components	1
Dependencies	15

Test Coverage

Coverage

100%

Importance

Changes	15
Bugs	1	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	8	8	2
A	getParser()	0	10	2
D	hasResult()	0	29	9
A	hydrateBrowser()	10	10	3
A	hydrateRenderingEngine()	10	10	3
B	hydrateOperatingSystem()	0	18	5
B	hydrateDevice()	0	15	5
B	parse()	0	37	2

<?php
namespace UserAgentParser\Provider;

use UAParser\Result as UAResult;
use UAParser\Result\Result as UAParserResult;
use UserAgentParser\Exception;
use UserAgentParser\Model;

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

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

    /**
     * Composer package name
     *
     * @var string
     */
    protected $packageName = 'yzalis/ua-parser';

    protected $detectionCapabilities = [

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

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

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

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

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

    protected $defaultValues = [
        'Other',
    ];

    private $parser;

    public function __construct(\UAParser\UAParser $parser = null)

This method seems to be duplicated in your project.

    {
        if (! class_exists('UAParser\UAParser', true)) {
            throw new Exception\PackageNotLoadedException('You need to install ' . $this->getHomepage() . ' to use this provider');
        }

        $this->parser = $parser;
    }

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

        $this->parser = new \UAParser\UAParser();

        return $this->parser;
    }

    /**
     *
     * @param UAParserResult $resultRaw
     *
     * @return bool
     */
    private function hasResult(UAParserResult $resultRaw)
    {
        /* @var $browserRaw \UAParser\Result\BrowserResult */
        $browserRaw = $resultRaw->getBrowser();

        if ($browserRaw !== null && $this->isRealResult($browserRaw->getFamily()) === true) {
            return true;
        }

        /* @var $osRaw \UAParser\Result\OperatingSystemResult */
        $osRaw = $resultRaw->getOperatingSystem();

        if ($osRaw !== null && $this->isRealResult($osRaw->getFamily()) === true) {
            return true;
        }

        /* @var $deviceRaw \UAParser\Result\DeviceResult */
        $deviceRaw = $resultRaw->getDevice();

        if ($deviceRaw !== null && $this->isRealResult($deviceRaw->getConstructor()) === true) {
            return true;
        }

        if ($deviceRaw !== null && $this->isRealResult($deviceRaw->getModel()) === true) {
            return true;
        }

        return false;
    }

    /**
     *
     * @param Model\Browser          $browser
     * @param UAResult\BrowserResult $browserRaw
     */
    private function hydrateBrowser(Model\Browser $browser, UAResult\BrowserResult $browserRaw)

This method seems to be duplicated in your project.

    {
        if ($this->isRealResult($browserRaw->getFamily()) === true) {
            $browser->setName($browserRaw->getFamily());
        }

        if ($this->isRealResult($browserRaw->getVersionString()) === true) {
            $browser->getVersion()->setComplete($browserRaw->getVersionString());
        }
    }

    /**
     *
     * @param Model\RenderingEngine          $engine
     * @param UAResult\RenderingEngineResult $renderingEngineRaw
     */
    private function hydrateRenderingEngine(Model\RenderingEngine $engine, UAResult\RenderingEngineResult $renderingEngineRaw)

This method seems to be duplicated in your project.

    {
        if ($this->isRealResult($renderingEngineRaw->getFamily()) === true) {
            $engine->setName($renderingEngineRaw->getFamily());
        }

        if ($this->isRealResult($renderingEngineRaw->getVersion()) === true) {
            $engine->getVersion()->setComplete($renderingEngineRaw->getVersion());
        }
    }

    /**
     *
     * @param Model\OperatingSystem          $os
     * @param UAResult\OperatingSystemResult $osRaw
     */
    private function hydrateOperatingSystem(Model\OperatingSystem $os, UAResult\OperatingSystemResult $osRaw)
    {
        if ($this->isRealResult($osRaw->getFamily()) === true) {
            $os->setName($osRaw->getFamily());
        }

        if ($this->isRealResult($osRaw->getMajor()) === true) {
            $os->getVersion()->setMajor($osRaw->getMajor());

            if ($this->isRealResult($osRaw->getMinor()) === true) {
                $os->getVersion()->setMinor($osRaw->getMinor());
            }

            if ($this->isRealResult($osRaw->getPatch()) === true) {
                $os->getVersion()->setPatch($osRaw->getPatch());
            }
        }
    }

    /**
     *
     * @param Model\UserAgent       $device
     * @param UAResult\DeviceResult $deviceRaw
     */
    private function hydrateDevice(Model\Device $device, UAResult\DeviceResult $deviceRaw)
    {
        if ($this->isRealResult($deviceRaw->getModel()) === true) {
            $device->setModel($deviceRaw->getModel());
        }

        if ($this->isRealResult($deviceRaw->getConstructor()) === true) {
            $device->setBrand($deviceRaw->getConstructor());
        }

        // removed desktop type, since it's a default value and not really detected
        if ($this->isRealResult($deviceRaw->getType()) === true && $deviceRaw->getType() !== 'desktop') {
            $device->setType($deviceRaw->getType());
        }
    }

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

        /* @var $resultRaw \UAParser\Result\Result */
        $resultRaw = $parser->parse($userAgent);

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

        /* @var $emailRaw \UAParser\Result\EmailClientResult */
        // currently not used...any idea to implement it?

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

        /*
         * Bot detection is currently not possible
         */

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

        return $result;
    }
}