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

Source for file image.php

Documentation is available at image.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  3.  
  4. /**
  5.  * HTML class for an <input type="image" /> 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: image.php 317587 2011-10-01 07:55:53Z avb $
  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 an <input type="image" /> 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.13
  38.  * @since       1.0
  39.  */
  40. {
  41.     // {{{ constructor
  42.  
  43.     /**
  44.      * Class constructor
  45.      * 
  46.      * @param     string    $elementName    (optional)Element name attribute
  47.      * @param     string    $src            (optional)Image source
  48.      * @param     mixed     $attributes     (optional)Either a typical HTML attribute string
  49.      *                                       or an associative array
  50.      * @since     1.0
  51.      * @access    public
  52.      * @return    void 
  53.      */
  54.     function HTML_QuickForm_image($elementName=null$src=''$attributes=null)
  55.     {
  56.         HTML_QuickForm_input::HTML_QuickForm_input($elementNamenull$attributes);
  57.         $this->setType('image');
  58.         $this->setSource($src);
  59.     // end class constructor
  60.  
  61.     // }}}
  62.     // {{{ setSource()
  63.  
  64.     /**
  65.      * Sets source for image element
  66.      * 
  67.      * @param     string    $src  source for image element
  68.      * @since     1.0
  69.      * @access    public
  70.      * @return    void 
  71.      */
  72.     function setSource($src)
  73.     {
  74.         $this->updateAttributes(array('src' => $src));
  75.     // end func setSource
  76.  
  77.     // }}}
  78.     // {{{ setBorder()
  79.  
  80.     /**
  81.      * Sets border size for image element
  82.      * 
  83.      * @param     string    $border  border for image element
  84.      * @since     1.0
  85.      * @access    public
  86.      * @return    void 
  87.      */
  88.     function setBorder($border)
  89.     {
  90.         $this->updateAttributes(array('border' => $border));
  91.     // end func setBorder
  92.  
  93.     // }}}
  94.     // {{{ setAlign()
  95.  
  96.     /**
  97.      * Sets alignment for image element
  98.      * 
  99.      * @param     string    $align  alignment for image element
  100.      * @since     1.0
  101.      * @access    public
  102.      * @return    void 
  103.      */
  104.     function setAlign($align)
  105.     {
  106.         $this->updateAttributes(array('align' => $align));
  107.     // end func setAlign
  108.  
  109.     // }}}
  110.     // {{{ freeze()
  111.  
  112.     /**
  113.      * Freeze the element so that only its value is returned
  114.      * 
  115.      * @access    public
  116.      * @return    void 
  117.      */
  118.     function freeze()
  119.     {
  120.         return false;
  121.     //end func freeze
  122.  
  123.     // }}}
  124.  
  125. // end class HTML_QuickForm_image
  126. ?>

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