<?php

/*
 * This file is part of the symfony package.
 * (c) 2004-2006 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.
 */

/**
 * sfCallbackValidator allows you to use a custom callback function or method to
 * validate the input. The function should return true on valid and false on invalid
 * and should be callable using is_callable().
 *
 * <b>Required parameters:</b>
 *
 * # <b>callback</b> - [none] - A valid callback function or Class::method array.
 * When using class/method specify it as an array in yml file as [class, method]
 *
 * <b>Optional parameters:</b>
 *
 * # <b>invalid_error</b> - [Invalid input] - An error message to use when the
 *                                          input fails the callback check
 *
 * WARNING: This class is deprecated and will be removed in symfony 1.2.
 *
 * @package    symfony
 * @subpackage validator
 * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
 * @version    SVN: $Id: sfCallbackValidator.class.php 10270 2008-07-13 21:51:03Z Carl.Vondrick $
 * @deprecated Deprecated since symfony 1.1
 */
class sfCallbackValidator extends sfValidator
{
  /**
   * Executes this validator.
   *
   * @param string A parameter value
   * @param string An error message reference
   *
   * @return boolean true, if this validator executes successfully, otherwise false
   */
  public function execute(&$value, &$error)
  {
    $callback = $this->getParameterHolder()->get('callback');

    if (!call_user_func($callback, $value))
    {
      $error = $this->getParameterHolder()->get('invalid_error');

      return false;
    }

    return true;
  }

  /**
   * Initializes this validator.
   *
   * @param sfContext The current application context
   * @param array   An associative array of initialization parameters
   *
   * @return boolean true, if initialization completes successfully, otherwise false
   */
  public function initialize($context, $parameters = null)
  {
    // initialize parent
    parent::initialize($context);

    // set defaults
    $this->getParameterHolder()->set('callback', null);
    $this->getParameterHolder()->set('invalid_error', 'Invalid input');

    $this->getParameterHolder()->add($parameters);

    // check parameters
    if (!is_callable($this->getParameterHolder()->get('callback')))
    {
      // no pattern specified
      throw new sfValidatorException('Callback function must be a valid callback using is_callable().');
    }

    return true;
  }
}
