HTML_QuickForm
[ class tree: HTML_QuickForm ] [ index: HTML_QuickForm ] [ all elements ]

Source for file Rule.php

Documentation is available at Rule.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  3.  
  4. /**
  5.  * Abstract base class for QuickForm validation rules
  6.  * 
  7.  * PHP versions 4 and 5
  8.  *
  9.  * LICENSE: This source file is subject to version 3.01 of the PHP license
  10.  * that is available through the world-wide-web at the following URI:
  11.  * http://www.php.net/license/3_01.txt If you did not receive a copy of
  12.  * the PHP License and are unable to obtain it through the web, please
  13.  * send a note to license@php.net so we can mail you a copy immediately.
  14.  *
  15.  * @category    HTML
  16.  * @package     HTML_QuickForm
  17.  * @author      Bertrand Mansion <bmansion@mamasam.com>
  18.  * @copyright   2001-2011 The PHP Group
  19.  * @license     http://www.php.net/license/3_01.txt PHP License 3.01
  20.  * @version     CVS: $Id: Rule.php 317587 2011-10-01 07:55:53Z avb $
  21.  * @link        http://pear.php.net/package/HTML_QuickForm
  22.  */
  23.  
  24. /**
  25.  * Abstract base class for QuickForm validation rules
  26.  *
  27.  * @category    HTML
  28.  * @package     HTML_QuickForm
  29.  * @author      Bertrand Mansion <bmansion@mamasam.com>
  30.  * @version     Release: 3.2.13
  31.  * @since       3.2
  32.  * @abstract
  33.  */
  34. {
  35.    /**
  36.     * Name of the rule to use in validate method
  37.     *
  38.     * This property is used in more global rules like Callback and Regex
  39.     * to determine which callback and which regex is to be used for validation
  40.     *
  41.     * @var  string 
  42.     * @access   public
  43.     */
  44.     var $name;
  45.  
  46.    /**
  47.     * Validates a value
  48.     * 
  49.     * @access public
  50.     * @abstract
  51.     */
  52.     function validate($value)
  53.     {
  54.         return true;
  55.     }
  56.  
  57.    /**
  58.     * Sets the rule name
  59.     *
  60.     * @param  string    rule name
  61.     * @access public
  62.     */
  63.     function setName($ruleName)
  64.     {
  65.         $this->name = $ruleName;
  66.     }
  67.  
  68.     /**
  69.      * Returns the javascript test (the test should return true if the value is INVALID)
  70.      *
  71.      * @param     mixed     Options for the rule
  72.      * @access    public
  73.      * @return    array     first element is code to setup validation, second is the check itself
  74.      * @abstract
  75.      */
  76.     function getValidationScript($options = null)
  77.     {
  78.         return array('''');
  79.     }
  80. }
  81. ?>

Documentation generated on Sat, 01 Oct 2011 09:00:19 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.