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

Source for file Renderer.php

Documentation is available at Renderer.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  3.  
  4. /**
  5.  * An abstract base class for QuickForm renderers
  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      Alexey Borzov <avb@php.net>
  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$
  21.  * @link        http://pear.php.net/package/HTML_QuickForm
  22.  */
  23.  
  24. /**
  25.  * An abstract base class for QuickForm renderers
  26.  * 
  27.  * The class implements a Visitor design pattern
  28.  *
  29.  * @category    HTML
  30.  * @package     HTML_QuickForm
  31.  * @author      Alexey Borzov <avb@php.net>
  32.  * @version     Release: 3.2.13
  33.  * @since       3.0
  34.  * @abstract
  35.  */
  36. {
  37.    /**
  38.     * Constructor
  39.     *
  40.     * @access public
  41.     */
  42.     function HTML_QuickForm_Renderer()
  43.     {
  44.     // end constructor
  45.  
  46.    /**
  47.     * Called when visiting a form, before processing any form elements
  48.     *
  49.     * @param    HTML_QuickForm  a form being visited
  50.     * @access   public
  51.     * @return   void 
  52.     * @abstract
  53.     */
  54.     function startForm(&$form)
  55.     {
  56.         return;
  57.     // end func startForm
  58.  
  59.    /**
  60.     * Called when visiting a form, after processing all form elements
  61.     * 
  62.     * @param    HTML_QuickForm  a form being visited
  63.     * @access   public
  64.     * @return   void 
  65.     * @abstract
  66.     */
  67.     function finishForm(&$form)
  68.     {
  69.         return;
  70.     // end func finishForm
  71.  
  72.    /**
  73.     * Called when visiting a header element
  74.     *
  75.     * @param    HTML_QuickForm_header   a header element being visited
  76.     * @access   public
  77.     * @return   void 
  78.     * @abstract
  79.     */
  80.     function renderHeader(&$header)
  81.     {
  82.         return;
  83.     // end func renderHeader
  84.  
  85.    /**
  86.     * Called when visiting an element
  87.     *
  88.     * @param    HTML_QuickForm_element  form element being visited
  89.     * @param    bool                    Whether an element is required
  90.     * @param    string                  An error message associated with an element
  91.     * @access   public
  92.     * @return   void 
  93.     * @abstract
  94.     */
  95.     function renderElement(&$element$required$error)
  96.     {
  97.         return;
  98.     // end func renderElement
  99.  
  100.    /**
  101.     * Called when visiting a hidden element
  102.     * 
  103.     * @param    HTML_QuickForm_element  a hidden element being visited
  104.     * @access   public
  105.     * @return   void 
  106.     * @abstract
  107.     */
  108.     function renderHidden(&$element)
  109.     {
  110.         return;
  111.     // end func renderHidden
  112.  
  113.    /**
  114.     * Called when visiting a raw HTML/text pseudo-element
  115.     * 
  116.     * Only implemented in Default renderer. Usage of 'html' elements is
  117.     * discouraged, templates should be used instead.
  118.     *
  119.     * @param    HTML_QuickForm_html     a 'raw html' element being visited
  120.     * @access   public
  121.     * @return   void 
  122.     * @abstract
  123.     */
  124.     function renderHtml(&$data)
  125.     {
  126.         return;
  127.     // end func renderHtml
  128.  
  129.    /**
  130.     * Called when visiting a group, before processing any group elements
  131.     *
  132.     * @param    HTML_QuickForm_group    A group being visited
  133.     * @param    bool                    Whether a group is required
  134.     * @param    string                  An error message associated with a group
  135.     * @access   public
  136.     * @return   void 
  137.     * @abstract
  138.     */
  139.     function startGroup(&$group$required$error)
  140.     {
  141.         return;
  142.     // end func startGroup
  143.  
  144.    /**
  145.     * Called when visiting a group, after processing all group elements
  146.     *
  147.     * @param    HTML_QuickForm_group    A group being visited
  148.     * @access   public
  149.     * @return   void 
  150.     * @abstract
  151.     */
  152.     function finishGroup(&$group)
  153.     {
  154.         return;
  155.     // end func finishGroup
  156. // end class HTML_QuickForm_Renderer
  157. ?>

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