ResourceItem.php

<?php

/*
 * This file is part of the Klipper package.
 *
 * (c) François Pluchino <francois.pluchino@klipper.dev>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Klipper\Component\Resource;

use Klipper\Component\Resource\Domain\WrapperInterface;
use Klipper\Component\Resource\Exception\InvalidArgumentException;
use Klipper\Component\Resource\Exception\UnexpectedTypeException;
use Symfony\Component\Form\FormErrorIterator;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\Validator\ConstraintViolationList;
use Symfony\Component\Validator\ConstraintViolationListInterface;

/**
 * Action resource for domain.
 *
 * @author François Pluchino <francois.pluchino@klipper.dev>
 */
class ResourceItem implements ResourceInterface
{
    protected string $status;

    protected object $data;

    protected ConstraintViolationListInterface $errors;

    /**
     * @param FormInterface|object             $data   The data instance or form with data instance
     * @param ConstraintViolationListInterface $errors The list of errors
     */
    public function __construct($data, ?ConstraintViolationListInterface $errors = null)
    {
        $this->validateData($data);

        $this->status = ResourceStatutes::PENDING;
        $this->data = $data;
        $this->errors = $errors ?? new ConstraintViolationList();
    }

    public function setStatus(string $status): void
    {
        $this->status = $status;
    }

    public function getStatus(): string
    {
        return $this->status;
    }

    public function getData()
    {
        return $this->data;
    }

    public function getRealData()
    {
        $data = $this->data instanceof WrapperInterface ? $this->data->getData() : $this->data;

        return $data instanceof FormInterface ? $data->getData() : $data;
    }

    public function getErrors(): ConstraintViolationListInterface
    {
        return $this->errors;
    }

    public function getFormErrors(): FormErrorIterator
    {
        if ($this->data instanceof FormInterface) {
            return $this->data->getErrors(true);
        }

        throw new InvalidArgumentException('The data of resource is not a form instance, used the "getErrors()" method');
    }

    public function isForm(): bool
    {
        return $this->getData() instanceof FormInterface;
    }

    public function isValid(): bool
    {
        $formSuccess = $this->isForm()
            ? 0 === $this->getFormErrors()->count()
            : true;

        return 0 === $this->getErrors()->count() && $formSuccess;
    }

    /**
     * Validate the data.
     *
     * @param mixed $data
     *
     * @throws UnexpectedTypeException When the data or form data is not an instance of object
     */
    protected function validateData($data): void
    {
        $data = $data instanceof WrapperInterface ? $data->getData() : $data;
        $data = $data instanceof FormInterface ? $data->getData() : $data;

        if (!\is_object($data)) {
            throw new UnexpectedTypeException($data, 'object');
        }
    }
}