Permalink
Fetching contributors…
Cannot retrieve contributors at this time
191 lines (170 sloc) 4.49 KB
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Form;
use Symfony\Component\Form\Exception\BadMethodCallException;
/**
* Wraps errors in forms.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class FormError implements \Serializable
{
/**
* @var string
*/
private $message;
/**
* The template for the error message.
*
* @var string
*/
protected $messageTemplate;
/**
* The parameters that should be substituted in the message template.
*
* @var array
*/
protected $messageParameters;
/**
* The value for error message pluralization.
*
* @var int|null
*/
protected $messagePluralization;
/**
* The cause for this error.
*
* @var mixed
*/
private $cause;
/**
* The form that spawned this error.
*
* @var FormInterface
*/
private $origin;
/**
* Constructor.
*
* Any array key in $messageParameters will be used as a placeholder in
* $messageTemplate.
*
* @param string $message The translated error message
* @param string|null $messageTemplate The template for the error message
* @param array $messageParameters The parameters that should be
* substituted in the message template
* @param int|null $messagePluralization The value for error message pluralization
* @param mixed $cause The cause of the error
*
* @see \Symfony\Component\Translation\Translator
*/
public function __construct($message, $messageTemplate = null, array $messageParameters = array(), $messagePluralization = null, $cause = null)
{
$this->message = $message;
$this->messageTemplate = $messageTemplate ?: $message;
$this->messageParameters = $messageParameters;
$this->messagePluralization = $messagePluralization;
$this->cause = $cause;
}
/**
* Returns the error message.
*
* @return string
*/
public function getMessage()
{
return $this->message;
}
/**
* Returns the error message template.
*
* @return string
*/
public function getMessageTemplate()
{
return $this->messageTemplate;
}
/**
* Returns the parameters to be inserted in the message template.
*
* @return array
*/
public function getMessageParameters()
{
return $this->messageParameters;
}
/**
* Returns the value for error message pluralization.
*
* @return int|null
*/
public function getMessagePluralization()
{
return $this->messagePluralization;
}
/**
* Returns the cause of this error.
*
* @return mixed The cause of this error
*/
public function getCause()
{
return $this->cause;
}
/**
* Sets the form that caused this error.
*
* This method must only be called once.
*
* @param FormInterface $origin The form that caused this error
*
* @throws BadMethodCallException If the method is called more than once
*/
public function setOrigin(FormInterface $origin)
{
if (null !== $this->origin) {
throw new BadMethodCallException('setOrigin() must only be called once.');
}
$this->origin = $origin;
}
/**
* Returns the form that caused this error.
*
* @return FormInterface The form that caused this error
*/
public function getOrigin()
{
return $this->origin;
}
/**
* Serializes this error.
*
* @return string The serialized error
*/
public function serialize()
{
return serialize(array(
$this->message,
$this->messageTemplate,
$this->messageParameters,
$this->messagePluralization,
$this->cause,
));
}
/**
* Unserializes a serialized error.
*
* @param string $serialized The serialized error
*/
public function unserialize($serialized)
{
list($this->message, $this->messageTemplate, $this->messageParameters, $this->messagePluralization, $this->cause) = unserialize($serialized, array('allowed_classes' => false));
}
}