webservco / framework

src/WebServCo/Framework/AbstractForm.php

<?php

declare(strict_types=1);

namespace WebServCo\Framework;

abstract class AbstractForm extends \WebServCo\Framework\AbstractLibrary
{
    use \WebServCo\Framework\Traits\ExposeLibrariesTrait;

    /**
     * Errors.
     *
     * @var array<string,array<int,string>>
     */
    protected array $errors;

    protected bool $filtered;

    /**
     * Submit fields.
     *
     * @var array<int,string>
     */
    protected array $submitFields;

    protected string $submitField;

    protected bool $valid;

    abstract public function validate(): bool;

    abstract protected function filter(): bool;

    /**
    * @param array<string,string|array<mixed>> $settings
    * @param array<string,bool|int|float|string|null> $defaultData
    * @param array<int,string> $submitFields
    */
    public function __construct(array $settings, array $defaultData = [], array $submitFields = [])
    {
        parent::__construct($settings);

        $this->submitFields = $submitFields;

        /**
         * Set form data
         */
        foreach ($this->setting('meta', []) as $field => $title) {
            $data = $this->isSent()
                ? $this->request()->data($field, null)
                : \WebServCo\Framework\Helpers\ArrayHelper::get($defaultData, $field, null);
            $this->setData($field, $data);
        }

        $this->errors = [];

        $this->filtered = $this->filter();

        $this->valid = false;

        if (!$this->isSent()) {
            return;
        }

        $this->valid = $this->validate();
    }

    final public function clear(): bool
    {
        $this->clearData();
        $this->filtered = false;
        $this->errors = [];
        return true;
    }

    /**
     * @param mixed $key
     * @param mixed $defaultValue
     * @return mixed
     */
    final public function errors($key, $defaultValue = null)
    {
        return \WebServCo\Framework\ArrayStorage::get($this->errors, $key, $defaultValue);
    }

    /**
     * Get all errors.
     *
     * @return array<string,array<int,string>>
     */
    final public function getAllErrors(): array
    {
        return $this->errors;
    }

    /**
    * @return mixed
    */
    final public function getSubmitField()
    {
        if (!$this->isSent() || !$this->submitFields) {

The expression $this->submitFields 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.

            return false;
        }
        return $this->submitField;
    }

    /**
     * @param mixed $key
     * @param mixed $defaultValue
     * @return mixed
     */
    final public function help($key, $defaultValue = null)
    {
        return $this->setting(
            \sprintf('help/%s', $key),
            $defaultValue,
        );
    }

    final public function isSent(): bool
    {
        if ($this->submitFields) {

The expression $this->submitFields 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.

            foreach ($this->submitFields as $field) {
                if (null !== $this->request()->data($field)) {
                    $this->submitField = $field;
                    return true;
                }
            }
            return false;
        }
        return \WebServCo\Framework\Http\Method::POST === $this->request()->getMethod();
    }

    final public function isValid(): bool
    {
        return $this->valid;
    }

    /**
     * @param mixed $key
     * @param mixed $defaultValue
     * @return mixed
     */
    final public function meta($key, $defaultValue = null)
    {
        return $this->setting(
            \sprintf('meta/%s', $key),
            $defaultValue,
        );
    }

    /**
     * @param mixed $key
     */
    final public function required($key): bool
    {
        // Retrieve list of required fields
        $required = $this->setting('required', []);
        // If exists, it's required.
        return \in_array($key, $required, true);
    }

    /**
    * @return array<string, array<mixed>>
    */
    final public function toArray(): array
    {
        return [
            'custom' => $this->setting('custom', []),
            'data' => $this->getData(),
            'errors' => $this->errors,
            'help' => $this->setting('help', []),
            'meta' => $this->setting('meta', []),
            'required' => \array_fill_keys($this->setting('required', []), true),
        ];
    }
}