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

Source for file Required.php

Documentation is available at Required.php

  1. <?php
  2. /**
  3.  * Rule for required elements
  4.  *
  5.  * PHP version 5
  6.  *
  7.  * LICENSE:
  8.  *
  9.  * Copyright (c) 2006, 2007, Alexey Borzov <avb@php.net>,
  10.  *                           Bertrand Mansion <golgote@mamasam.com>
  11.  * All rights reserved.
  12.  *
  13.  * Redistribution and use in source and binary forms, with or without
  14.  * modification, are permitted provided that the following conditions
  15.  * are met:
  16.  *
  17.  *    * Redistributions of source code must retain the above copyright
  18.  *      notice, this list of conditions and the following disclaimer.
  19.  *    * Redistributions in binary form must reproduce the above copyright
  20.  *      notice, this list of conditions and the following disclaimer in the
  21.  *      documentation and/or other materials provided with the distribution.
  22.  *    * The names of the authors may not be used to endorse or promote products
  23.  *      derived from this software without specific prior written permission.
  24.  *
  25.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  26.  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  27.  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28.  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  29.  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  30.  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  31.  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  32.  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  33.  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  34.  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35.  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36.  *
  37.  * @category   HTML
  38.  * @package    HTML_QuickForm2
  39.  * @author     Alexey Borzov <avb@php.net>
  40.  * @author     Bertrand Mansion <golgote@mamasam.com>
  41.  * @license    http://opensource.org/licenses/bsd-license.php New BSD License
  42.  * @version    CVS: $Id: Required.php,v 1.1 2007/07/05 18:27:16 avb Exp $
  43.  * @link       http://pear.php.net/package/HTML_QuickForm2
  44.  */
  45.  
  46. /**
  47.  * Rule checking that the form field is not empty
  48.  */
  49. require_once 'HTML/QuickForm2/Rule/Nonempty.php';
  50.  
  51. /**
  52.  * Rule for required elements
  53.  *
  54.  * The main difference from "nonempty" Rule is that
  55.  * - elements to which this Rule is attached will be considered required
  56.  *   ({@link HTML_QuickForm2_Node::isRequired()} will return true for them) and
  57.  *   marked accordingly when outputting the form
  58.  * - this Rule can only be added directly to the element and other Rules can
  59.  *   only be added to it via and_() method
  60.  *
  61.  * @category   HTML
  62.  * @package    HTML_QuickForm2
  63.  * @author     Alexey Borzov <avb@php.net>
  64.  * @author     Bertrand Mansion <golgote@mamasam.com>
  65.  * @version    Release: 0.2.0
  66.  */
  67. {
  68.    /**
  69.     * Disallows adding a rule to the chain with an "or" operator
  70.     *
  71.     * Required rules are different from all others because they affect the
  72.     * visual representation of an element ("* denotes required field").
  73.     * Therefore we cannot allow chaining other rules to these via or_(), since
  74.     * this will effectively mean that the field is not required anymore and the
  75.     * visual difference is bogus.
  76.     *
  77.     * @param    HTML_QuickForm2_Rule 
  78.     * @throws   HTML_QuickForm2_Exception
  79.     */
  80.     public function or_(HTML_QuickForm2_Rule $next)
  81.     {
  82.         throw new HTML_QuickForm2_Exception(
  83.             'or_(): Cannot add a rule to "required" rule'
  84.         );
  85.     }
  86. }
  87. ?>

Documentation generated on Mon, 22 Oct 2007 12:30:22 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.