Zend Framework: Zend_Validate_Array Component Proposal

Proposed Component Name	Zend_Validate_Array
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Validate_Array
Proposers	Boris Tomi? Darby Felton, Zend liaison
Revision	1.1 - 22 March 2007: Created. 1.2 - 09 December 2007: Small changes (wiki revision: 19)

$arrayValidator->addFilter("username", new Zend_Filter_StringTrim());
               ->addValidate("username", new Zend_Validate_Alnum(), "Your can enter just number and digits for username");
               ->addValidate("username", new Zend_Validate_StringLength(6, 8), "Your username should be betveen 6 and 8 chars long.");
               ->addValidate("password", new Zend_Validate_Digits(), "Password can contain only numbers.");

Then we do validation:

if($arrayValidator->isValid($_POST)){
    //data is valid
    $validValues = $arrayValidator->getValidValues();
}
else{
    $view->errors = $arrayValidator->getErrors();
    $view->enduserMessages = $arrayValidator->getUserMessages();
}

6. Milestones / Tasks

Milestone 1: Initial design
Milestone 2: Unit tests
Milestone 3: Documentation

7. Class Index

Zend_Validate_Array

8. Use Cases

UC-01

$test = array("key1" => 10, "key2" => " 0999837576", "key3" => "FranzHendrix"); $valid = new Zend_Validate_Array(array("key1", "key2", "key3")); $valid->addFilter("key2", new Zend_Filter_StringTrim()) ->addValidate("key1", new Zend_Validate_Int(), "key1 is not integer!") ->addValidate("key2", new Zend_Validate_Digits(), "key2 contains not only digits. That is not allowed!") ->addValidate("key1", new Zend_Validate_Between(3, 14), "key1 is not in corrected range 3<x<14") ->addValidate("key3", new Zend_Validate_Alnum(), "key3 does not contain only alnum chars"); if($valid->isValid($test)){ //it is valid so do something with valid values Zend_Debug::dump($valid->getValidValue()); Zend_Debug::dump($valid->getValidValue("key2")); } else{ //it is not valid display errors Zend_Debug::dump($valid->getErrors()); }

UC-02 - realworld example

<?php $input = new Zend_Validate_Array(array("username", "password", "passwordr")); $input->addFilter("username", new Zend_Filter_StringTrim()) ->addValidate("username", new Required(), $this->trans->_("You must enter username.")) ->addValidate("username", new Zend_Validate_Alnum(), $this->trans->_("Username must include only alfanumeric charachters")) ->addValidate("username", new Zend_Validate_StringLength(4,8), $this->trans->_("Username must have at least 4 and at most 8 charachters.")) ->addValidate("password", new Required(), $this->trans->_("You must enter password.")) ->addValidate("password", new Zend_Validate_Alnum(), $this->trans->_("Passowrd must have just alfanumeric charachters.")) ->addValidate("password", new Zend_Validate_StringLength(4,8), $this->trans->_("Password must have at least 4 and at most 8 charachters.")) ->addValidate("passwordr", new Required(), $this->trans->_("You must confirm your password.")) ->addValidate("password", new Equal($input, 'passwordr'), $this->trans->_("Password confirmation does not match password.")); $status = null; if($input->isValid($_POST)){ //do something usefull - ex. add user to db } else{ $messages = $input->getUserMessages(); $status = array( "type" => "error", "message" => $this->trans->_("There are some errors while creating new user."), "errors" => $messages ); } echo json_encode($status);

9. Class Skeletons

/**
 * @category   Zend
 * @package    Zend_Validate
 * @copyright  Copyright (c) 2007 Boris Tomic <boris@kodmasin.net>
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Validate_Array implements Zend_Validate_Interface
{
 
    /**
     * sets validator available keys which will be validated
     *
     * @param array $names
     */
    public function __construct(array $names){
     
    }
    /**
     * add filter for key in array to be validated
     *
     * @param string $name name of key for which filter will be added
     * @param Zend_Filter_Interface $filter
     * @return Zend_Validate_Array this
     */
    public function &addFilter($name, Zend_Filter_Interface $filter)
    {
        
    }
    /**
     * add filter for key in array to be validated
     *
     * @param string $name name of key for which validator will be added
     * @param Zend_Validate_Interface $validate
     * @param string $error error message which can be displayed to end user
     * @return Zend_Validate_Array this
     */
    public function &addValidate($name, Zend_Validate_Interface $validate, $error = null)
    {
        
    }
    /**
     * sets array to be validated.
     *
     * @param array $values
     * @return Zend_Validate_Array this
     */
    protected function _setArray($values)
    {
		
    }
    /**
     * clears all values set by validate function. it does not clear already set filters
     * and validators
     *
     */
    private function _reset()
    {
        
    }
    /**
     * check if key is set to be checked
     *
     * @param string $name name of key to be chacked
     */
    private function _isValidName($name)
    {
        
    }
    /**
     * all 'clever' work of this validator is done here. First all filters are applied to
     * apropriate values and then this filtered values are validated. If any validator fall
     * this function returns false.
     *
     * @return boolean true if array is valid and false otherwise
     */
    public function validate()
    {
        
    }
    /**
     * returns errors of all keys of for one key if its name supplied.
     *
     * @return mixed array of errors sorted by key names or if $name supplied just errors
     * for key with name $name.
     */
    public function getUserMessages($name = null)
    {
        
    }
    /**
     * check if some valu is valid
     *
     * @param string $name key name
     * @return boolean true if valid false if not
     */
    public function isKeyValid($name)
    {
        
    }
    /**
     * internal function which checks if wanted array is valid
     *
     * @return boolean true if valid false if not
     */
    protected function _isValid()
    {
        
    }
    /**
     * validate array
     *
     * @param array $values
     * @return boolean true if valid false if not
     */
    public function isValid($value)
    {
        
    }
    /**
     * returns valid value of wanted key or null if is not valid
     *
     * @param string $key name of key for wich validated value will be returnned. If null all valid values will be returned.
     * @return mixed valid value if valid or null if not valid
     */
    public function getValidValue($key = null)
    {
        
    }
    /**
     * returns original error messages for invalid validators
     *
     * @return array messages
     */
    public function getMessages()
    {
        
    }
    /**
     * Add user error for key with $name
     *
     * @param string $name name of key to wich we will add errror
     * @param string $error error
     */
    public function addUserErrorMessage($name, $error){
        
    }
    /**
     * Return error codes
     *
     * @return array with error codes
     */
    public function getErrors(){
    	
    }
}

Page Operations

Browse Space

Zend_Validate_Array Proposal

Labels

Zend Framework: Zend_Validate_Array Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

4. Dependencies on Other Framework Components

5. Theory of Operation

6. Milestones / Tasks

7. Class Index

8. Use Cases

9. Class Skeletons