cerbero90 / lazy-json-pages

src/Concerns/ResolvesPages.php

<?php

declare(strict_types=1);

namespace Cerbero\LazyJsonPages\Concerns;

use Cerbero\JsonParser\Concerns\DetectsEndpoints;
use Cerbero\LazyJsonPages\Exceptions\InvalidPageInPathException;
use GuzzleHttp\Psr7\Uri;
use Psr\Http\Message\UriInterface;

/**
 * The trait to resolve pages.
 */
trait ResolvesPages
{
    use DetectsEndpoints;

    /**
     * Retrieve the page out of the given value.
     *
     * @return ($onlyNumerics is true ? int|null : string|int|null)

The doc comment ($onlyNumerics at position 1 could not be parsed: Unknown type name '$onlyNumerics' at position 1 in ($onlyNumerics.

     */
    protected function toPage(mixed $value, bool $onlyNumerics = true): string|int|null
    {
        return match (true) {
            is_numeric($value) => (int) $value,
            !is_string($value) || $value === '' => null,
            !$this->isEndpoint($value) => $onlyNumerics ? null : $value,
            default => $this->pageFromParsedUri(parse_url($value), $onlyNumerics), /** @phpstan-ignore-line */
        };
    }

    /**
     * Retrieve the page from the given parsed URI.
     *
     * @param array{path?: string, query?: string} $parsedUri
     * @return ($onlyNumerics is true ? int|null : string|int|null)

The doc comment ($onlyNumerics at position 1 could not be parsed: Unknown type name '$onlyNumerics' at position 1 in ($onlyNumerics.

     */
    protected function pageFromParsedUri(array $parsedUri, bool $onlyNumerics = true): string|int|null
    {
        if ($pattern = $this->config->pageInPath) {
            preg_match($pattern, $parsedUri['path'] ?? '', $matches);

            return $this->toPage($matches[1] ?? null, $onlyNumerics);
        }

        parse_str($parsedUri['query'] ?? '', $parameters);

        return $this->toPage($parameters[$this->config->pageName] ?? null, $onlyNumerics);
    }

    /**
     * Retrieve the URI for the given page.
     */
    protected function uriForPage(UriInterface $uri, string $page): UriInterface
    {
        if ($key = $this->config->offsetKey) {
            $value = (intval($page) - $this->config->firstPage) * $this->itemsPerPage;

            return Uri::withQueryValue($uri, $key, strval($value));
        }

        if (!$pattern = $this->config->pageInPath) {
            return Uri::withQueryValue($uri, $this->config->pageName, $page);
        }

        if (!preg_match($pattern, $path = $uri->getPath(), $matches, PREG_OFFSET_CAPTURE)) {
            throw new InvalidPageInPathException($path, $pattern);
        }

        return $uri->withPath(substr_replace($path, $page, (int) $matches[1][1], strlen($matches[1][0])));

It seems like substr_replace($path, $page, (int)$matches[1][1], strlen($matches[1][0])) can also be of type array; however, parameter $path of Psr\Http\Message\UriInterface::withPath() does only seem to accept string, maybe add an additional type check?

    }
}