-
Notifications
You must be signed in to change notification settings - Fork 39
/
AbstractUnit.php
278 lines (226 loc) · 6.5 KB
/
AbstractUnit.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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<?php
declare(strict_types = 1);
/**
* This file is part of the jordanbrauer/unit-converter PHP package.
*
* @copyright 2018 Jordan Brauer <18744334+jordanbrauer@users.noreply.github.com>
* @license MIT
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace UnitConverter\Unit;
use OutOfRangeException;
use UnitConverter\Calculator\Formula\FormulaInterface;
use UnitConverter\Calculator\Formula\UnitConversionFormula;
use UnitConverter\Exception\BadUnit;
use UnitConverter\Unit\Family\SiMultipleUnit;
use UnitConverter\Unit\Family\SiSubmultipleUnit;
use UnitConverter\Unit\Family\SiUnit;
/**
* This class is the base class for all unit of measurement classes.
* When creating a new/custom unit of measure, extend from this class.
*
* @version 1.0.0
* @since 0.0.1
* @author Jordan Brauer <18744334+jordanbrauer@users.noreply.github.com>
*/
abstract class AbstractUnit implements UnitInterface
{
private const RESERVED_FORMULA = '*';
/**
* @var string|UnitInterface $base The units' base unit classname.
*/
protected $base;
/**
* An array of formulae for this unit to convert itself with.
*
* @var array
*/
protected $formulae;
/**
* @var string $name The units' full name.
*/
protected $name;
/**
* @var string The scientific symbol of the unit
*/
protected $scientificSymbol;
/**
* @var string $symbol The units' symbol notation (e.g., meter = m).
*/
protected $symbol;
/**
* @var string $unitOf What is this unit measuring? Length, temperatutre, etc.
*/
protected $unitOf;
/**
* @var float $units The amount of base units needed to make up 1 unit.
*/
protected $units;
/**
* @var int|float|string The value of the unit (how many of it are measured).
*/
protected $value;
/**
* Public constructor function for units of measurement.
*
* @param int|float|string $value The amount of units to be reprsented by the final object as.
*/
public function __construct($value = 1)
{
$this->value = $value;
$this->formulae = [
self::RESERVED_FORMULA => UnitConversionFormula::class,
];
$this->configure();
}
/**
* String representation of a unit used for unique sorting.
*
* @return string
*/
public function __toString(): string
{
return $this->getScientificSymbol() ?? '';
}
public function addFormula(string $symbol, string $class): void
{
if (self::RESERVED_FORMULA === $symbol) {
throw new OutOfRangeException('Cannot set formula at index `*` for '.$class);
}
$this->formulae[$symbol] = $class;
}
public function addFormulae(array $formulae): void
{
foreach ($formulae as $symbol => $class) {
$this->addFormula($symbol, $class);
}
}
/**
* Convenience method that converts the current unit to whatever unit is
* passed in. Optionally supply precision & whether or not to use a binary
* calculator (BCMath).
*
* @param UnitInterface $unit An instance of the unit being converted to.
* @param integer $precision The precision to calculate to.
* @param boolean $binary Are we using BCMath?
* @return int|float|string
*/
public function as(UnitInterface $unit, int $precision = null, bool $binary = false)
{
return \UnitConverter\UnitConverter::createBuilder()
->{'add'.(($binary) ? 'Binary' : 'Simple').'Calculator'}() # ¯\_(ツ)_/¯
->addRegistryWith(array_unique([$this, $unit]))
->build()
->disableConversionLog()
->convert((string) $this->getValue(), $precision)
->from($this->getSymbol())
->to($unit->getSymbol());
}
public function getBase(): ?UnitInterface
{
return new $this->base();
}
public function getBaseUnits(): ?float
{
return $this->getBase()->getUnits();
}
public function getFormulaFor(UnitInterface $to): ?FormulaInterface
{
if (empty($this->formulae)) {
return null;
}
$symbol = $to->getSymbol();
if (array_key_exists($symbol, $this->formulae)) {
return new $this->formulae[$symbol]();
}
if (array_key_exists(self::RESERVED_FORMULA, $this->formulae)) {
return new $this->formulae[self::RESERVED_FORMULA]();
}
throw BadUnit::formula($symbol);
}
public function getName(): ?string
{
return $this->name;
}
public function getRegistryKey(): ?string
{
return $this->unitOf.'.'.$this->symbol;
}
public function getScientificSymbol(): ?string
{
return $this->scientificSymbol ?? $this->getSymbol();
}
public function getSymbol(): ?string
{
return $this->symbol;
}
public function getUnitOf(): ?string
{
return $this->unitOf;
}
public function getUnits(): ?float
{
return $this->units;
}
public function getValue()
{
return $this->value;
}
public function isMultipleSiUnit(): bool
{
return $this instanceof SiMultipleUnit;
}
public function isSiUnit(): bool
{
return $this instanceof SiUnit;
}
public function isSubmultipleSiUnit(): bool
{
return $this instanceof SiSubmultipleUnit;
}
public function setBase($base): UnitInterface
{
$this->base = $base;
return $this;
}
public function setName(string $name): UnitInterface
{
$this->name = $name;
return $this;
}
public function setScientificSymbol(string $scientificSymbol): UnitInterface
{
$this->scientificSymbol = $scientificSymbol;
return $this;
}
public function setSymbol(string $symbol): UnitInterface
{
$this->symbol = $symbol;
return $this;
}
public function setUnitOf(string $unitOf): UnitInterface
{
$this->unitOf = $unitOf;
return $this;
}
public function setUnits(float $units): UnitInterface
{
$this->units = $units;
return $this;
}
public function setValue($value): UnitInterface
{
$this->value = $value;
return $this;
}
/**
* Configure the current unit of measure.
*
* @return void
*/
protected function configure(): void
{
}
}