ICanBoogie / CLDR

src/Supplemental/Units/Sequence.php

<?php

namespace ICanBoogie\CLDR\Supplemental\Units;

use ICanBoogie\Accessor\AccessorTrait;

/**
 * Representation of a unit/number sequence.
 *
 * @internal
 *
 * @property-read string $as_long Long string representation.
 * @property-read string $as_short Short string representation.
 * @property-read string $as_narrow Narrow string representation.
 *
 * @link https://unicode.org/reports/tr35/tr35-general.html#Unit_Sequences
 */
final class Sequence
{
    use SequenceCompanion;

    /**
     * @uses get_as_long
     * @uses get_as_short
     * @uses get_as_narrow
     */
    use AccessorTrait;

    /**
     * @var array<string, float|int|numeric-string>

The doc comment array<string, float|int|numeric-string> at position 8 could not be parsed: Unknown type name 'numeric-string' at position 8 in array<string, float|int|numeric-string>.

     */
    private array $sequence = [];

    public function __construct(
        private readonly Units $units
    ) {
    }

    public function __toString(): string
    {
        return $this->format();
    }

    private function get_as_long(): string
    {
        return $this->format(UnitLength::LONG);
    }

    private function get_as_short(): string
    {
        return $this->format(UnitLength::SHORT);
    }

    private function get_as_narrow(): string
    {
        return $this->format(UnitLength::NARROW);
    }

    /**
     * Formats the sequence.
     */
    public function format(UnitLength $length = Units::DEFAULT_LENGTH): string
    {
        return $this->units->format_sequence($this->sequence, $length);
    }
}