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

Source for file static.php

Documentation is available at static.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  3.  
  4. /**
  5.  * HTML class for static data
  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      Wojciech Gdela <eltehaem@poczta.onet.pl>
  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: static.php 317587 2011-10-01 07:55:53Z avb $
  21.  * @link        http://pear.php.net/package/HTML_QuickForm
  22.  */
  23.  
  24. /**
  25.  * Base class for form elements
  26.  */ 
  27. require_once 'HTML/QuickForm/element.php';
  28.  
  29. /**
  30.  * HTML class for static data
  31.  * 
  32.  * @category    HTML
  33.  * @package     HTML_QuickForm
  34.  * @author      Wojciech Gdela <eltehaem@poczta.onet.pl>
  35.  * @version     Release: 3.2.13
  36.  * @since       2.7
  37.  */
  38.     
  39.     // {{{ properties
  40.  
  41.     /**
  42.      * Display text
  43.      * @var       string 
  44.      * @access    private
  45.      */
  46.     var $_text = null;
  47.  
  48.     // }}}
  49.     // {{{ constructor
  50.     
  51.     /**
  52.      * Class constructor
  53.      * 
  54.      * @param     string    $elementLabel   (optional)Label
  55.      * @param     string    $text           (optional)Display text
  56.      * @access    public
  57.      * @return    void 
  58.      */
  59.     function HTML_QuickForm_static($elementName=null$elementLabel=null$text=null)
  60.     {
  61.         HTML_QuickForm_element::HTML_QuickForm_element($elementName$elementLabel);
  62.         $this->_persistantFreeze = false;
  63.         $this->_type 'static';
  64.         $this->_text $text;
  65.     //end constructor
  66.     
  67.     // }}}
  68.     // {{{ setName()
  69.  
  70.     /**
  71.      * Sets the element name
  72.      * 
  73.      * @param     string    $name   Element name
  74.      * @access    public
  75.      * @return    void 
  76.      */
  77.     function setName($name)
  78.     {
  79.         $this->updateAttributes(array('name'=>$name));
  80.     //end func setName
  81.     
  82.     // }}}
  83.     // {{{ getName()
  84.  
  85.     /**
  86.      * Returns the element name
  87.      * 
  88.      * @access    public
  89.      * @return    string 
  90.      */
  91.     function getName()
  92.     {
  93.         return $this->getAttribute('name');
  94.     //end func getName
  95.  
  96.     // }}}
  97.     // {{{ setText()
  98.  
  99.     /**
  100.      * Sets the text
  101.      *
  102.      * @param     string    $text 
  103.      * @access    public
  104.      * @return    void 
  105.      */
  106.     function setText($text)
  107.     {
  108.         $this->_text $text;
  109.     // end func setText
  110.  
  111.     // }}}
  112.     // {{{ setValue()
  113.  
  114.     /**
  115.      * Sets the text (uses the standard setValue call to emulate a form element.
  116.      *
  117.      * @param     string    $text 
  118.      * @access    public
  119.      * @return    void 
  120.      */
  121.     function setValue($text)
  122.     {
  123.         $this->setText($text);
  124.     // end func setValue
  125.  
  126.     // }}}    
  127.     // {{{ toHtml()
  128.  
  129.     /**
  130.      * Returns the static text element in HTML
  131.      * 
  132.      * @access    public
  133.      * @return    string 
  134.      */
  135.     function toHtml()
  136.     {
  137.         return $this->_getTabs($this->_text;
  138.     //end func toHtml
  139.     
  140.     // }}}
  141.     // {{{ getFrozenHtml()
  142.  
  143.     /**
  144.      * Returns the value of field without HTML tags
  145.      * 
  146.      * @access    public
  147.      * @return    string 
  148.      */
  149.     function getFrozenHtml()
  150.     {
  151.         return $this->toHtml();
  152.     //end func getFrozenHtml
  153.  
  154.     // }}}
  155.     // {{{ onQuickFormEvent()
  156.  
  157.     /**
  158.      * Called by HTML_QuickForm whenever form event is made on this element
  159.      *
  160.      * @param     string    $event  Name of event
  161.      * @param     mixed     $arg    event arguments
  162.      * @param     object    &$caller calling object
  163.      * @since     1.0
  164.      * @access    public
  165.      * @return    void 
  166.      * @throws
  167.      */
  168.     function onQuickFormEvent($event$arg&$caller)
  169.     {
  170.         switch ($event{
  171.             case 'updateValue':
  172.                 // do NOT use submitted values for static elements
  173.                 $value $this->_findValue($caller->_constantValues);
  174.                 if (null === $value{
  175.                     $value $this->_findValue($caller->_defaultValues);
  176.                 }
  177.                 if (null !== $value{
  178.                     $this->setValue($value);
  179.                 }
  180.                 break;
  181.             default:
  182.                 parent::onQuickFormEvent($event$arg$caller);
  183.         }
  184.         return true;
  185.     // end func onQuickFormEvent
  186.  
  187.     // }}}
  188.     // {{{ exportValue()
  189.  
  190.    /**
  191.     * We override this here because we don't want any values from static elements
  192.     */
  193.     function exportValue(&$submitValues$assoc = false)
  194.     {
  195.         return null;
  196.     }
  197.     
  198.     // }}}
  199. //end class HTML_QuickForm_static
  200. ?>

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