vendor/symfony/form/FormError.php line 21

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;
  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 $message;
  28.     private $cause;
  30.     /**
  31.      * The form that spawned this error.
  32.      *
  33.      * @var FormInterface
  34.      */
  35.     private $origin;
  37.     /**
  38.      * Any array key in $messageParameters will be used as a placeholder in
  39.      * $messageTemplate.
  40.      *
  41.      * @param string      $message              The translated error message
  42.      * @param string|null $messageTemplate      The template for the error message
  43.      * @param array       $messageParameters    The parameters that should be
  44.      *                                          substituted in the message template
  45.      * @param int|null    $messagePluralization The value for error message pluralization
  46.      * @param mixed       $cause                The cause of the error
  47.      *
  48.      * @see \Symfony\Component\Translation\Translator
  49.      */
  50.     public function __construct(?string $message, string $messageTemplate = null, array $messageParameters = [], int $messagePluralization = null, $cause = null)
  51.     {
  52.         if (null === $message) {
  53.             @trigger_error(sprintf('Passing a null message when instantiating a "%s" is deprecated since Symfony 4.4.', __CLASS__), \E_USER_DEPRECATED);
  54.             $message = '';
  55.         }
  57.         $this->message = $message;
  58.         $this->messageTemplate = $messageTemplate ?: $message;
  59.         $this->messageParameters = $messageParameters;
  60.         $this->messagePluralization = $messagePluralization;
  61.         $this->cause = $cause;
  62.     }
  64.     /**
  65.      * Returns the error message.
  66.      *
  67.      * @return string
  68.      */
  69.     public function getMessage()
  70.     {
  71.         return $this->message;
  72.     }
  74.     /**
  75.      * Returns the error message template.
  76.      *
  77.      * @return string
  78.      */
  79.     public function getMessageTemplate()
  80.     {
  81.         return $this->messageTemplate;
  82.     }
  84.     /**
  85.      * Returns the parameters to be inserted in the message template.
  86.      *
  87.      * @return array
  88.      */
  89.     public function getMessageParameters()
  90.     {
  91.         return $this->messageParameters;
  92.     }
  94.     /**
  95.      * Returns the value for error message pluralization.
  96.      *
  97.      * @return int|null
  98.      */
  99.     public function getMessagePluralization()
  100.     {
  101.         return $this->messagePluralization;
  102.     }
  104.     /**
  105.      * Returns the cause of this error.
  106.      *
  107.      * @return mixed The cause of this error
  108.      */
  109.     public function getCause()
  110.     {
  111.         return $this->cause;
  112.     }
  114.     /**
  115.      * Sets the form that caused this error.
  116.      *
  117.      * This method must only be called once.
  118.      *
  119.      * @throws BadMethodCallException If the method is called more than once
  120.      */
  121.     public function setOrigin(FormInterface $origin)
  122.     {
  123.         if (null !== $this->origin) {
  124.             throw new BadMethodCallException('setOrigin() must only be called once.');
  125.         }
  127.         $this->origin = $origin;
  128.     }
  130.     /**
  131.      * Returns the form that caused this error.
  132.      *
  133.      * @return FormInterface|null The form that caused this error
  134.      */
  135.     public function getOrigin()
  136.     {
  137.         return $this->origin;
  138.     }
  139. }