home *** CD-ROM | disk | FTP | other *** search
/ Cricao de Sites - 650 Layouts Prontos / WebMasters.iso / Servidores / xampp-win32-1.6.7-installer.exe / php / PEAR / HTML / QuickForm2 / Element.php < prev    next >
Encoding:
PHP Script  |  2008-07-02  |  5.2 KB  |  156 lines

  1. <?php
  2. /**
  3.  * Base class for simple HTML_QuickForm2 elements (not Containers)
  4.  *
  5.  * PHP version 5
  6.  *
  7.  * LICENSE:
  8.  * 
  9.  * Copyright (c) 2006, 2007, Alexey Borzov <avb@php.net>,
  10.  *                           Bertrand Mansion <golgote@mamasam.com>
  11.  * All rights reserved.
  12.  *
  13.  * Redistribution and use in source and binary forms, with or without
  14.  * modification, are permitted provided that the following conditions
  15.  * are met:
  16.  *
  17.  *    * Redistributions of source code must retain the above copyright
  18.  *      notice, this list of conditions and the following disclaimer.
  19.  *    * Redistributions in binary form must reproduce the above copyright
  20.  *      notice, this list of conditions and the following disclaimer in the 
  21.  *      documentation and/or other materials provided with the distribution.
  22.  *    * The names of the authors may not be used to endorse or promote products 
  23.  *      derived from this software without specific prior written permission.
  24.  *
  25.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  26.  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  27.  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28.  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  29.  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  30.  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  31.  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  32.  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  33.  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  34.  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35.  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36.  *
  37.  * @category   HTML
  38.  * @package    HTML_QuickForm2
  39.  * @author     Alexey Borzov <avb@php.net>
  40.  * @author     Bertrand Mansion <golgote@mamasam.com>
  41.  * @license    http://opensource.org/licenses/bsd-license.php New BSD License
  42.  * @version    CVS: $Id: Element.php,v 1.12 2007/06/30 20:36:00 avb Exp $
  43.  * @link       http://pear.php.net/package/HTML_QuickForm2
  44.  */
  45.  
  46. /**
  47.  * Base class for all HTML_QuickForm2 elements 
  48.  */
  49. require_once 'HTML/QuickForm2/Node.php';
  50.  
  51. /**
  52.  * Abstract base class for simple QuickForm2 elements (not Containers) 
  53.  *
  54.  * @category   HTML
  55.  * @package    HTML_QuickForm2
  56.  * @author     Alexey Borzov <avb@php.net>
  57.  * @author     Bertrand Mansion <golgote@mamasam.com>
  58.  * @version    Release: 0.2.0
  59.  */
  60. abstract class HTML_QuickForm2_Element extends HTML_QuickForm2_Node
  61. {
  62.    /**
  63.     * 'name' and 'id' attributes should be always present and their setting 
  64.     * should go through setName() and setId(). 
  65.     * @var array
  66.     */
  67.     protected $watchedAttributes = array('id', 'name');
  68.  
  69.     protected function onAttributeChange($name, $value = null)
  70.     {
  71.         if ('name' == $name) {
  72.             if (null === $value) {
  73.                 throw new HTML_QuickForm2_InvalidArgumentException(
  74.                     "Required attribute 'name' can not be removed"
  75.                 );
  76.             } else {
  77.                 $this->setName($value);
  78.             }
  79.         } elseif ('id' == $name) {
  80.             if (null === $value) {
  81.                 throw new HTML_QuickForm2_InvalidArgumentException(
  82.                     "Required attribute 'id' can not be removed"
  83.                 );
  84.             } else {
  85.                 $this->setId($value);
  86.             }
  87.         }
  88.     }
  89.  
  90.     public function getName()
  91.     {
  92.         return $this->attributes['name'];
  93.     }
  94.  
  95.     public function setName($name)
  96.     {
  97.         $this->attributes['name'] = (string)$name;
  98.         $this->updateValue();
  99.         return $this;
  100.     }
  101.  
  102.     public function getId()
  103.     {
  104.         return isset($this->attributes['id'])? $this->attributes['id']: null;
  105.     }
  106.  
  107.     public function setId($id = null)
  108.     {
  109.         if (is_null($id)) {
  110.             $id = self::generateId($this->getName());
  111.         } else {
  112.             self::storeId($id);
  113.         }
  114.         $this->attributes['id'] = (string)$id;
  115.         return $this;
  116.     }
  117.  
  118.    /**
  119.     * Generates hidden form field containing the element's value
  120.     *
  121.     * This is used to pass the frozen element's value if 'persistent freeze'
  122.     * feature is on
  123.     *
  124.     * @return string
  125.     */
  126.     protected function getPersistentContent()
  127.     {
  128.         if (!$this->persistent || null === ($value = $this->getValue())) {
  129.             return '';
  130.         }
  131.         return '<input type="hidden"' . self::getAttributesString(array(
  132.             'name'  => $this->getName(),
  133.             'value' => $value,
  134.             'id'    => $this->getId()
  135.         )) . ' />';
  136.     }
  137.  
  138.    /**
  139.     * Called when the element needs to update its value from form's data sources
  140.     *
  141.     * The default behaviour is to go through the complete list of the data 
  142.     * sources until the non-null value is found.
  143.     */
  144.     protected function updateValue()
  145.     {
  146.         $name = $this->getName();
  147.         foreach ($this->getDataSources() as $ds) {
  148.             if (null !== ($value = $ds->getValue($name))) {
  149.                 $this->setValue($value);
  150.                 return;
  151.             }
  152.         }
  153.     }
  154. }
  155. ?>
  156.