Platine\UserAgent\Entity\BaseEntity

Complexity

Total Complexity

7

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getVersion()	0	3	1
A	getMajor()	0	3	1
A	setVersion()	0	7	1
A	setName()	0	5	1
A	getName()	0	3	1
A	setMajor()	0	5	1
A	__toString()	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 BaseEntity.php
 *
 *  The base entity class that contains common data
 *
 *  @package    Platine\UserAgent\Entity
 *  @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\Entity;

use Platine\UserAgent\Util\Helper;
use Stringable;

/**
 * @class BaseEntity
 * @package Platine\UserAgent\Entity
 */
class BaseEntity extends AbstractEntity implements Stringable
{
    /**
     * The major version number
     * @var int
     */
    protected int $major = 0;

    /**
     * The name of the browser
     * @var string
     */
    protected string $name = '';

    /**
     * The full version
     * @var string
     */
    protected string $version = '';

    /**
     * Return the major version number
     * @return int
     */
    public function getMajor(): int
    {
        return $this->major;
    }

    /**
     * Return the browser name
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * Return the browser full version
     * @return string
     */
    public function getVersion(): string
    {
        return $this->version;
    }

    /**
     * Set the browser major version
     * @return $this
     */
    public function setMajor(): self
    {
        $this->major = Helper::getMajorVersion($this->version);

        return $this;
    }

    /**
     * Set the browser name
     * @param string $name
     * @return $this
     */
    public function setName(string $name): self
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Set the browser version
     * @param string $version
     * @return $this
     */
    public function setVersion(string $version): self
    {
        $this->version = $version;

        $this->setMajor();

        return $this;
    }

    /**
     * The string representation
     * @return string
     */
    public function __toString(): string
    {
        return sprintf(
            '%s %s',
            $this->name,
            $this->version
        );
    }
}