vendor/symfony/form/FormError.php line 21

  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;
  14. use Symfony\Component\Form\Exception\BadMethodCallException;
  16. /**
  17.  * Wraps errors in forms.
  18.  *
  19.  * @author Bernhard Schussek <bschussek@gmail.com>
  20.  */
  21. class FormError
  22. {
  23.     protected $messageTemplate;
  24.     protected $messageParameters;
  25.     protected $messagePluralization;
  27.     private string $message;
  28.     private mixed $cause;
  30.     /**
  31.      * The form that spawned this error.
  32.      */
  33.     private ?FormInterface $origin = null;
  35.     /**
  36.      * Any array key in $messageParameters will be used as a placeholder in
  37.      * $messageTemplate.
  38.      *
  39.      * @param string      $message              The translated error message
  40.      * @param string|null $messageTemplate      The template for the error message
  41.      * @param array       $messageParameters    The parameters that should be
  42.      *                                          substituted in the message template
  43.      * @param int|null    $messagePluralization The value for error message pluralization
  44.      * @param mixed       $cause                The cause of the error
  45.      *
  46.      * @see \Symfony\Component\Translation\Translator
  47.      */
  48.     public function __construct(string $message, string $messageTemplate = null, array $messageParameters = [], int $messagePluralization = null, mixed $cause = null)
  49.     {
  50.         $this->message = $message;
  51.         $this->messageTemplate = $messageTemplate ?: $message;
  52.         $this->messageParameters = $messageParameters;
  53.         $this->messagePluralization = $messagePluralization;
  54.         $this->cause = $cause;
  55.     }
  57.     /**
  58.      * Returns the error message.
  59.      */
  60.     public function getMessage(): string
  61.     {
  62.         return $this->message;
  63.     }
  65.     /**
  66.      * Returns the error message template.
  67.      */
  68.     public function getMessageTemplate(): string
  69.     {
  70.         return $this->messageTemplate;
  71.     }
  73.     /**
  74.      * Returns the parameters to be inserted in the message template.
  75.      */
  76.     public function getMessageParameters(): array
  77.     {
  78.         return $this->messageParameters;
  79.     }
  81.     /**
  82.      * Returns the value for error message pluralization.
  83.      */
  84.     public function getMessagePluralization(): ?int
  85.     {
  86.         return $this->messagePluralization;
  87.     }
  89.     /**
  90.      * Returns the cause of this error.
  91.      */
  92.     public function getCause(): mixed
  93.     {
  94.         return $this->cause;
  95.     }
  97.     /**
  98.      * Sets the form that caused this error.
  99.      *
  100.      * This method must only be called once.
  101.      *
  102.      * @throws BadMethodCallException If the method is called more than once
  103.      */
  104.     public function setOrigin(FormInterface $origin)
  105.     {
  106.         if (null !== $this->origin) {
  107.             throw new BadMethodCallException('setOrigin() must only be called once.');
  108.         }
  110.         $this->origin = $origin;
  111.     }
  113.     /**
  114.      * Returns the form that caused this error.
  115.      */
  116.     public function getOrigin(): ?FormInterface
  117.     {
  118.         return $this->origin;
  119.     }
  120. }