vendor/symfony/form/Extension/Core/DataTransformer/BooleanToStringTransformer.php line 80

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Form\Extension\Core\DataTransformer;
  14. use Symfony\Component\Form\DataTransformerInterface;
  15. use Symfony\Component\Form\Exception\InvalidArgumentException;
  16. use Symfony\Component\Form\Exception\TransformationFailedException;
  18. /**
  19.  * Transforms between a Boolean and a string.
  20.  *
  21.  * @author Bernhard Schussek <bschussek@gmail.com>
  22.  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
  23.  */
  24. class BooleanToStringTransformer implements DataTransformerInterface
  25. {
  26.     private $trueValue;
  28.     private $falseValues;
  30.     /**
  31.      * @param string $trueValue The value emitted upon transform if the input is true
  32.      */
  33.     public function __construct(string $trueValue, array $falseValues = [null])
  34.     {
  35.         $this->trueValue = $trueValue;
  36.         $this->falseValues = $falseValues;
  37.         if (\in_array($this->trueValue, $this->falseValues, true)) {
  38.             throw new InvalidArgumentException('The specified "true" value is contained in the false-values');
  39.         }
  40.     }
  42.     /**
  43.      * Transforms a Boolean into a string.
  44.      *
  45.      * @param bool $value Boolean value
  46.      *
  47.      * @return string|null String value
  48.      *
  49.      * @throws TransformationFailedException if the given value is not a Boolean
  50.      */
  51.     public function transform($value)
  52.     {
  53.         if (null === $value) {
  54.             return null;
  55.         }
  57.         if (!\is_bool($value)) {
  58.             throw new TransformationFailedException('Expected a Boolean.');
  59.         }
  61.         return $value ? $this->trueValue : null;
  62.     }
  64.     /**
  65.      * Transforms a string into a Boolean.
  66.      *
  67.      * @param string $value String value
  68.      *
  69.      * @return bool Boolean value
  70.      *
  71.      * @throws TransformationFailedException if the given value is not a string
  72.      */
  73.     public function reverseTransform($value)
  74.     {
  75.         if (\in_array($value, $this->falseValues, true)) {
  76.             return false;
  77.         }
  79.         if (!\is_string($value)) {
  80.             throw new TransformationFailedException('Expected a string.');
  81.         }
  83.         return true;
  84.     }
  85. }