BooleanToValueTransformer.php

<?php

/**
 * Copyright (c) 2017 DarkWeb Design.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

declare(strict_types=1);

namespace DarkWebDesign\SymfonyAddonTransformers;

use Symfony\Component\Form\DataTransformerInterface;
use Symfony\Component\Form\Exception\TransformationFailedException;

/**
 * @template R of string|int|float|bool
 *
 * @template-implements DataTransformerInterface<bool, R>
 *
 * @author Raymond Schouten
 *
 * @since 2.3
 */
class BooleanToValueTransformer implements DataTransformerInterface
{
    public function __construct(
        /** @var R */
        private readonly string|int|float|bool $trueValue = true,
        /** @var R */
        private readonly string|int|float|bool $falseValue = false,
    ) {
    }

    /**
     * @param bool|null $value
     *
     * @returns R|null
     *
     * @throws TransformationFailedException
     */
    public function transform(mixed $value): string|int|float|bool|null
    {
        if (null === $value) {
            return null;
        }

        if (!is_bool($value)) {
            throw new TransformationFailedException('Expected a boolean.');
        }

        return $value ? $this->trueValue : $this->falseValue;
    }

    /**
     * @param R|null $value
     *
     * @returns bool|null
     *
     * @throws TransformationFailedException
     */
    public function reverseTransform(mixed $value): ?bool
    {
        if (null === $value || '' === $value) {
            return null;
        }

        if (!is_scalar($value)) {
            throw new TransformationFailedException('Expected a scalar.');
        }

        if (!($value === $this->trueValue || $value === $this->falseValue)) {
            throw new TransformationFailedException('Expected true/false boolean value.');
        }

        return $value === $this->trueValue;
    }
}