1. sfTesterForm.class.php
  2. /**
 * sfTesterForm implements tests for forms submitted by the user.
 *
 * @package    symfony
 * @subpackage test
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfTesterForm.class.php 24217 2009-11-22 06:47:54Z fabien $
 */
  3. class sfTesterForm extends sfTester
  4. {
  5.   protected
  6.     $form = null;
  8.   /**
  9.    * Constructor.
  10.    *
  11.    * @param sfTestFunctionalBase $browser A browser
  12.    * @param lime_test            $tester  A tester object
  13.    */
  14.   public function __construct(sfTestFunctionalBase $browser, $tester)
  15.   {
  16.     parent::__construct($browser, $tester);
  18.     $this->browser->addListener('template.filter_parameters', array($this, 'filterTemplateParameters'));
  19.   }
  21.   /**
  22.    * Prepares the tester.
  23.    */
  24.   public function prepare()
  25.   {
  26.     $this->form = null;
  27.   }
  29.   /**
  30.    * Initiliazes the tester.
  31.    */
  32.   public function initialize()
  33.   {
  34.     if (null === $this->form)
  35.     {
  36.       $action = $this->browser->getContext()->getActionStack()->getLastEntry()->getActionInstance();
  38.       foreach ($action->getVarHolder()->getAll() as $name => $value)
  39.       {
  40.         if ($value instanceof sfForm && $value->isBound())
  41.         {
  42.           $this->form = $value;
  43.           break;
  44.         }
  45.       }
  46.     }
  47.   }
  49.   /**
  50.    * Returns the current form.
  51.    *
  52.    * @return sfForm The current sfForm form instance
  53.    */
  54.   public function getForm()
  55.   {
  56.     return $this->form;
  57.   }
  59.   /**
  60.    * Tests if the submitted form has some error.
  61.    *
  62.    * @param  Boolean|integer $value Whether to check if the form has error or not, or the number of errors
  63.    *
  64.    * @return sfTestFunctionalBase|sfTester
  65.    */
  66.   public function hasErrors($value = true)
  67.   {
  68.     if (null === $this->form)
  69.     {
  70.       throw new LogicException('no form has been submitted.');
  71.     }
  73.     if (is_int($value))
  74.     {
  75.       $this->tester->is(count($this->form->getErrorSchema()), $value, sprintf('the submitted form has "%s" errors.', $value));
  76.     }
  77.     else
  78.     {
  79.       $this->tester->is($this->form->hasErrors(), $value, sprintf('the submitted form %s.', ($value) ? 'has some errors' : 'is valid'));
  80.     }
  82.     return $this->getObjectToReturn();
  83.   }
  85.   /**
  86.    * Tests if the submitted form has a specific error.
  87.    *
  88.    * @param mixed $value The error message or the number of errors for the field (optional)
  89.    *
  90.    * @return sfTestFunctionalBase|sfTester
  91.    */
  92.   public function hasGlobalError($value = true)
  93.   {
  94.     return $this->isError(null, $value);
  95.   }
  97.   /**
  98.    * Tests if the submitted form has a specific error.
  99.    *
  100.    * @param string $field The field name to check for an error (null for global errors)
  101.    * @param mixed  $value The error message or the number of errors for the field (optional)
  102.    *
  103.    * @return sfTestFunctionalBase|sfTester
  104.    */
  105.   public function isError($field, $value = true)
  106.   {
  107.     if (null === $this->form)
  108.     {
  109.       throw new LogicException('no form has been submitted.');
  110.     }
  112.     if (null === $field)
  113.     {
  114.       $error = new sfValidatorErrorSchema(new sfValidatorPass(), $this->form->getGlobalErrors());
  115.     }
  116.     else
  117.     {
  118.       $error = $this->getFormField($field)->getError();
  119.     }
  121.     if (false === $value)
  122.     {
  123.       $this->tester->ok(!$error || 0 == count($error), sprintf('the submitted form has no "%s" error.', $field));
  124.     }
  125.     else if (true === $value)
  126.     {
  127.       $this->tester->ok($error && count($error) > 0, sprintf('the submitted form has a "%s" error.', $field));
  128.     }
  129.     else if (is_int($value))
  130.     {
  131.       $this->tester->ok($error && count($error) == $value, sprintf('the submitted form has %s "%s" error(s).', $value, $field));
  132.     }
  133.     else if (preg_match('/^(!)?([^a-zA-Z0-9\\\\]).+?\\2[ims]?$/', $value, $match))
  134.     {
  135.       if (!$error)
  136.       {
  137.         $this->tester->fail(sprintf('the submitted form has a "%s" error.', $field));
  138.       }
  139.       else
  140.       {
  141.         if ($match[1] == '!')
  142.         {
  143.           $this->tester->unlike($error->getCode(), substr($value, 1), sprintf('the submitted form has a "%s" error that does not match "%s".', $field, $value));
  144.         }
  145.         else
  146.         {
  147.           $this->tester->like($error->getCode(), $value, sprintf('the submitted form has a "%s" error that matches "%s".', $field, $value));
  148.         }
  149.       }
  150.     }
  151.     else
  152.     {
  153.       if (!$error)
  154.       {
  155.         $this->tester->fail(sprintf('the submitted form has a "%s" error (%s).', $field, $value));
  156.       }
  157.       else
  158.       {
  159.         $this->tester->is($error->getCode(), $value, sprintf('the submitted form has a "%s" error (%s).', $field, $value));
  160.       }
  161.     }
  163.     return $this->getObjectToReturn();
  164.   }
  166.   /**
  167.    * Outputs some debug information about the current submitted form.
  168.    */
  169.   public function debug()
  170.   {
  171.     if (null === $this->form)
  172.     {
  173.       throw new LogicException('no form has been submitted.');
  174.     }
  176.     print $this->tester->error('Form debug');
  178.     print sprintf("Submitted values: %s\n", str_replace("\n", '', var_export($this->form->getTaintedValues(), true)));
  179.     print sprintf("Errors: %s\n", $this->form->getErrorSchema());
  181.     exit(1);
  182.   }
  184.   /**
  185.    * Listens to the template.filter_parameters event to get the submitted form object.
  186.    *
  187.    * @param sfEvent $event      The event
  188.    * @param array   $parameters An array of parameters passed to the template
  189.    *
  190.    * @return array The array of parameters passed to the template
  191.    */
  192.   public function filterTemplateParameters(sfEvent $event, $parameters)
  193.   {
  194.     if (!isset($parameters['sf_type']))
  195.     {
  196.       return $parameters;
  197.     }
  199.     if ('action' == $parameters['sf_type'])
  200.     {
  201.       foreach ($parameters as $key => $value)
  202.       {
  203.         if ($value instanceof sfForm && $value->isBound())
  204.         {
  205.           $this->form = $value;
  206.           break;
  207.         }
  208.       }
  209.     }
  211.     return $parameters;
  212.   }
  214.   /**
  215.    * @param string $path
  216.    * @return sfFormField
  217.    */
  219.   public function getFormField($path)
  220.   {
  221.     if (false !== $pos = strpos($path, '['))
  222.     {
  223.       $field = $this->form[substr($path, 0, $pos)];
  224.     }
  225.     else
  226.     {
  227.       return $this->form[$path];
  228.     }
  230.     if (preg_match_all('/\[(?P<part>[^]]+)\]/', $path, $matches))
  231.     {
  232.       foreach($matches['part'] as $part)
  233.       {
  234.         $field = $field[$part];
  235.       }
  236.     }
  238.     return $field;
  239.   }
  240. }
Debug toolbar