SIEnergy.php

<?php

declare(strict_types=1);

namespace Andante\Measurement\Quantity\Energy;

use Andante\Measurement\Contract\AutoScalableInterface;
use Andante\Measurement\Contract\CalculableInterface;
use Andante\Measurement\Contract\ComparableInterface;
use Andante\Measurement\Contract\ConvertibleInterface;
use Andante\Measurement\Contract\Math\NumberInterface;
use Andante\Measurement\Contract\Quantity\Energy\SIEnergyInterface;
use Andante\Measurement\Contract\QuantityFactoryInterface;
use Andante\Measurement\Contract\UnitInterface;
use Andante\Measurement\Exception\InvalidUnitException;
use Andante\Measurement\Quantity\Trait\AutoScalableTrait;
use Andante\Measurement\Quantity\Trait\CalculableTrait;
use Andante\Measurement\Quantity\Trait\ComparableTrait;
use Andante\Measurement\Quantity\Trait\ConvertibleTrait;
use Andante\Measurement\Unit\Energy\SIEnergyUnit;

/**
 * Generic SI energy quantity that can hold any SI energy unit.
 *
 * This is the "mid-level" class for SI energies. Use this when you need
 * to work with any SI energy unit without knowing the specific unit at
 * compile time.
 *
 * For type-safe quantities with a specific unit, use the concrete classes:
 * - Joule::of($number)
 * - Kilojoule::of($number)
 * - Megajoule::of($number)
 *
 * Example:
 * ```php
 * $energy = SIEnergy::of($number, SIEnergyUnit::Joule);
 * $energy = SIEnergy::of($number, SIEnergyUnit::Kilojoule);
 * ```
 */
final class SIEnergy implements SIEnergyInterface, QuantityFactoryInterface, ConvertibleInterface, ComparableInterface, CalculableInterface, AutoScalableInterface
{
    use ConvertibleTrait;
    use ComparableTrait;
    use CalculableTrait;
    use AutoScalableTrait;

    private function __construct(
        private readonly NumberInterface $value,
        private readonly UnitInterface $unit,
    ) {
    }

    /**
     * Create an SI energy with the specified value and unit.
     */
    public static function of(NumberInterface $value, SIEnergyUnit $unit): self
    {
        return new self($value, $unit);
    }

    /**
     * @internal Used by the library for conversions and calculations
     *
     * @throws InvalidUnitException If unit is not an SIEnergyUnit
     */
    public static function from(NumberInterface $value, UnitInterface $unit): self
    {
        if (!$unit instanceof SIEnergyUnit) {
            throw InvalidUnitException::forInvalidUnitType($unit, SIEnergyUnit::class, self::class);
        }

        return new self($value, $unit);
    }

    public function getValue(): NumberInterface
    {
        return $this->value;
    }

    public function getUnit(): UnitInterface
    {
        return $this->unit;
    }
}