Completed
Push — develop ( 75d7aa...a3c683 )
by Stuart
04:31
created

Inet6Address::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 9
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 9
rs 9.6666
cc 1
eloc 7
nc 1
nop 6
1
<?php
2
3
/**
4
 * Copyright (c) 2016-present Ganbaro Digital Ltd
5
 * All rights reserved.
6
 *
7
 * Redistribution and use in source and binary forms, with or without
8
 * modification, are permitted provided that the following conditions
9
 * are met:
10
 *
11
 *   * Redistributions of source code must retain the above copyright
12
 *     notice, this list of conditions and the following disclaimer.
13
 *
14
 *   * Redistributions in binary form must reproduce the above copyright
15
 *     notice, this list of conditions and the following disclaimer in
16
 *     the documentation and/or other materials provided with the
17
 *     distribution.
18
 *
19
 *   * Neither the names of the copyright holders nor the names of his
20
 *     contributors may be used to endorse or promote products derived
21
 *     from this software without specific prior written permission.
22
 *
23
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34
 * POSSIBILITY OF SUCH DAMAGE.
35
 *
36
 * @category  Libraries
37
 * @package   OperatingSystem/NetInterface/Values
38
 * @author    Stuart Herbert <[email protected]>
39
 * @copyright 2016-present Ganbaro Digital Ltd www.ganbarodigital.com
40
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
41
 * @link      http://code.ganbarodigital.com/php-operating-system
42
 */
43
44
namespace GanbaroDigital\OperatingSystem\NetInterfaces\Values;
45
46
class Inet6Address
47
{
48
    /**
49
     * what is the address assigned to the network interface?
50
     *
51
     * this is in RFC 5952 canonical format
52
     *
53
     * @var string
54
     */
55
    protected $address;
56
57
    /**
58
     * what is the netmask assigned to the network interface?
59
     *
60
     * this is in the /X format
61
     *
62
     * @var string
63
     */
64
    protected $netmask;
65
66
    /**
67
     * what is the scope of this address?
68
     *
69
     * On Linux, the following scopes are known to exist:
70
     *
71
     * - global
72
     * - link
73
     * - host
74
     * - site
75
     *
76
     * @var string
77
     */
78
    protected $scope;
79
80
    /**
81
     * what is the address label assigned to this IP address?
82
     *
83
     * On Linux, the following address labels are known to exist:
84
     *
85
     * - secondary
86
     * - dynamic
87
     * - deprecated
88
     * - tentative
89
     *
90
     * @var string
91
     */
92
    protected $addressLabel;
93
94
    /**
95
     * what is the name of the interface that this address is valid on?
96
     *
97
     * @var string
98
     */
99
    protected $linkDevice;
100
101
    /**
102
     * what additional properties have been advertised for this address?
103
     *
104
     * @var array
105
     */
106
    protected $properties;
107
108
    /**
109
     * create a value representing an IPv6 address attached to a network interface
110
     *
111
     * @param string $address
112
     *        the IPv6 address itself
113
     * @param string $netmask
114
     *        the netmask in /X format
115
     * @param string $scope
116
     *        the network scope of this address
117
     * @param string $addressLabel
118
     *        the address label assigned to this IP address
119
     * @param string $linkDevice
120
     *        the name of the interface that this address is available on
121
     * @param array $properties
122
     *        any additional properties declared on this network address
123
     */
124
    public function __construct($address, $netmask, $scope, $addressLabel, $linkDevice, $properties = [])
125
    {
126
        $this->address = $address;
127
        $this->netmask = $netmask;
128
        $this->scope = $scope;
129
        $this->addressLabel = $addressLabel;
130
        $this->linkDevice = $linkDevice;
131
        $this->properties = $properties;
132
    }
133
}
134