<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Validate

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Callback.php 22668 2010-07-25 14:50:46Z thomas $

 */

/**

 * @see Zend_Validate_Abstract

 */

require_once 'Zend/Validate/Abstract.php';

/**

 * @category   Zend

 * @package    Zend_Validate

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Validate_Callback extends Zend_Validate_Abstract

{

    /**

     * Invalid callback

     */

    const INVALID_CALLBACK = 'callbackInvalid';

    /**

     * Invalid value

     */

    const INVALID_VALUE = 'callbackValue';

    /**

     * Validation failure message template definitions

     *

     * @var array

     */

    protected $_messageTemplates = array(

        self::INVALID_VALUE    => "'%value%' is not valid",

        self::INVALID_CALLBACK => "An exception has been raised within the callback",

    );

    /**

     * Callback in a call_user_func format

     *

     * @var string|array

     */

    protected $_callback = null;

    /**

     * Default options to set for the filter

     *

     * @var mixed

     */

    protected $_options = array();

    /**

     * Sets validator options

     *

     * @param  string|array $callback

     * @param  mixed   $max

     * @param  boolean $inclusive

     * @return void

     */

    public function __construct($callback = null)

    {

        if (is_callable($callback)) {

            $this->setCallback($callback);

        } elseif (is_array($callback)) {

            if (isset($callback['callback'])) {

                $this->setCallback($callback['callback']);

            }

            if (isset($callback['options'])) {

                $this->setOptions($callback['options']);

            }

        }

        if (null === ($initializedCallack = $this->getCallback())) {

            require_once 'Zend/Validate/Exception.php';

            throw new Zend_Validate_Exception('No callback registered');

        }

    }

    /**

     * Returns the set callback

     *

     * @return mixed

     */

    public function getCallback()

    {

        return $this->_callback;

    }

    /**

     * Sets the callback

     *

     * @param  string|array $callback

     * @return Zend_Validate_Callback Provides a fluent interface

     */

    public function setCallback($callback)

    {

        if (!is_callable($callback)) {

            require_once 'Zend/Validate/Exception.php';

            throw new Zend_Validate_Exception('Invalid callback given');

        }

        $this->_callback = $callback;

        return $this;

    }

    /**

     * Returns the set options for the callback

     *

     * @return mixed

     */

    public function getOptions()

    {

        return $this->_options;

    }

    /**

     * Sets options for the callback

     *

     * @param  mixed $max

     * @return Zend_Validate_Callback Provides a fluent interface

     */

    public function setOptions($options)

    {

        $this->_options = (array) $options;

        return $this;

    }

    /**

     * Defined by Zend_Validate_Interface

     *

     * Returns true if and only if the set callback returns

     * for the provided $value

     *

     * @param  mixed $value

     * @return boolean

     */

    public function isValid($value)

    {

        $this->_setValue($value);

        $options  = $this->getOptions();

        $callback = $this->getCallback();

        $args     = func_get_args();

        $options  = array_merge($args, $options);

        try {

            if (!call_user_func_array($callback, $options)) {

                $this->_error(self::INVALID_VALUE);

                return false;

            }

        } catch (Exception $e) {

            $this->_error(self::INVALID_CALLBACK);

            return false;

        }

        return true;

    }

}