lib/pear/HTML/QuickForm/hidden.php

   1 <?php
   2 /* vim: set expandtab tabstop=4 shiftwidth=4: */
   3 // +----------------------------------------------------------------------+
   4 // | PHP version 4.0                                                      |
   5 // +----------------------------------------------------------------------+
   6 // | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group             |
   7 // +----------------------------------------------------------------------+
   8 // | This source file is subject to version 2.0 of the PHP license,       |
   9 // | that is bundled with this package in the file LICENSE, and is        |
  10 // | available at through the world-wide-web at                           |
  11 // | http://www.php.net/license/2_02.txt.                                 |
  12 // | If you did not receive a copy of the PHP license and are unable to   |
  13 // | obtain it through the world-wide-web, please send a note to          |
  14 // | license@php.net so we can mail you a copy immediately.               |
  15 // +----------------------------------------------------------------------+
  16 // | Authors: Adam Daniel <adaniel1@eesus.jnj.com>                        |
  17 // |          Bertrand Mansion <bmansion@mamasam.com>                     |
  18 // +----------------------------------------------------------------------+
  19 //
  20 // $Id$
  21
  22 require_once("HTML/QuickForm/input.php");
  23
  24 /**
  25  * HTML class for a hidden type element
  26  *
  27  * @author       Adam Daniel <adaniel1@eesus.jnj.com>
  28  * @author       Bertrand Mansion <bmansion@mamasam.com>
  29  * @version      1.0
  30  * @since        PHP4.04pl1
  31  * @access       public
  32  */
  33 class HTML_QuickForm_hidden extends HTML_QuickForm_input
  34 {
  35     // {{{ constructor
  36
  37     /**
  38      * Class constructor
  39      *
  40      * @param     string    $elementName    (optional)Input field name attribute
  41      * @param     string    $value          (optional)Input field value
  42      * @param     mixed     $attributes     (optional)Either a typical HTML attribute string
  43      *                                      or an associative array
  44      * @since     1.0
  45      * @access    public
  46      * @return    void
  47      */
  48     function HTML_QuickForm_hidden($elementName=null, $value='', $attributes=null)
  49     {
  50         HTML_QuickForm_input::HTML_QuickForm_input($elementName, null, $attributes);
  51         $this->setType('hidden');
  52         $this->setValue($value);
  53     } //end constructor
  54
  55     // }}}
  56     // {{{ freeze()
  57
  58     /**
  59      * Freeze the element so that only its value is returned
  60      *
  61      * @access    public
  62      * @return    void
  63      */
  64     function freeze()
  65     {
  66         return false;
  67     } //end func freeze
  68
  69     // }}}
  70     // {{{ accept()
  71
  72    /**
  73     * Accepts a renderer
  74     *
  75     * @param object     An HTML_QuickForm_Renderer object
  76     * @access public
  77     * @return void
  78     */
  79     function accept(&$renderer)
  80     {
  81         $renderer->renderHidden($this);
  82     } // end func accept
  83
  84     // }}}
  85
  86 } //end class HTML_QuickForm_hidden
  87 ?>