Platine\UserAgent\UserAgent

Complexity

Total Complexity

8

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	engine()	0	6	1
A	browser()	0	6	1
A	cpu()	0	6	1
A	device()	0	6	1
A	parse()	0	11	1
A	__construct()	0	10	2
A	os()	0	6	1

<?php

/**
 * Platine User Agent
 *
 * Platine User Agent is a lightweight library for detecting
 * user browser, device, OS, CPU
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine User Agent
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file UserAgent.php
 *
 *  The Platine User Agent main class
 *
 *  @package    Platine\UserAgent
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\UserAgent;

use Platine\UserAgent\Detector\BrowserDetector;
use Platine\UserAgent\Detector\CpuDetector;
use Platine\UserAgent\Detector\DeviceDetector;
use Platine\UserAgent\Detector\EngineDetector;
use Platine\UserAgent\Detector\OsDetector;
use Platine\UserAgent\Entity\Browser;
use Platine\UserAgent\Entity\Cpu;
use Platine\UserAgent\Entity\Device;
use Platine\UserAgent\Entity\Engine;
use Platine\UserAgent\Entity\Os;

/**
 * @class UserAgent
 * @package Platine\UserAgent
 */
class UserAgent
{
    /**
     * Operating System detector
     * @var OsDetector
     */
    protected OsDetector $osDetector;

    /**
     * Device detector
     * @var DeviceDetector
     */
    protected DeviceDetector $deviceDetector;

    /**
     * Browser detector
     * @var BrowserDetector
     */
    protected BrowserDetector $browserDetector;

    /**
     * Engine detector
     * @var EngineDetector
     */
    protected EngineDetector $engineDetector;

    /**
     * CPU detector
     * @var CpuDetector
     */
    protected CpuDetector $cpuDetector;

    /**
     * Operating System entity
     * @var Os
     */
    protected Os $os;

    /**
     * Device entity
     * @var Device
     */
    protected Device $device;

    /**
     * Browser entity
     * @var Browser
     */
    protected Browser $browser;

    /**
     * Engine entity
     * @var Engine
     */
    protected Engine $engine;

    /**
     * CPU entity
     * @var Cpu
     */
    protected Cpu $cpu;

    /**
     * The User agent string
     * @var string
     */
    protected string $userAgent;

    /**
     * Create new instance
     * @param string|null $userAgent
     */
    public function __construct(?string $userAgent = null)
    {
        $this->browserDetector = new BrowserDetector();
        $this->cpuDetector = new CpuDetector();
        $this->engineDetector = new EngineDetector();
        $this->deviceDetector = new DeviceDetector();
        $this->osDetector = new OsDetector();

        if ($userAgent !== null) {
            $this->parse($userAgent);
        }
    }

    /**
     * Parse the user agent for the given value
     * @param string $userAgent
     * @return $this
     */
    public function parse(string $userAgent): self
    {
        $this->userAgent = $userAgent;

        $this->browserDetector->detect($this->userAgent);
        $this->cpuDetector->detect($this->userAgent);
        $this->engineDetector->detect($this->userAgent);
        $this->deviceDetector->detect($this->userAgent);
        $this->osDetector->detect($this->userAgent);

        return $this;
    }

    /**
     * The Operating System entity
     * @return Os
     */
    public function os(): Os
    {
        /** @var Os $os */
        $os = $this->osDetector->entity();

        return $this->os = $os;
    }

    /**
     * The device entity
     * @return Device
     */
    public function device(): Device
    {
        /** @var Device $device */
        $device = $this->deviceDetector->entity();

        return $this->device = $device;
    }

    /**
     * The browser entity
     * @return Browser
     */
    public function browser(): Browser
    {
        /** @var Browser $browser */
        $browser = $this->browserDetector->entity();

        return $this->browser = $browser;
    }

    /**
     * The engine entity
     * @return Engine
     */
    public function engine(): Engine
    {
        /** @var Engine $engine */
        $engine = $this->engineDetector->entity();

        return $this->engine = $engine;
    }

    /**
     * The CPU entity
     * @return Cpu
     */
    public function cpu(): Cpu
    {
        /** @var Cpu $cpu */
        $cpu = $this->cpuDetector->entity();

        return $this->cpu = $cpu;
    }
}