Zend/Validate/Interface.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Validate
  17  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  18  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  19
  20  */
  21
  22 /**
  23  * @category   Zend
  24  * @package    Zend_Validate
  25  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  26  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  27  */
  28 interface Zend_Validate_Interface
  29 {
  30     /**
  31      * Returns true if and only if $value meets the validation requirements
  32      *
  33      * If $value fails validation, then this method returns false, and
  34      * getMessages() will return an array of messages that explain why the
  35      * validation failed.
  36      *
  37      * @param  mixed $value
  38      * @return boolean
  39      * @throws Zend_Valid_Exception If validation of $value is impossible
  40      */
  41     public function isValid($value);
  42
  43     /**
  44      * Returns an array of messages that explain why the most recent isValid()
  45      * call returned false. The array keys are validation failure message identifiers,
  46      * and the array values are the corresponding human-readable message strings.
  47      *
  48      * If isValid() was never called or if the most recent isValid() call
  49      * returned true, then this method returns an empty array.
  50      *
  51      * @return array
  52      */
  53     public function getMessages();
  54 }