Passed
Push — develop ( 7fbd2c...82694f )
by nguereza
02:49
created

BaseEntity::__toString()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 4
c 0
b 0
f 0
dl 0
loc 6
rs 10
cc 1
nc 1
nop 0
1
<?php
2
3
/**
4
 * Platine User Agent
5
 *
6
 * Platine User Agent is a lightweight library for detecting
7
 * user browser, device, OS, CPU
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine User Agent
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file BaseEntity.php
34
 *
35
 *  The base entity class that contains common data
36
 *
37
 *  @package    Platine\UserAgent\Entity
38
 *  @author Platine Developers Team
39
 *  @copyright  Copyright (c) 2020
40
 *  @license    http://opensource.org/licenses/MIT  MIT License
41
 *  @link   http://www.iacademy.cf
42
 *  @version 1.0.0
43
 *  @filesource
44
 */
45
46
declare(strict_types=1);
47
48
namespace Platine\UserAgent\Entity;
49
50
use Platine\UserAgent\Util\Helper;
51
52
/**
53
 * Class BaseEntity
54
 * @package Platine\UserAgent\Entity
55
 */
56
class BaseEntity extends AbstractEntity
57
{
58
    /**
59
     * The major version number
60
     * @var int
61
     */
62
    protected int $major = 0;
63
64
    /**
65
     * The name of the browser
66
     * @var string
67
     */
68
    protected string $name = '';
69
70
    /**
71
     * The full version
72
     * @var string
73
     */
74
    protected string $version = '';
75
76
    /**
77
     * Return the major version number
78
     * @return int
79
     */
80
    public function getMajor(): int
81
    {
82
        return $this->major;
83
    }
84
85
    /**
86
     * Return the browser name
87
     * @return string
88
     */
89
    public function getName(): string
90
    {
91
        return $this->name;
92
    }
93
94
    /**
95
     * Return the browser full version
96
     * @return string
97
     */
98
    public function getVersion(): string
99
    {
100
        return $this->version;
101
    }
102
103
    /**
104
     * Set the browser major version
105
     * @return $this
106
     */
107
    public function setMajor(): self
108
    {
109
        $this->major = Helper::getMajorVersion($this->version);
110
111
        return $this;
112
    }
113
114
    /**
115
     * Set the browser name
116
     * @param string $name
117
     * @return $this
118
     */
119
    public function setName(string $name): self
120
    {
121
        $this->name = $name;
122
123
        return $this;
124
    }
125
126
    /**
127
     * Set the browser version
128
     * @param string $version
129
     * @return $this
130
     */
131
    public function setVersion(string $version): self
132
    {
133
        $this->version = $version;
134
135
        $this->setMajor();
136
137
        return $this;
138
    }
139
140
    /**
141
     * The string representation
142
     * @return string
143
     */
144
    public function __toString(): string
145
    {
146
        return sprintf(
147
            '%s %s',
148
            $this->name,
149
            $this->version
150
        );
151
    }
152
}
153