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.         $this->message = $message;
  53.         $this->messageTemplate = $messageTemplate ?: $message;
  54.         $this->messageParameters = $messageParameters;
  55.         $this->messagePluralization = $messagePluralization;
  56.         $this->cause = $cause;
  57.     }
  59.     /**
  60.      * Returns the error message.
  61.      *
  62.      * @return string
  63.      */
  64.     public function getMessage()
  65.     {
  66.         return $this->message;
  67.     }
  69.     /**
  70.      * Returns the error message template.
  71.      *
  72.      * @return string
  73.      */
  74.     public function getMessageTemplate()
  75.     {
  76.         return $this->messageTemplate;
  77.     }
  79.     /**
  80.      * Returns the parameters to be inserted in the message template.
  81.      *
  82.      * @return array
  83.      */
  84.     public function getMessageParameters()
  85.     {
  86.         return $this->messageParameters;
  87.     }
  89.     /**
  90.      * Returns the value for error message pluralization.
  91.      *
  92.      * @return int|null
  93.      */
  94.     public function getMessagePluralization()
  95.     {
  96.         return $this->messagePluralization;
  97.     }
  99.     /**
  100.      * Returns the cause of this error.
  101.      *
  102.      * @return mixed
  103.      */
  104.     public function getCause()
  105.     {
  106.         return $this->cause;
  107.     }
  109.     /**
  110.      * Sets the form that caused this error.
  111.      *
  112.      * This method must only be called once.
  113.      *
  114.      * @throws BadMethodCallException If the method is called more than once
  115.      */
  116.     public function setOrigin(FormInterface $origin)
  117.     {
  118.         if (null !== $this->origin) {
  119.             throw new BadMethodCallException('setOrigin() must only be called once.');
  120.         }
  122.         $this->origin = $origin;
  123.     }
  125.     /**
  126.      * Returns the form that caused this error.
  127.      *
  128.      * @return FormInterface|null
  129.      */
  130.     public function getOrigin()
  131.     {
  132.         return $this->origin;
  133.     }
  134. }