Zend Framework: Zend_Validate_Or Component Proposal

Proposed Component Name	Zend_Validate_Or
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Validate_Or
Proposers	Felix De Vliegher
Zend Liaison	TBD
Revision	1.0 - 8 september 2008: Initial Draft. (wiki revision: 6)

This component will accept (an array of) one or more Zend_Validate_Abstract instances in it's constructor and it's addConditionals() method.
This component will throw a Zend_Validate_Exception if isValid() is called and no validators are passed in the constructor or the addConditionals() method.
This component will allow for subclassing, having protected properties and methods.
This component will return true if at least one of the validators that have been set in this validator returns true.
This component will return false and provide the error messages from all failed validators if none of the validators that have been set return true.
This component must extend from Zend_Validate_Abstract.

4. Dependencies on Other Framework Components

Zend_Validate_Abstract
Zend_Exception

5. Theory of Operation

This validator is useful if you want to validate something with the idea that at least one of the validators that have been set in Zend_Validate_Or should return true. So, instead of combining multiple validators with an AND logical operation, you combine the validators with the OR logical operation.

6. Milestones / Tasks

Milestone 1: [DONE] Write proposal
Milestone 2: Community feedback
Milestone 3: Working prototype checked into the incubator supporting use cases #1, #2, ...
Milestone 4: Unit tests exist, work, and are checked into SVN.
Milestone 5: Initial documentation exists.

7. Class Index

Zend_Validate_Or

8. Use Cases

UC-01

Instantiate the class, add some extra validators and validate a value:

// Validate an int OR an ip
$validatorArray = array(
    new Zend_Validate_Int(),
    new Zend_Validate_Ip()
);

$validator = new Zend_Validate_Or();
$validator->addConditionals($validatorArray);

var_dump($validator->isValid(5)); // true
var_dump($validator->isValid('192.168.0.1')); // true
var_dump($validator->isValid('foobar')); // false

UC-02

Add the validator to a form element (setting the validators in the class constructor):

// Validate an int OR an ip
$validatorArray = array(
    new Zend_Validate_Int(),
    new Zend_Validate_Ip()
);

$validator = new Zend_Validate_Or($validatorArray);

$elem = new Zend_Form_Element_Text('foo');
$elem->addValidator($validator);

9. Class Skeletons

/**
 * 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-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id:$
 */


/**
 * @see Zend_Validate_Abstract
 */
require_once 'Zend/Validate/Abstract.php';

/**
 * @see Zend_Validate_Exception
 */
require_once 'Zend/Validate/Exception.php';

/**
 * @category   Zend
 * @package    Zend_Validate
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Validate_Or extends Zend_Validate_Abstract
{
    /**
     * Holds objects instanceof Zend_Validate_Abstract
     */
    protected $_validators = array();

    /**
     * Sets the validators that you want to validate
     *
     * @return void
     */
    public function __construct()
    {
        $this->addConditionals(func_get_args());
    }

    /**
     * Sets the arguments provided by the class constructor
     *
     * Optionally, you can leave the class constructor empty
     * and set them explicitly here.
     *
     * @param array $args
     * @return boolean
     */
    public function addConditionals($args)
    {
        if(! is_array($args)) {
            return false;
        }

        if(! count($args)) {
            return false;
        }

        foreach($args as $arg) {
            if($arg instanceof Zend_Validate_Abstract) {
                $this->_validators[] = $arg;
            } elseif(is_array($arg)) {
                $this->addConditionals($arg);
            } else {
                throw new Zend_Validate_Exception(
                    sprintf("Input needs to be an array or instance of Zend_Validate_Abstract, but is %s",
                    gettype($arg))
                );
            }
        }
        return true;
    }

    /**
     * Defined by Zend_Validate_Interface
     *
     * Returns true if at least one of the validators is true
     *
     * @param  mixed $value
     * @return boolean
     */
    public function isValid($value)
    {
        if(count($this->_validators) === 0) {
            throw new Zend_Validate_Exception("At least one validator should be set");
        }

        $this->_messages = array();
        $this->_errors = array();

        foreach($this->_validators as $validator) {
            $result = $validator->isValid($value);

            if(true === $result) {
                $this->_messages = array();
                $this->_errors = array();
                return true;
            } else {
                foreach ($validator->getMessages() as $message) {
                    $this->_messages[] = $message;
                }
                foreach ($validator->getErrors() as $error) {
                    $this->_errors[] = $error;
                }
            }
        }

        return false;
    }
}

Page Operations

Browse Space

Zend_Validate_Or - Felix De Vliegher

Labels

Zend Framework: Zend_Validate_Or Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria