Skip to content

Commit de3635f

Browse files
jordanbrauerjordanbrauer
committed
Bump version to 0.6.0 and update docs.
1 parent 41e52c9 commit de3635f

19 files changed

+1027
-633
lines changed

‎composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "jordanbrauer/unit-converter",
33
"description": "Convert standard units from one to another with this easy to use, lightweight package",
4-
"version": "0.5.1",
4+
"version": "0.6.0",
55
"type": "component",
66
"license": "MIT",
77
"authors": [

‎docs/class-UnitConverter.Calculator.AbstractCalculator.html

+184-19
Large diffs are not rendered by default.

‎docs/class-UnitConverter.Calculator.BinaryCalculator.html

+80-7
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ <h1>BinaryCalculator</h1>
106106
<div class="info">
107107

108108

109+
<br>
109110
<a href="http://php.net/manual/en/book.bc.php">http://php.net/manual/en/book.bc.php</a><br>
110111
<br>
111112
<br>
@@ -132,7 +133,7 @@ <h1>BinaryCalculator</h1>
132133
<td class="name">
133134
<div>
134135
<a class="anchor pull-right" href="#_setPrecision">#</a>
135-
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#29-34">setPrecision</a>( <span> int <span class="property-name">$precision</span> </span> )</code>
136+
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#31-37">setPrecision</a>( <span> int <span class="property-name">$precision</span> </span> )</code>
136137

137138
<div class="description">
138139

@@ -159,6 +160,47 @@ <h2>Overrides</h2>
159160

160161

161162

163+
<tr id="_round">
164+
165+
<td class="attributes col-md-1">
166+
<code class="keyword">
167+
public
168+
169+
170+
</code>
171+
</td>
172+
173+
<td class="name">
174+
<div>
175+
<a class="anchor pull-right" href="#_round">#</a>
176+
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#43-46">round</a>( <span> <span class="property-name">$value</span> </span>, <span> int <span class="property-name">$precision</span> = <span class="php-keyword1">NULL</span></span> )</code>
177+
178+
<div class="description">
179+
Overwrites the default implementation for rounding. Simply
180+
casts the result to a string.
181+
182+
183+
184+
185+
186+
187+
188+
<h2>Overrides</h2>
189+
<div>
190+
<code>
191+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#_round">
192+
UnitConverter\Calculator\AbstractCalculator::round()
193+
</a>
194+
</code>
195+
</div>
196+
197+
</div>
198+
</div>
199+
</td>
200+
</tr>
201+
202+
203+
162204
<tr id="_add">
163205

164206
<td class="attributes col-md-1">
@@ -172,7 +214,7 @@ <h2>Overrides</h2>
172214
<td class="name">
173215
<div>
174216
<a class="anchor pull-right" href="#_add">#</a>
175-
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#36-39">add</a>( <span> <span class="property-name">$leftOperand</span> </span>, <span> <span class="property-name">$rightOperand</span> </span> )</code>
217+
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#48-51">add</a>( <span> <span class="property-name">$leftOperand</span> </span>, <span> <span class="property-name">$rightOperand</span> </span> )</code>
176218

177219
<div class="description">
178220

@@ -204,7 +246,7 @@ <h2>Overrides</h2>
204246
<td class="name">
205247
<div>
206248
<a class="anchor pull-right" href="#_sub">#</a>
207-
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#41-44">sub</a>( <span> <span class="property-name">$leftOperand</span> </span>, <span> <span class="property-name">$rightOperand</span> </span> )</code>
249+
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#53-56">sub</a>( <span> <span class="property-name">$leftOperand</span> </span>, <span> <span class="property-name">$rightOperand</span> </span> )</code>
208250

209251
<div class="description">
210252

@@ -236,7 +278,7 @@ <h2>Overrides</h2>
236278
<td class="name">
237279
<div>
238280
<a class="anchor pull-right" href="#_mul">#</a>
239-
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#46-49">mul</a>( <span> <span class="property-name">$leftOperand</span> </span>, <span> <span class="property-name">$rightOperand</span> </span> )</code>
281+
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#58-61">mul</a>( <span> <span class="property-name">$leftOperand</span> </span>, <span> <span class="property-name">$rightOperand</span> </span> )</code>
240282

241283
<div class="description">
242284

@@ -268,7 +310,7 @@ <h2>Overrides</h2>
268310
<td class="name">
269311
<div>
270312
<a class="anchor pull-right" href="#_div">#</a>
271-
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#51-54">div</a>( <span> <span class="property-name">$dividend</span> </span>, <span> <span class="property-name">$divisor</span> </span> )</code>
313+
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#63-66">div</a>( <span> <span class="property-name">$dividend</span> </span>, <span> <span class="property-name">$divisor</span> </span> )</code>
272314

273315
<div class="description">
274316

@@ -300,7 +342,7 @@ <h2>Overrides</h2>
300342
<td class="name">
301343
<div>
302344
<a class="anchor pull-right" href="#_mod">#</a>
303-
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#56-59">mod</a>( <span> <span class="property-name">$dividend</span> </span>, <span> <span class="property-name">$modulus</span> </span> )</code>
345+
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#68-71">mod</a>( <span> <span class="property-name">$dividend</span> </span>, <span> <span class="property-name">$modulus</span> </span> )</code>
304346

305347
<div class="description">
306348

@@ -332,7 +374,7 @@ <h2>Overrides</h2>
332374
<td class="name">
333375
<div>
334376
<a class="anchor pull-right" href="#_pow">#</a>
335-
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#61-64">pow</a>( <span> <span class="property-name">$base</span> </span>, <span> <span class="property-name">$exponent</span> </span> )</code>
377+
<code><a href="source-class-UnitConverter.Calculator.BinaryCalculator.html#73-76">pow</a>( <span> <span class="property-name">$base</span> </span>, <span> <span class="property-name">$exponent</span> </span> )</code>
336378

337379
<div class="description">
338380

@@ -381,6 +423,37 @@ <h2>Overrides</h2>
381423

382424

383425

426+
<table class="summary table table-bordered table-responsive table-striped">
427+
<tr>
428+
<th>
429+
Constants inherited from <a href="class-UnitConverter.Calculator.AbstractCalculator.html#constants">UnitConverter\Calculator\AbstractCalculator</a>
430+
</th>
431+
</tr>
432+
<tr>
433+
<td>
434+
<code class="keyword">
435+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#DEFAULT_PRECISION" class="constant-name">
436+
DEFAULT_PRECISION
437+
</a>,
438+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#DEFAULT_ROUNDING_MODE" class="constant-name">
439+
DEFAULT_ROUNDING_MODE
440+
</a>,
441+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#ROUND_HALF_UP" class="constant-name">
442+
ROUND_HALF_UP
443+
</a>,
444+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#ROUND_HALF_DOWN" class="constant-name">
445+
ROUND_HALF_DOWN
446+
</a>,
447+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#ROUND_HALF_EVEN" class="constant-name">
448+
ROUND_HALF_EVEN
449+
</a>,
450+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#ROUND_HALF_ODD" class="constant-name">
451+
ROUND_HALF_ODD
452+
</a>
453+
</code>
454+
</td>
455+
</tr>
456+
</table>
384457

385458

386459
<table class="summary table table-bordered table-responsive table-striped">

‎docs/class-UnitConverter.Calculator.SimpleCalculator.html

+31
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,37 @@ <h1>SimpleCalculator</h1>
342342

343343

344344

345+
<table class="summary table table-bordered table-responsive table-striped">
346+
<tr>
347+
<th>
348+
Constants inherited from <a href="class-UnitConverter.Calculator.AbstractCalculator.html#constants">UnitConverter\Calculator\AbstractCalculator</a>
349+
</th>
350+
</tr>
351+
<tr>
352+
<td>
353+
<code class="keyword">
354+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#DEFAULT_PRECISION" class="constant-name">
355+
DEFAULT_PRECISION
356+
</a>,
357+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#DEFAULT_ROUNDING_MODE" class="constant-name">
358+
DEFAULT_ROUNDING_MODE
359+
</a>,
360+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#ROUND_HALF_UP" class="constant-name">
361+
ROUND_HALF_UP
362+
</a>,
363+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#ROUND_HALF_DOWN" class="constant-name">
364+
ROUND_HALF_DOWN
365+
</a>,
366+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#ROUND_HALF_EVEN" class="constant-name">
367+
ROUND_HALF_EVEN
368+
</a>,
369+
<a href="class-UnitConverter.Calculator.AbstractCalculator.html#ROUND_HALF_ODD" class="constant-name">
370+
ROUND_HALF_ODD
371+
</a>
372+
</code>
373+
</td>
374+
</tr>
375+
</table>
345376

346377

347378
<table class="summary table table-bordered table-responsive table-striped">

‎docs/class-UnitConverter.UnitConverter.html

+44-12
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h1>UnitConverter</h1>
127127
<td class="name">
128128
<div>
129129
<a class="anchor pull-right" href="#___construct">#</a>
130-
<code><a href="source-class-UnitConverter.UnitConverter.html#69-73">__construct</a>( <span> <a href="interface-UnitConverter.Registry.UnitRegistryInterface.html">UnitConverter\Registry\UnitRegistryInterface</a> <span class="property-name">$registry</span> </span>, <span> <a href="interface-UnitConverter.Calculator.CalculatorInterface.html">UnitConverter\Calculator\CalculatorInterface</a> <span class="property-name">$calculator</span> </span> )</code>
130+
<code><a href="source-class-UnitConverter.UnitConverter.html#70-74">__construct</a>( <span> <a href="interface-UnitConverter.Registry.UnitRegistryInterface.html">UnitConverter\Registry\UnitRegistryInterface</a> <span class="property-name">$registry</span> </span>, <span> <a href="interface-UnitConverter.Calculator.CalculatorInterface.html">UnitConverter\Calculator\CalculatorInterface</a> <span class="property-name">$calculator</span> </span> )</code>
131131

132132
<div class="description">
133133
Public constructor function for the UnitConverter class.
@@ -159,7 +159,7 @@ <h1>UnitConverter</h1>
159159
<td class="name">
160160
<div>
161161
<a class="anchor pull-right" href="#_setRegistry">#</a>
162-
<code><a href="source-class-UnitConverter.UnitConverter.html#82-86">setRegistry</a>( <span> <a href="interface-UnitConverter.Registry.UnitRegistryInterface.html">UnitConverter\Registry\UnitRegistryInterface</a> <span class="property-name">$registry</span> </span> )</code>
162+
<code><a href="source-class-UnitConverter.UnitConverter.html#83-87">setRegistry</a>( <span> <a href="interface-UnitConverter.Registry.UnitRegistryInterface.html">UnitConverter\Registry\UnitRegistryInterface</a> <span class="property-name">$registry</span> </span> )</code>
163163

164164
<div class="description">
165165
Set the unit converter registry for storing units of measure to convert values with.
@@ -195,7 +195,7 @@ <h2>api</h2>
195195
<td class="name">
196196
<div>
197197
<a class="anchor pull-right" href="#_setCalculator">#</a>
198-
<code><a href="source-class-UnitConverter.UnitConverter.html#95-99">setCalculator</a>( <span> <a href="interface-UnitConverter.Calculator.CalculatorInterface.html">UnitConverter\Calculator\CalculatorInterface</a> <span class="property-name">$calculator</span> </span> )</code>
198+
<code><a href="source-class-UnitConverter.UnitConverter.html#96-100">setCalculator</a>( <span> <a href="interface-UnitConverter.Calculator.CalculatorInterface.html">UnitConverter\Calculator\CalculatorInterface</a> <span class="property-name">$calculator</span> </span> )</code>
199199

200200
<div class="description">
201201
Set the unit converter calculator to perform mathematical operations with.
@@ -231,7 +231,7 @@ <h2>api</h2>
231231
<td class="name">
232232
<div>
233233
<a class="anchor pull-right" href="#_convert">#</a>
234-
<code><a href="source-class-UnitConverter.UnitConverter.html#101-106">convert</a>( <span> <span class="property-name">$value</span> </span>, <span> int <span class="property-name">$precision</span> = <span class="php-keyword1">NULL</span></span> )</code>
234+
<code><a href="source-class-UnitConverter.UnitConverter.html#102-107">convert</a>( <span> <span class="property-name">$value</span> </span>, <span> int <span class="property-name">$precision</span> = <span class="php-keyword1">NULL</span></span> )</code>
235235

236236
<div class="description">
237237

@@ -271,7 +271,7 @@ <h2>Implementation of</h2>
271271
<td class="name">
272272
<div>
273273
<a class="anchor pull-right" href="#_from">#</a>
274-
<code><a href="source-class-UnitConverter.UnitConverter.html#108-112">from</a>( <span> string <span class="property-name">$unit</span> </span> )</code>
274+
<code><a href="source-class-UnitConverter.UnitConverter.html#109-113">from</a>( <span> string <span class="property-name">$unit</span> </span> )</code>
275275

276276
<div class="description">
277277

@@ -311,7 +311,7 @@ <h2>Implementation of</h2>
311311
<td class="name">
312312
<div>
313313
<a class="anchor pull-right" href="#_to">#</a>
314-
<code><a href="source-class-UnitConverter.UnitConverter.html#114-124">to</a>( <span> string <span class="property-name">$unit</span> </span> )</code>
314+
<code><a href="source-class-UnitConverter.UnitConverter.html#115-125">to</a>( <span> string <span class="property-name">$unit</span> </span> )</code>
315315

316316
<div class="description">
317317

@@ -331,6 +331,38 @@ <h2>Implementation of</h2>
331331
</a>
332332
</code>
333333
</div>
334+
</div>
335+
</div>
336+
</td>
337+
</tr>
338+
339+
340+
341+
<tr id="_castUnitsTo">
342+
343+
<td class="attributes col-md-1">
344+
<code class="keyword">
345+
protected
346+
347+
348+
</code>
349+
</td>
350+
351+
<td class="name">
352+
<div>
353+
<a class="anchor pull-right" href="#_castUnitsTo">#</a>
354+
<code><a href="source-class-UnitConverter.UnitConverter.html#248-264">castUnitsTo</a>( <span> string <span class="property-name">$type</span> </span> )</code>
355+
356+
<div class="description">
357+
Returns an array containing the "from" and "to" unit values casted to the specified type.
358+
359+
360+
361+
362+
363+
364+
365+
334366
</div>
335367
</div>
336368
</td>
@@ -354,7 +386,7 @@ <h2>Implementation of</h2>
354386

355387
<td class="name">
356388
<code>
357-
<a href="source-class-UnitConverter.UnitConverter.html#36" class="property-name">$registry</a>
389+
<a href="source-class-UnitConverter.UnitConverter.html#37" class="property-name">$registry</a>
358390
</code>
359391
<div class="description">
360392

@@ -382,7 +414,7 @@ <h2>Implementation of</h2>
382414

383415
<td class="name">
384416
<code>
385-
<a href="source-class-UnitConverter.UnitConverter.html#41" class="property-name">$calculator</a>
417+
<a href="source-class-UnitConverter.UnitConverter.html#42" class="property-name">$calculator</a>
386418
</code>
387419
<div class="description">
388420

@@ -410,7 +442,7 @@ <h2>Implementation of</h2>
410442

411443
<td class="name">
412444
<code>
413-
<a href="source-class-UnitConverter.UnitConverter.html#46" class="property-name">$convert</a>
445+
<a href="source-class-UnitConverter.UnitConverter.html#47" class="property-name">$convert</a>
414446
</code>
415447
<div class="description">
416448

@@ -438,7 +470,7 @@ <h2>Implementation of</h2>
438470

439471
<td class="name">
440472
<code>
441-
<a href="source-class-UnitConverter.UnitConverter.html#51" class="property-name">$from</a>
473+
<a href="source-class-UnitConverter.UnitConverter.html#52" class="property-name">$from</a>
442474
</code>
443475
<div class="description">
444476

@@ -466,7 +498,7 @@ <h2>Implementation of</h2>
466498

467499
<td class="name">
468500
<code>
469-
<a href="source-class-UnitConverter.UnitConverter.html#56" class="property-name">$to</a>
501+
<a href="source-class-UnitConverter.UnitConverter.html#57" class="property-name">$to</a>
470502
</code>
471503
<div class="description">
472504

@@ -494,7 +526,7 @@ <h2>Implementation of</h2>
494526

495527
<td class="name">
496528
<code>
497-
<a href="source-class-UnitConverter.UnitConverter.html#61" class="property-name">$precision</a>
529+
<a href="source-class-UnitConverter.UnitConverter.html#62" class="property-name">$precision</a>
498530
</code>
499531
<div class="description">
500532

‎docs/namespace-UnitConverter.Calculator.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -97,21 +97,21 @@ <h1>UnitConverter\Calculator</h1>
9797
</tr>
9898
<tr>
9999
<td class="name">
100-
<a href="class-UnitConverter.Calculator.BinaryCalculator.html">
101-
BinaryCalculator
100+
<a href="class-UnitConverter.Calculator.SimpleCalculator.html">
101+
SimpleCalculator
102102
</a>
103103
</td>
104-
<td>A concrete calculator calss that uses the bcmath library
105-
to perform mathematical operations.</td>
104+
<td>A basic implementation of the CalculatorInterface for performing
105+
mathematical operations with.</td>
106106
</tr>
107107
<tr>
108108
<td class="name">
109-
<a href="class-UnitConverter.Calculator.SimpleCalculator.html">
110-
SimpleCalculator
109+
<a href="class-UnitConverter.Calculator.BinaryCalculator.html">
110+
BinaryCalculator
111111
</a>
112112
</td>
113-
<td>A basic implementation of the CalculatorInterface for performing
114-
mathematical operations with.</td>
113+
<td>A concrete calculator calss that uses the bcmath library
114+
to perform mathematical operations.</td>
115115
</tr>
116116
</table>
117117

0 commit comments

Comments
 (0)