alex-kalanis / restful

php-src/Http/Input.php

<?php

namespace kalanis\Restful\Http;


use ArrayIterator;
use Exception;
use IteratorAggregate;
use kalanis\Restful\Validation\Error;
use kalanis\Restful\Validation\IDataProvider;
use kalanis\Restful\Validation\IField;
use kalanis\Restful\Validation\IValidationScope;
use kalanis\Restful\Validation\IValidationScopeFactory;
use Nette\MemberAccessException;


/**
 * Request Input parser
 * @package kalanis\Restful\Http
 * @template TK of string
 * @template TVal of mixed
 * @implements IteratorAggregate<TK, TVal>
 */
class Input implements IteratorAggregate, IInput, IDataProvider
{

    private ?IValidationScope $validationScope = null;

    /**
     * @param IValidationScopeFactory $validationScopeFactory
     * @param array<TK, TVal> $data
     */
    public function __construct(
        private readonly IValidationScopeFactory $validationScopeFactory,
        private array                            $data = [],
    )
    {
    }

    /**
     * @param string $name
     * @throws Exception|MemberAccessException
     * @return mixed
     *
     */
    public function &__get(string $name)
    {
        $data = $this->getData();
        if (array_key_exists($name, $data)) {
            return $data[$name];
        }
        throw new MemberAccessException('Cannot read an undeclared property ' . static::class . '::$' . $name . '.');
    }

    /**
     * Get parsed input data
     * @return array<TK, TVal>
     */
    public function getData(): array
    {
        return $this->data;
    }

    /**
     * Set input data
     * @param array<TK, TVal> $data
     * @return $this
     */
    public function setData(array $data): static
    {
        $this->data = $data;
        return $this;
    }

    /**
     * @param string $name
     * @return bool
     */
    public function __isset(string $name)
    {
        $data = $this->getData();
        return array_key_exists($name, $data);
    }

    /**
     * Get input data iterator
     * @return ArrayIterator<TK, TVal>
     */
    public function getIterator(): ArrayIterator
    {
        return new ArrayIterator($this->getData());
    }

    /**
     * Get validation field
     * @param string $name
     * @return IField
     */
    public function field(string $name): IField
    {
        return $this->getValidationScope()->field($name);
    }

    /**
     * Get validation scope
     * @return IValidationScope
     */
    public function getValidationScope(): IValidationScope
    {
        if (empty($this->validationScope)) {
            $this->validationScope = $this->validationScopeFactory->create();
        }
        return $this->validationScope;

The expression return $this->validationScope could return the type null which is incompatible with the type-hinted return kalanis\Restful\Validation\IValidationScope. Consider adding an additional type-check to rule them out.

    }

    /**
     * Is input valid
     * @return bool
     */
    public function isValid(): bool
    {
        return !$this->validate();
    }

    /**
     * Validate input data
     * @return array<Error>
     */
    public function validate(): array
    {
        return $this->getValidationScope()->validate($this->getData());
    }
}