Update documentation for v0.8.4

Author: jordanbrauer

docs/classes/UnitConverter.Calculator.BinaryCalculator.html

@@ -24,13 +24,12 @@ use UnitConverter\Calculator\Formula\AbstractFormula;
  */
 class ToMilesPerGallon extends AbstractFormula
 {
-
-    const MAGIC_NUMBER = 2.35215;
-
     const FORMULA_STRING = 'mpg = 2.35215 * km/l';
 
     const FORMULA_TEMPLATE = '%s mpg = 2.35215 * %skm/l';
 
+    const MAGIC_NUMBER = 2.35215;
+
     /**
      * {@inheritDoc}
      */

docs/classes/UnitConverter.Calculator.Formula.AbstractFormula.html

@@ -24,13 +24,12 @@ use UnitConverter\Calculator\Formula\AbstractFormula;
  */
 class ToMilesPerGallon extends AbstractFormula
 {
-
-    const MAGIC_NUMBER = 235.215;
-
     const FORMULA_STRING = 'mpg = 235.215 / L/100km';
 
     const FORMULA_TEMPLATE = '%s mpg = 235.215 / %sL/100km';
 
+    const MAGIC_NUMBER = 235.215;
+
     /**
      * {@inheritDoc}
      */

docs/classes/UnitConverter.Calculator.Formula.FormulaInterface.html

@@ -24,13 +24,12 @@ use UnitConverter\Calculator\Formula\AbstractFormula;
  */
 class ToKilometrePerLitre extends AbstractFormula
 {
-
-    const MAGIC_NUMBER = 0.425144;
-
     const FORMULA_STRING = 'km/l = 0.425144 * mpg';
 
     const FORMULA_TEMPLATE = '%s km/l = 0.425144 * %smpg';
 
+    const MAGIC_NUMBER = 0.425144;
+
     /**
      * {@inheritDoc}
      */

docs/classes/UnitConverter.Calculator.Formula.FuelEconomy.KilometrePerLitre.ToLitrePer100Kilometres.html

@@ -22,6 +22,19 @@ use UnitConverter\Unit\Area\SquareKilometre;
 use UnitConverter\Unit\Area\SquareMetre;
 use UnitConverter\Unit\Area\SquareMile;
 use UnitConverter\Unit\Area\SquareMillimetre;
+use UnitConverter\Unit\DigitalStorage\Bit;
+use UnitConverter\Unit\DigitalStorage\Gibibit;
+use UnitConverter\Unit\DigitalStorage\Gigabit;
+use UnitConverter\Unit\DigitalStorage\Gigabyte;
+use UnitConverter\Unit\DigitalStorage\Kibibit;
+use UnitConverter\Unit\DigitalStorage\Kilobit;
+use UnitConverter\Unit\DigitalStorage\Kilobyte;
+use UnitConverter\Unit\DigitalStorage\Mebibit;
+use UnitConverter\Unit\DigitalStorage\Megabit;
+use UnitConverter\Unit\DigitalStorage\Megabyte;
+use UnitConverter\Unit\DigitalStorage\Tebibit;
+use UnitConverter\Unit\DigitalStorage\Terabit;
+use UnitConverter\Unit\DigitalStorage\Terabyte;
 use UnitConverter\Unit\Energy\Calorie;
 use UnitConverter\Unit\Energy\FootPound;
 use UnitConverter\Unit\Energy\Joule;
@@ -112,6 +125,8 @@ class Measure
 {
     const AREA = "area";
 
+    const DIGITAL_STORAGE = "digital_storage";
+
     const ENERGY = "energy";
 
     const FREQUENCY = 'frequency';
@@ -245,6 +260,21 @@ class Measure
             Terahertz::class,
             Millihertz::class,
         ],
+        self::DIGITAL_STORAGE => [
+            Bit::class,
+            Kilobit::class,
+            Megabit::class,
+            Gigabit::class,
+            Terabit::class,
+            Kibibit::class,
+            Mebibit::class,
+            Gibibit::class,
+            Tebibit::class,
+            Kilobyte::class,
+            Megabyte::class,
+            Gigabyte::class,
+            Terabyte::class,
+        ],
     ];
 
     /**

docs/classes/UnitConverter.Calculator.Formula.FuelEconomy.KilometrePerLitre.ToMilesPerGallon.html

@@ -82,6 +82,16 @@ abstract class AbstractUnit implements UnitInterface
         $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
     {
         $this->formulae[$symbol] = $class;
@@ -108,7 +118,7 @@ abstract class AbstractUnit implements UnitInterface
     {
         return \UnitConverter\UnitConverter::createBuilder()
             ->{'add'.(($binary) ? 'Binary' : 'Simple').'Calculator'}() # ¯\_(ツ)_/¯
-            ->addRegistryWith(array_unique([$this, $unit], SORT_REGULAR))
+            ->addRegistryWith(array_unique([$this, $unit]))
             ->build()
             // ->disableConversionLog() # TODO: when this returns interface, uncomment!
             ->convert((string) $this->getValue(), $precision)

docs/classes/UnitConverter.Calculator.Formula.FuelEconomy.LitrePer100Kilometres.ToKilometrePerLitre.html

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * This file is part of the jordanbrauer/unit-converter PHP package.
+ *
+ * @copyright 2018 Jordan Brauer <[email protected]>
+ * @license MIT
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace UnitConverter\Unit\DigitalStorage;
+
+/**
+ * Bit unit data class
+ *
+ * @version 1.0.0
+ * @since 0.8.4
+ * @author Laurent Clouet <https://github.com/laurent35240>
+ */
+class Bit extends DigitalStorageUnit
+{
+    protected function configure(): void
+    {
+        $this
+            ->setName("bit")
+
+            ->setSymbol("b")
+
+            ->setScientificSymbol("b")
+
+            ->setUnits(1);
+    }
+}
+

docs/classes/UnitConverter.Calculator.Formula.FuelEconomy.LitrePer100Kilometres.ToMilesPerGallon.html

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * This file is part of the jordanbrauer/unit-converter PHP package.
+ *
+ * @copyright 2018 Jordan Brauer <[email protected]>
+ * @license MIT
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace UnitConverter\Unit\DigitalStorage;
+
+/**
+ * Byte unit data class
+ *
+ * @version 1.0.0
+ * @since 0.8.4
+ * @author Laurent Clouet <https://github.com/laurent35240>
+ */
+class Byte extends DigitalStorageUnit
+{
+    protected function configure(): void
+    {
+        $this
+            ->setName("byte")
+
+            ->setSymbol("B")
+
+            ->setScientificSymbol("B")
+
+            ->setUnits(8);
+    }
+}
+

docs/classes/UnitConverter.Calculator.Formula.FuelEconomy.MilesPerGallon.ToKilometrePerLitre.html

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * This file is part of the jordanbrauer/unit-converter PHP package.
+ *
+ * @copyright 2018 Jordan Brauer <[email protected]>
+ * @license MIT
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace UnitConverter\Unit\DigitalStorage;
+
+use UnitConverter\Measure;
+use UnitConverter\Unit\AbstractUnit;
+
+/**
+ * Digital Storage unit base data class. Any new digital storage units should
+ * extend this class and implement their name, symbol and units;
+ * overriding the $unitOf and $base properties only if necessary.
+ *
+ * @version 1.0.0
+ * @since 0.8.4
+ * @author Laurent Clouet <https://github.com/laurent35240>
+ */
+abstract class DigitalStorageUnit extends AbstractUnit
+{
+    protected $base = Bit::class;
+
+    protected $unitOf = Measure::DIGITAL_STORAGE;
+}
+

docs/classes/UnitConverter.Calculator.Formula.FuelEconomy.MilesPerGallon.ToLitrePer100Kilometres.html

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * This file is part of the jordanbrauer/unit-converter PHP package.
+ *
+ * @copyright 2018 Jordan Brauer <[email protected]>
+ * @license MIT
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace UnitConverter\Unit\DigitalStorage;
+
+/**
+ * Gibibit unit data class
+ *
+ * @version 1.0.0
+ * @since 0.8.4
+ * @author Laurent Clouet <https://github.com/laurent35240>
+ */
+class Gibibit extends DigitalStorageUnit
+{
+    protected function configure(): void
+    {
+        $this
+            ->setName("mebibit")
+
+            ->setSymbol("Gib")
+
+            ->setScientificSymbol("Gib")
+
+            ->setUnits(1073741824);
+    }
+}
+

docs/classes/UnitConverter.Calculator.Formula.NullFormula.html

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * This file is part of the jordanbrauer/unit-converter PHP package.
+ *
+ * @copyright 2018 Jordan Brauer <[email protected]>
+ * @license MIT
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace UnitConverter\Unit\DigitalStorage;
+
+/**
+ * Gigabit unit data class
+ *
+ * @version 1.0.0
+ * @since 0.8.4
+ * @author Laurent Clouet <https://github.com/laurent35240>
+ */
+class Gigabit extends DigitalStorageUnit
+{
+    protected function configure(): void
+    {
+        $this
+            ->setName("gigabit")
+
+            ->setSymbol("Gb")
+
+            ->setScientificSymbol("Gb")
+
+            ->setUnits(1000000000);
+    }
+}
+

docs/classes/UnitConverter.Calculator.Formula.Temperature.Celsius.ToFahrenheit.html

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * This file is part of the jordanbrauer/unit-converter PHP package.
+ *
+ * @copyright 2018 Jordan Brauer <[email protected]>
+ * @license MIT
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace UnitConverter\Unit\DigitalStorage;
+
+/**
+ * Gigabyte unit data class
+ *
+ * @version 1.0.0
+ * @since 0.8.4
+ * @author Laurent Clouet <https://github.com/laurent35240>
+ */
+class Gigabyte extends DigitalStorageUnit
+{
+    protected function configure(): void
+    {
+        $this
+            ->setName("gigabyte")
+
+            ->setSymbol("GB")
+
+            ->setScientificSymbol("GB")
+
+            ->setUnits(8000000000);
+    }
+}
+

docs/classes/UnitConverter.Calculator.Formula.Temperature.Celsius.ToKelvin.html

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * This file is part of the jordanbrauer/unit-converter PHP package.
+ *
+ * @copyright 2018 Jordan Brauer <[email protected]>
+ * @license MIT
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace UnitConverter\Unit\DigitalStorage;
+
+/**
+ * Kibibit unit data class
+ *
+ * @version 1.0.0
+ * @since 0.8.4
+ * @author Laurent Clouet <https://github.com/laurent35240>
+ */
+class Kibibit extends DigitalStorageUnit
+{
+    protected function configure(): void
+    {
+        $this
+            ->setName("kibibit")
+
+            ->setSymbol("Kib")
+
+            ->setScientificSymbol("Kib")
+
+            ->setUnits(1024);
+    }
+}
+