TransformerError.php

<?php

namespace Bdf\Form\Attribute\Element;

use Attribute;
use Bdf\Form\AbstractElementBuilder;
use Bdf\Form\Attribute\AttributeForm;
use Bdf\Form\Attribute\ChildBuilderAttributeInterface;
use Bdf\Form\Attribute\Processor\CodeGenerator\AttributesProcessorGenerator;
use Bdf\Form\Attribute\Processor\GenerateConfiguratorStrategy;
use Bdf\Form\Child\ChildBuilderInterface;
use Bdf\Form\Transformer\TransformerInterface;

/**
 * Fine grain configure error triggered by transformers
 *
 * This attribute is equivalent to call :
 * <code>
 * $builder->string('foo')
 *     ->transformerErrorMessage('Foo is in invalid format')
 *     ->transformerErrorCode('FOO_FORMAT_ERROR')
 *     ->transformerExceptionValidation([$this, 'fooTransformerExceptionValidation'])
 * ;
 * </code>
 *
 * Usage:
 * <code>
 * class MyForm extends AttributeForm
 * {
 *     #[MyTransformer, TransformerError(message: 'Foo is in invalid format', code: 'FOO_FORMAT_ERROR')]
 *     private StringElement $foo;
 * }
 * </code>
 *
 * @see ValidatorBuilderTrait::transformerErrorMessage() The called method when message parameter is provided
 * @see ValidatorBuilderTrait::transformerErrorCode() The called method when code parameter is provided
 * @see ValidatorBuilderTrait::transformerExceptionValidation() The called method when validationCallback parameter is provided
 *
 * @implements ChildBuilderAttributeInterface<AbstractElementBuilder>
 *
 * @api
 */
#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
class TransformerError implements ChildBuilderAttributeInterface
{
    public function __construct(
        /**
         * The error message to show when transformer fail
         *
         * @readonly
         */
        private ?string $message = null,
        /**
         * The error code to provide when transformer fail
         *
         * @readonly
         */
        private ?string $code = null,
        /**
         * Method name to use for validate the transformer exception
         *
         * This method must be public and declared on the form class, and follow the prototype :
         * `public function ($value, TransformerExceptionConstraint $constraint, ElementInterface $element): bool`
         *
         * If the method return false, the exception will be ignored
         * Else, the method should fill `TransformerExceptionConstraint` with error message and code to provide the custom error
         *
         * @var literal-string|null
         * @readonly
         */
        private ?string $validationCallback = null,
    ) {
    }

    /**
     * {@inheritdoc}
     */
    public function applyOnChildBuilder(AttributeForm $form, ChildBuilderInterface $builder): void
    {
        if ($this->message !== null) {
            $builder->transformerErrorMessage($this->message);
        }

        if ($this->code !== null) {
            $builder->transformerErrorCode($this->code);
        }

        if ($this->validationCallback !== null) {
            $builder->transformerExceptionValidation([$form, $this->validationCallback]);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function generateCodeForChildBuilder(string $name, AttributesProcessorGenerator $generator, AttributeForm $form): void
    {
        $generator->line('$?', [$name]);

        if ($this->message !== null) {
            $generator->line('    ->transformerErrorMessage(?)', [$this->message]);
        }

        if ($this->code !== null) {
            $generator->line('    ->transformerErrorCode(?)', [$this->code]);
        }

        if ($this->validationCallback !== null) {
            $generator->line('    ->transformerExceptionValidation([$form, ?])', [$this->validationCallback]);
        }

        $generator->line(';');
    }
}