webservco / api

src/WebServCo/Api/AbstractClientRequest.php

<?php

declare(strict_types=1);

namespace WebServCo\Api;

use WebServCo\Api\Exceptions\ApiException;
use WebServCo\Api\JsonApi\Document;
use WebServCo\Framework\Interfaces\RequestInterface;

abstract class AbstractClientRequest
{
    // No double quotes (API clients would add backslashes)
    public const MSG_TPL_INVALID = 'Invalid data: \'%s\'.';
    public const MSG_TPL_MAXIMUM_LENGTH = 'Maximum length exceeded: \'%s\'. Limit: %s';
    public const MSG_TPL_REQUIRED = 'Missing required data: \'%s\'.';

    protected bool $allowMultipleDataObjects;
    protected RequestInterface $request;
    protected bool $processRequestData;

    /**
    * Request data.
    *
    * @var array<mixed>
    */
    protected array $requestData;

    public function __construct(RequestInterface $request)
    {
        $this->allowMultipleDataObjects = false;
        $this->request = $request;
        $requestMethod = $this->request->getMethod();

        if (\WebServCo\Framework\Http\Method::POST !== $requestMethod) {
            return;
        }
        $this->processRequestData = true;
        $requestBody = $this->request->getBody();
        if (!$requestBody) { // No problem if misisng, set to empty array.
            $this->requestData = [];
        } else {
            // If not missing, it needs to be valid.
            try {
                /**
                * @throws \JsonException
                */
                $requestData = \json_decode(
                    $requestBody,
                    true, // associative
                    512, // depth
                    \JSON_THROW_ON_ERROR, // flags
                );
                if (!\is_array($requestData)) {
                    throw new \InvalidArgumentException('Invalid root object.');
                }
                $this->requestData = $requestData;
            } catch (\Throwable $e) { // including \JsonException
                $this->throwInvalidException('root object');
            }
        }
    }

    protected function throwInvalidException(string $item): void
    {
        throw new ApiException(\sprintf(self::MSG_TPL_INVALID, $item));
    }

    protected function throwMaximumLengthException(string $item, int $maximumLength): void
    {
        throw new ApiException(\sprintf(self::MSG_TPL_MAXIMUM_LENGTH, $item, $maximumLength));
    }

    protected function throwRequiredException(string $item): void
    {
        throw new ApiException(\sprintf(self::MSG_TPL_REQUIRED, $item));
    }

    protected function verify(): bool
    {
        $this->verifyContentType();
        if ($this->processRequestData) {
            $this->verifyRequestData();
        }
        return true;
    }

    protected function verifyContentType(): bool
    {
        $contentType = $this->request->getContentType();
        $parts = \explode(';', (string) $contentType);
        if (Document::CONTENT_TYPE !== $parts[0]) {
            throw new \WebServCo\Framework\Exceptions\UnsupportedMediaTypeException(
                \sprintf('Unsupported request content type: %s.', (string) $contentType),
            );
        }
        return true;
    }

    protected function verifyRequestData(): bool
    {
        if (!\is_array($this->requestData)) {

The condition is_array($this->requestData) is always true.

            $this->throwInvalidException('root object');
        }
        if (!$this->requestData) { // check if empty array, could also mean the json vas invalid

The expression $this->requestData of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            $this->throwRequiredException('root object');
        }
        foreach (['jsonapi', 'data'] as $item) {
            if (isset($this->requestData[$item])) {
                continue;
            }

            $this->throwRequiredException($item);
        }
        if (!isset($this->requestData['jsonapi']['version'])) {
            $this->throwRequiredException('jsonapi.version');
        }
        if (Document::VERSION !== $this->requestData['jsonapi']['version']) {
            throw new ApiException(
                \sprintf('Unsupported JSON API version: %s', $this->requestData['jsonapi']['version']),
            );
        }
        if (!\is_array($this->requestData['data'])) {
            $this->throwInvalidException('data');
        }
        $key = \key($this->requestData['data']);
        if (0 === $key) { //multiple data objects
            if (!$this->allowMultipleDataObjects) {
                throw new ApiException('Multiple data objects not allowed for this endpoint');
            }
            foreach ($this->requestData['data'] as $item) {
                $this->verifyData($item);
            }
        } else { // single data object
            $this->verifyData($this->requestData['data']);
        }
        $this->verifyMeta();

        return true;
    }

    /**
    * @param array<string,mixed> $data
    */
    protected function verifyData(array $data): bool
    {
        foreach (['type', 'attributes'] as $item) {
            if (isset($data[$item])) {
                continue;
            }

            $this->throwRequiredException(\sprintf('data.%s', $item));
        }
        if (empty($data['type'])) {
            $this->throwRequiredException('data.type');
        }
        if (!\is_array($data['attributes'])) {
            $this->throwInvalidException('data.attributes');
        }

        return true;
    }

    protected function verifyMeta(): bool
    {
        if (isset($this->requestData['meta'])) { // meta is optional
            if (!\is_array($this->requestData['meta'])) {
                $this->throwInvalidException('meta');
            }
        }
        return true;
    }
}