cookbooks/dmca/files/default/html/HTML/QuickForm/hidden.php

   1 <?php
   2 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
   3
   4 /**
   5  * HTML class for a hidden type element
   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      Adam Daniel <adaniel1@eesus.jnj.com>
  18  * @author      Bertrand Mansion <bmansion@mamasam.com>
  19  * @copyright   2001-2011 The PHP Group
  20  * @license     http://www.php.net/license/3_01.txt PHP License 3.01
  21  * @version     CVS: $Id$
  22  * @link        http://pear.php.net/package/HTML_QuickForm
  23  */
  24
  25 /**
  26  * Base class for <input /> form elements
  27  */
  28 require_once 'HTML/QuickForm/input.php';
  29
  30 /**
  31  * HTML class for a hidden type element
  32  *
  33  * @category    HTML
  34  * @package     HTML_QuickForm
  35  * @author      Adam Daniel <adaniel1@eesus.jnj.com>
  36  * @author      Bertrand Mansion <bmansion@mamasam.com>
  37  * @version     Release: 3.2.16
  38  * @since       1.0
  39  */
  40 class HTML_QuickForm_hidden extends HTML_QuickForm_input
  41 {
  42     // {{{ constructor
  43
  44     /**
  45      * Class constructor
  46      *
  47      * @param     string    $elementName    (optional)Input field name attribute
  48      * @param     string    $value          (optional)Input field value
  49      * @param     mixed     $attributes     (optional)Either a typical HTML attribute string
  50      *                                      or an associative array
  51      * @since     1.0
  52      * @access    public
  53      * @return    void
  54      */
  55     function HTML_QuickForm_hidden($elementName=null, $value='', $attributes=null)
  56     {
  57         HTML_QuickForm_input::HTML_QuickForm_input($elementName, null, $attributes);
  58         $this->setType('hidden');
  59         $this->setValue($value);
  60     } //end constructor
  61
  62     // }}}
  63     // {{{ freeze()
  64
  65     /**
  66      * Freeze the element so that only its value is returned
  67      *
  68      * @access    public
  69      * @return    void
  70      */
  71     function freeze()
  72     {
  73         return false;
  74     } //end func freeze
  75
  76     // }}}
  77     // {{{ accept()
  78
  79    /**
  80     * Accepts a renderer
  81     *
  82     * @param HTML_QuickForm_Renderer    renderer object
  83     * @param bool $sc1                  unused, for signature compatibility
  84     * @param bool $sc2                  unused, for signature compatibility
  85     * @access public
  86     * @return void
  87     */
  88     function accept(&$renderer, $sc1 = false, $sc2 = null)
  89     {
  90         $renderer->renderHidden($this);
  91     } // end func accept
  92
  93     // }}}
  94
  95 } //end class HTML_QuickForm_hidden
  96 ?>