1. sfValidatorError.class.php
  2. /**
 * sfValidatorError represents a validation error.
 *
 * @package    symfony
 * @subpackage validator
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfValidatorError.class.php 15393 2009-02-10 12:58:49Z fabien $
 */
  3. class sfValidatorError extends Exception implements Serializable
  4. {
  5.   protected
  6.     $validator = null,
  7.     $arguments = array();
  9.   /**
  10.    * Constructor.
  11.    *
  12.    * @param sfValidatorBase $validator  An sfValidatorBase instance
  13.    * @param string          $code       The error code
  14.    * @param array           $arguments  An array of named arguments needed to render the error message
  15.    */
  16.   public function __construct(sfValidatorBase $validator, $code, $arguments = array())
  17.   {
  18.     $this->validator = $validator;
  19.     $this->arguments = $arguments;
  21.     // override default exception message and code
  22.     $this->code = $code;
  24.     if (!$messageFormat = $this->getMessageFormat())
  25.     {
  26.       $messageFormat = $code;
  27.     }
  28.     $this->message = strtr($messageFormat, $this->getArguments());
  29.   }
  31.   /**
  32.    * Returns the string representation of the error.
  33.    *
  34.    * @return string The error message
  35.    */
  36.   public function __toString()
  37.   {
  38.     return $this->getMessage();
  39.   }
  41.   /**
  42.    * Returns the input value that triggered this error.
  43.    *
  44.    * @return mixed The input value
  45.    */
  46.   public function getValue()
  47.   {
  48.     return isset($this->arguments['value']) ? $this->arguments['value'] : null;
  49.   }
  51.   /**
  52.    * Returns the validator that triggered this error.
  53.    *
  54.    * @return sfValidatorBase A sfValidatorBase instance
  55.    */
  56.   public function getValidator()
  57.   {
  58.     return $this->validator;
  59.   }
  61.   /**
  62.    * Returns the arguments needed to format the message.
  63.    *
  64.    * @param bool $raw  false to use it as arguments for the message format, true otherwise (default to false)
  65.    *
  66.    * @see getMessageFormat()
  67.    */
  68.   public function getArguments($raw = false)
  69.   {
  70.     if ($raw)
  71.     {
  72.       return $this->arguments;
  73.     }
  75.     $arguments = array();
  76.     foreach ($this->arguments as $key => $value)
  77.     {
  78.       if (is_array($value))
  79.       {
  80.         continue;
  81.       }
  83.       $arguments["%$key%"] = htmlspecialchars($value, ENT_QUOTES, sfValidatorBase::getCharset());
  84.     }
  86.     return $arguments;
  87.   }
  89.   /**
  90.    * Returns the message format for this error.
  91.    *
  92.    * This is the string you need to use if you need to internationalize
  93.    * error messages:
  94.    *
  95.    * $i18n->__($error->getMessageFormat(), $error->getArguments());
  96.    * 
  97.    * If no message format has been set in the validator, the exception standard
  98.    * message is returned.
  99.    *
  100.    * @return string The message format
  101.    */
  102.   public function getMessageFormat()
  103.   {
  104.     $messageFormat = $this->validator->getMessage($this->code);
  105.     if (!$messageFormat)
  106.     {
  107.       $messageFormat = $this->getMessage();
  108.     }
  110.     return $messageFormat;
  111.   }
  113.   /**
  114.    * Serializes the current instance.
  115.    *
  116.    * We must implement the Serializable interface to overcome a problem with PDO
  117.    * used as a session handler.
  118.    *
  119.    * The default serialization process serializes the exception trace, and because
  120.    * the trace can contain a PDO instance which is not serializable, serializing won't
  121.    * work when using PDO.
  122.    *
  123.    * @return string The instance as a serialized string
  124.    */
  125.   public function serialize()
  126.   {
  127.     return serialize(array($this->validator, $this->arguments, $this->code, $this->message));
  128.   }
  130.   /**
  131.    * Unserializes a sfValidatorError instance.
  132.    *
  133.    * @param string $serialized  A serialized sfValidatorError instance
  134.    *
  135.    */
  136.   public function unserialize($serialized)
  137.   {
  138.     list($this->validator, $this->arguments, $this->code, $this->message) = unserialize($serialized);
  139.   }
  140. }
Debug toolbar