ThaDafinser / UserAgentParser

src/Provider/HandsetDetection.php

<?php
namespace UserAgentParser\Provider;

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

/**
 * Abstraction for ua-parser/uap-php
 *
 * @author Martin Keckeis <martin.keckeis1@gmail.com>
 * @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;

45% of this comment could be valid code. Did you maybe forget this after debugging?

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

50% of this comment could be valid code. Did you maybe forget this after debugging?

        /*
         * No result found?
         */
        $result    = $parser->deviceDetect($headers);
        $resultRaw = $parser->getReply();

        if ($result !== true) {
            if (isset($resultRaw['status']) && $resultRaw['status'] == '299') {
                throw new InvalidArgumentException('You need to warm-up the cache first to use this provider');
            }

            throw new NoResultFoundException('No result found for user agent: ' . $userAgent);
        }

        /*
         * 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($this->getName(), $this->getVersion());
        $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;
    }
}