inspirum / balikobot-php

src/Model/BasePerCarrierCollection.php

<?php

declare(strict_types=1);

namespace Inspirum\Balikobot\Model;

use Inspirum\Arrayable\BaseListCollection;
use InvalidArgumentException;
use RuntimeException;
use function array_map;
use function sprintf;

/**
 * @template TItemKey of array-key
 * @template TItemValue
 * @template TValue of \Inspirum\Arrayable\Arrayable<TItemKey,TItemValue>&\Inspirum\Balikobot\Model\WithCarrierId
 * @extends \Inspirum\Arrayable\BaseListCollection<TItemKey,TItemValue,TValue>
 * @implements \Inspirum\Balikobot\Model\PerCarrierCollection<TValue>
 */
abstract class BasePerCarrierCollection extends BaseListCollection implements PerCarrierCollection
{
    /**
     * @param list<TValue> $items

The type Inspirum\Balikobot\Model\list was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function __construct(
        private ?string $carrier = null,
        array $items = [],
    ) {
        parent::__construct();

        foreach ($items as $key => $value) {
            $this->offsetSet($key, $value);
        }
    }

    /**
     * @throws \RuntimeException
     */
    public function getCarrier(): string
    {
        return $this->carrier ?? throw new RuntimeException('Collection is empty');
    }

    /**
     * @param TValue $item

The type Inspirum\Balikobot\Model\TValue was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws \InvalidArgumentException
     */
    public function add(WithCarrierId $item): void
    {
        $this->offsetAdd($item);
    }

    /**
     * @param non-negative-int $key

The doc comment non-negative-int at position 0 could not be parsed: Unknown type name 'non-negative-int' at position 0 in non-negative-int.

     * @param TValue $value
     */
    public function offsetSet(mixed $key, mixed $value): void
    {
        $this->validateCarrier($value);

        parent::offsetSet($key, $value);
    }

    /**
     * @param TValue $value
     */
    public function offsetAdd(mixed $value): void
    {
        $this->validateCarrier($value);

        parent::offsetAdd($value);
    }

    /**
     * @return TValue|null
     */
    public function getForCarrierId(string $carrierId): ?WithCarrierId
    {
        return $this->first(static fn (WithCarrierId $item) => $item->getCarrierId() === $carrierId);

The expression return $this->first(function(...) { /* ... */ }) also could return the type Inspirum\Balikobot\Model\WithCarrierId which is incompatible with the documented return type Inspirum\Balikobot\Model\TValue|null.

    }

    /**
     * @param callable(TValue): bool $filter
     *
     * @return TValue|null
     */
    protected function first(callable $filter): ?WithCarrierId
    {
        foreach ($this->items as $package) {
            if ($filter($package)) {
                return $package;
            }
        }

        return null;
    }

    /** @inheritDoc */
    public function getCarrierIds(): array
    {
        return array_map(static fn (WithCarrierId $item) => $item->getCarrierId(), $this->getItems());
    }

    /**
     * @throws \InvalidArgumentException
     */
    private function validateCarrier(WithCarrierId $item): void
    {
        if ($this->carrier === null) {
            $this->carrier = $item->getCarrier();

            return;
        }

        if ($this->carrier !== $item->getCarrier()) {
            throw new InvalidArgumentException(
                sprintf(
                    'Item carrier mismatch ("%s" instead "%s")',
                    $item->getCarrier(),
                    $this->carrier,
                ),
            );
        }
    }
}