-
Notifications
You must be signed in to change notification settings - Fork 0
/
BitfieldMapper.php
175 lines (160 loc) · 5.22 KB
/
BitfieldMapper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<?php
/**
* Musras
*
* PHP version 5
*
* All rights reserved.
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
* - Neither the name of the <ORGANIZATION> nor the names of its contributors
* may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category Musras
* @package Musras
* @author Steven Bredenberg <steven@killsaw.com>
* @copyright 2010-2011 Steven Bredenberg
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @link http://github.com/killsaw/Musrar/blob/Bitfield
*/
/**
* Provides simpler access to Bitfields via hijacked class property access.
*
* @category Musras
* @package Musras
* @author Steven Bredenberg <steven@killsaw.com>
* @copyright 2010-2011 Steven Bredenberg
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @version Release: @package_version@
* @link http://github.com/killsaw/Musrar/blob/Bitfield
*/
abstract class BitfieldMapper
{
/**
* Subclass properties that are mapped to bitfield.
* @var array
* @access protected
*/
protected $mapped = array();
/**
* Actual Bitfield object.
* @var Bitfield
* @access protected
*/
protected $bitfield;
/**
* Class constructor.
*
* @param integer $value Bitfield value to init with.
*
* @return void
* @access public
*/
public function __construct($value=0)
{
$this->setupBitfield();
$this->setBitfield($value);
}
/**
* Discover subclass properties to map. Add them to Bitfield.
*
* @return void
* @access protected
*/
protected function setupBitfield()
{
$this->bitfield = new Bitfield;
$c = new ReflectionClass($this);
$props = $c->getProperties(ReflectionProperty::IS_PROTECTED);
foreach ((array)$props as $p) {
if ($p->class == __CLASS__) {
continue;
}
$class_name = get_class($this);
$constant_name = strtoupper($class_name).
'_'.strtoupper($p->name);
$this->bitfield->addOption($constant_name, $unique_check = false);
$this->mapped[$p->name] = $constant_name;
}
}
/**
* Set multiple options at once or load from saved value.
*
* @param integer $value Bitfield value.
*
* @return void
* @access public
*/
public function setBitfield($value)
{
$this->bitfield->setBitfield($value);
}
/**
* Returns binary string form of bitfield.
*
* @return string
* @access public
*/
public function toBinary()
{
return $this->bitfield->toBinary();
}
/**
* Set property value, proxied to Bitmap.
*
* @param string $name Name of class property.
* @param mixed $value Boolean or whatever can be interpreted as one.
*
* @return void
* @access public
* @magic
* @throws Exception
*/
public function __set($name, $value)
{
if (!array_key_exists($name, $this->mapped)) {
throw new Exception("Property '$name' does not exist in bitfield map.");
}
if ($value) {
$this->bitfield->enable(constant($this->mapped[$name]));
} else {
$this->bitfield->disable(constant($this->mapped[$name]));
}
}
/**
* Get property value, proxied from Bitmap.
*
* @param string $name Name of class property.
*
* @return bool
* @access public
* @magic
* @throws Exception
*/
public function __get($name)
{
if (!array_key_exists($name, $this->mapped)) {
throw new Exception("Property '$name' does not exist in bitfield map.");
}
return $this->bitfield->isEnabled(constant($this->mapped[$name]));
}
}