root/trunk/lib/form/sfFormReCaptcha.class.php

<?php
/*
 * This file is part of the symfony package.
 * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * sfFormReCatcha is a base form embedding a recaptcha widget and validator, it
 * can also bind submitted parameters directly from the request using the
 * bindFromRequest() method.
 *
 * You must define a private and a public recaptcha key in order to use this
 * form. You can do so passing options to the constructor of the class, eg:
 *
 *     $form = new sfFormReCaptcha(array(), array('recaptcha_public_key'  => '12345',
 *                                                'recaptcha_private_key' => '54321'));
 *
 * You can use symfony environements to configure if you want to use recaptcha
 * for certain environment only
 *
 * @package    symfony
 * @subpackage form
 * @author     Nicolas Perriault <nicolas.perriault@symfony-project.com>
 * @version    SVN: $Id$
 */
class sfFormReCaptcha extends sfForm
{
  /**
   * @see sfForm
   */
  public function __construct($defaults = array(), $options = array(), $CSRFSecret = null)
  {
    parent::__construct($defaults, $options, $CSRFSecret);

    // We setup the captcha now, because the configure() method has just been
    // called in __construct() so we can append the captcha field to the whole form.
    $this->setupCaptcha();
  }

  /**
   * Bind parameters, including the captcha ones, from a sfRequest object instance
   *
   * @param  sfRequest A sfRequest instance
   *
   * @return Boolean   true if the form is valid, false otherwise
   */
  public function bindFromRequest(sfRequest $request)
  {
    $nameFormat = $this->widgetSchema->getNameFormat();

    if ('%s' == $nameFormat)
    {
      throw new LogicException('You must define a name format using setNameFormat() in order to use the bindFromRequest() method');
    }

    $nameFormat = substr($nameFormat, 0, strpos($nameFormat, ('[')));

    $params = $request->getParameter($nameFormat, array());
    if (true === sfConfig::get('app_recaptcha_enabled'))
    {
      $captcha = array(
        'recaptcha_challenge_field' => $request->getParameter('recaptcha_challenge_field'),
        'recaptcha_response_field'  => $request->getParameter('recaptcha_response_field'),
      );
      $params = array_merge($params, array('captcha' => $captcha));
    }

    return parent::bind($params);
  }

  /**
   * Setup captcha for current form
   *
   */
  protected function setupCaptcha()
  {
    if (true === sfConfig::get('app_recaptcha_enabled'))
    {
      $this->widgetSchema['captcha'] = new sfWidgetFormReCaptcha(array('public_key' => sfConfig::get('app_recaptcha_public_key')));
      $this->validatorSchema['captcha'] = new sfValidatorReCaptcha(array('private_key' => sfConfig::get('app_recaptcha_private_key')));
    }
  }
}