WebSVN – Applications.papyrus – Diff – /trunk/api/pear/HTML/QuickForm/select.php


<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// | PHP version 4.0                                                      |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2003 The PHP Group                                |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.0 of the PHP license,       |
// | that is bundled with this package in the file LICENSE, and is        |
// | available at through the world-wide-web at                           |
// | http://www.php.net/license/2_02.txt.                                 |
// | If you did not receive a copy of the PHP license and are unable to   |
// | obtain it through the world-wide-web, please send a note to          |
// | license@php.net so we can mail you a copy immediately.               |
// +----------------------------------------------------------------------+
// | Authors: Adam Daniel <adaniel1@eesus.jnj.com>                        |
// |          Bertrand Mansion <bmansion@mamasam.com>                     |
// +----------------------------------------------------------------------+
//
// $Id: select.php,v 1.2 2005-09-20 17:01:22 ddelon Exp $
 
require_once('HTML/QuickForm/element.php');
 
/**
 * Class to dynamically create an HTML SELECT
 *
 * @author       Adam Daniel <adaniel1@eesus.jnj.com>
 * @author       Bertrand Mansion <bmansion@mamasam.com>
 * @version      1.0
 * @since        PHP4.04pl1
 * @access       public
 */
class HTML_QuickForm_select extends HTML_QuickForm_element {
    
    // {{{ properties
 
    /**
     * Contains the select options
     *
     * @var       array
     * @since     1.0
     * @access    private
     */
    var $_options = array();
    
    /**
     * Default values of the SELECT
     * 
     * @var       string
     * @since     1.0
     * @access    private
     */
    var $_values = null;
 
    // }}}
    // {{{ constructor
        
    /**
     * Class constructor
     * 
     * @param     string    Select name attribute
     * @param     mixed     Label(s) for the select
     * @param     mixed     Data to be used to populate options
     * @param     mixed     Either a typical HTML attribute string or an associative array
     * @since     1.0
     * @access    public
     * @return    void
     */
    function HTML_QuickForm_select($elementName=null, $elementLabel=null, $options=null, $attributes=null)
    {
        HTML_QuickForm_element::HTML_QuickForm_element($elementName, $elementLabel, $attributes);
        $this->_persistantFreeze = true;
        $this->_type = 'select';
        if (isset($options)) {
            $this->load($options);
        }
    } //end constructor
    
    // }}}
    // {{{ apiVersion()
 
    /**
     * Returns the current API version 
     * 
     * @since     1.0
     * @access    public
     * @return    double
     */
    function apiVersion()
    {
        return 2.3;
    } //end func apiVersion
 
    // }}}
    // {{{ setSelected()
 
    /**
     * Sets the default values of the select box
     * 
     * @param     mixed    $values  Array or comma delimited string of selected values
     * @since     1.0
     * @access    public
     * @return    void
     */
    function setSelected($values)
    {
        if (is_string($values) && $this->getMultiple()) {
            $values = split("[ ]?,[ ]?", $values);
        }
        if (is_array($values)) {
            $this->_values = array_values($values);
        } else {
            $this->_values = array($values);
        }
    } //end func setSelected
    
    // }}}
    // {{{ getSelected()
 
    /**
     * Returns an array of the selected values
     * 
     * @since     1.0
     * @access    public
     * @return    array of selected values
     */
    function getSelected()
    {
        return $this->_values;
    } // end func getSelected
 
    // }}}
    // {{{ setName()
 
    /**
     * Sets the input field name
     * 
     * @param     string    $name   Input field name attribute
     * @since     1.0
     * @access    public
     * @return    void
     */
    function setName($name)
    {
        $this->updateAttributes(array('name' => $name));
    } //end func setName
    
    // }}}
    // {{{ getName()
 
    /**
     * Returns the element name
     * 
     * @since     1.0
     * @access    public
     * @return    string
     */
    function getName()
    {
        return $this->getAttribute('name');
    } //end func getName
 
    // }}}
    // {{{ getPrivateName()
 
    /**
     * Returns the element name (possibly with brackets appended)
     * 
     * @since     1.0
     * @access    public
     * @return    string
     */
    function getPrivateName()
    {
        if ($this->getAttribute('multiple')) {
            return $this->getName() . '[]';
        } else {
            return $this->getName();
        }
    } //end func getPrivateName
 
    // }}}
    // {{{ setValue()
 
    /**
     * Sets the value of the form element
     *
     * @param     mixed    $values  Array or comma delimited string of selected values
     * @since     1.0
     * @access    public
     * @return    void
     */
    function setValue($value)
    {
        $this->setSelected($value);
    } // end func setValue
 
    // }}}
    // {{{ getValue()
 
    /**
     * Returns an array of the selected values
     * 
     * @since     1.0
     * @access    public
     * @return    array of selected values
     */
    function getValue()
    {
        return $this->_values;
    } // end func getValue
 
    // }}}
    // {{{ setSize()
 
    /**
     * Sets the select field size, only applies to 'multiple' selects
     * 
     * @param     int    $size  Size of select  field
     * @since     1.0
     * @access    public
     * @return    void
     */
    function setSize($size)
    {
        $this->updateAttributes(array('size' => $size));
    } //end func setSize
    
    // }}}
    // {{{ getSize()
 
    /**
     * Returns the select field size
     * 
     * @since     1.0
     * @access    public
     * @return    int
     */
    function getSize()
    {
        return $this->getAttribute('size');
    } //end func getSize
 
    // }}}
    // {{{ setMultiple()
 
    /**
     * Sets the select mutiple attribute
     * 
     * @param     bool    $multiple  Whether the select supports multi-selections
     * @since     1.2
     * @access    public
     * @return    void
     */
    function setMultiple($multiple)
    {
        if ($multiple) {
            $this->updateAttributes(array('multiple' => 'multiple'));
        } else {
            $this->removeAttribute('multiple');
        }
    } //end func setMultiple
    
    // }}}
    // {{{ getMultiple()
 
    /**
     * Returns the select mutiple attribute
     * 
     * @since     1.2
     * @access    public
     * @return    bool    true if multiple select, false otherwise
     */
    function getMultiple()
    {
        return (bool)$this->getAttribute('multiple');
    } //end func getMultiple
 
    // }}}
    // {{{ addOption()
 
    /**
     * Adds a new OPTION to the SELECT
     *
     * @param     string    $text       Display text for the OPTION
     * @param     string    $value      Value for the OPTION
     * @param     mixed     $attributes Either a typical HTML attribute string 
     *                                  or an associative array
     * @since     1.0
     * @access    public
     * @return    void
     */
    function addOption($text, $value, $attributes=null)
    {
        if (null === $attributes) {
            $attributes = array('value' => $value);
        } else {
            $attributes = $this->_parseAttributes($attributes);
            if (isset($attributes['selected'])) {
                // the 'selected' attribute will be set in toHtml()
                $this->_removeAttr('selected', $attributes);
                if (is_null($this->_values)) {
                    $this->_values = array($value);
                } elseif (!in_array($value, $this->_values)) {
                    $this->_values[] = $value;
                }
            }
            $this->_updateAttrArray($attributes, array('value' => $value));
        }
        $this->_options[] = array('text' => $text, 'attr' => $attributes);
    } // end func addOption
    
    // }}}
    // {{{ loadArray()
 
    /**
     * Loads the options from an associative array
     * 
     * @param     array    $arr     Associative array of options
     * @param     mixed    $values  (optional) Array or comma delimited string of selected values
     * @since     1.0
     * @access    public
     * @return    PEAR_Error on error or true
     * @throws    PEAR_Error
     */
    function loadArray($arr, $values=null)
    {
        if (!is_array($arr)) {
            return PEAR::raiseError('Argument 1 of HTML_Select::loadArray is not a valid array');
        }
        if (isset($values)) {
            $this->setSelected($values);
        }
        foreach ($arr as $key => $val) {
            // Warning: new API since release 2.3
            $this->addOption($val, $key);
        }
        return true;
    } // end func loadArray
 
    // }}}
    // {{{ loadDbResult()
 
    /**
     * Loads the options from DB_result object
     * 
     * If no column names are specified the first two columns of the result are
     * used as the text and value columns respectively
     * @param     object    $result     DB_result object 
     * @param     string    $textCol    (optional) Name of column to display as the OPTION text 
     * @param     string    $valueCol   (optional) Name of column to use as the OPTION value 
     * @param     mixed     $values     (optional) Array or comma delimited string of selected values
     * @since     1.0
     * @access    public
     * @return    PEAR_Error on error or true
     * @throws    PEAR_Error
     */
    function loadDbResult(&$result, $textCol=null, $valueCol=null, $values=null)
    {
        if (!is_object($result) || !is_a($result, 'db_result')) {
            return PEAR::raiseError('Argument 1 of HTML_Select::loadDbResult is not a valid DB_result');
        }
        if (isset($values)) {
            $this->setValue($values);
        }
        $fetchMode = ($textCol && $valueCol) ? DB_FETCHMODE_ASSOC : DB_FETCHMODE_DEFAULT;
        while (is_array($row = $result->fetchRow($fetchMode)) ) {
            if ($fetchMode == DB_FETCHMODE_ASSOC) {
                $this->addOption($row[$textCol], $row[$valueCol]);
            } else {
                $this->addOption($row[0], $row[1]);
            }
        }
        return true;
    } // end func loadDbResult
    
    // }}}
    // {{{ loadQuery()
 
    /**
     * Queries a database and loads the options from the results
     *
     * @param     mixed     $conn       Either an existing DB connection or a valid dsn 
     * @param     string    $sql        SQL query string
     * @param     string    $textCol    (optional) Name of column to display as the OPTION text 
     * @param     string    $valueCol   (optional) Name of column to use as the OPTION value 
     * @param     mixed     $values     (optional) Array or comma delimited string of selected values
     * @since     1.1
     * @access    public
     * @return    void
     * @throws    PEAR_Error
     */
    function loadQuery(&$conn, $sql, $textCol=null, $valueCol=null, $values=null)
    {
        if (is_string($conn)) {
            require_once('DB.php');
            $dbConn = &DB::connect($conn, true);
            if (DB::isError($dbConn)) {
                return $dbConn;
            }
        } elseif (is_subclass_of($conn, "db_common")) {
            $dbConn = &$conn;
        } else {
            return PEAR::raiseError('Argument 1 of HTML_Select::loadQuery is not a valid type');
        }
        $result = $dbConn->query($sql);
        if (DB::isError($result)) {
            return $result;
        }
        $this->loadDbResult($result, $textCol, $valueCol, $values);
        $result->free();
        if (is_string($conn)) {
            $dbConn->disconnect();
        }
        return true;
    } // end func loadQuery
 
    // }}}
    // {{{ load()
 
    /**
     * Loads options from different types of data sources
     *
     * This method is a simulated overloaded method.  The arguments, other than the
     * first are optional and only mean something depending on the type of the first argument.
     * If the first argument is an array then all arguments are passed in order to loadArray.
     * If the first argument is a db_result then all arguments are passed in order to loadDbResult.
     * If the first argument is a string or a DB connection then all arguments are 
     * passed in order to loadQuery.
     * @param     mixed     $options     Options source currently supports assoc array or DB_result
     * @param     mixed     $param1     (optional) See function detail
     * @param     mixed     $param2     (optional) See function detail
     * @param     mixed     $param3     (optional) See function detail
     * @param     mixed     $param4     (optional) See function detail
     * @since     1.1
     * @access    public
     * @return    PEAR_Error on error or true
     * @throws    PEAR_Error
     */
    function load(&$options, $param1=null, $param2=null, $param3=null, $param4=null)
    {
        switch (true) {
            case is_array($options):
                return $this->loadArray($options, $param1);
                break;
            case (is_a($options, 'db_result')):
                return $this->loadDbResult($options, $param1, $param2, $param3);
                break;
            case (is_string($options) && !empty($options) ):
                return $this->loadQuery($options, $param1, $param2, $param3, $param4);
                break;
        }
    } // end func load
    
    // }}}
    // {{{ toHtml()
 
    /**
     * Returns the SELECT in HTML
     *
     * @since     1.0
     * @access    public
     * @return    string
     */
    function toHtml()
    {
        if ($this->_flagFrozen) {
            return $this->getFrozenHtml();
        } else {
            $tabs    = $this->_getTabs();
            $strHtml = '';
 
            if ($this->getComment() != '') {
                $strHtml .= $tabs . '<!-- ' . $this->getComment() . " //-->\n";
            }
 
            if (!$this->getMultiple()) {
                $attrString = $this->_getAttrString($this->_attributes);
            } else {
                $myName = $this->getName();
                $this->setName($myName . '[]');
                $attrString = $this->_getAttrString($this->_attributes);
                $this->setName($myName);
            }
            $strHtml .= $tabs . '<select' . $attrString . ">\n";
 
            foreach ($this->_options as $option) {
                if (is_array($this->_values) && in_array((string)$option['attr']['value'], $this->_values)) {
                    $this->_updateAttrArray($option['attr'], array('selected' => 'selected'));
                }
                $strHtml .= $tabs . "\t<option" . $this->_getAttrString($option['attr']) . '>' .
                            $option['text'] . "</option>\n";
            }
 
            return $strHtml . $tabs . '</select>';
        }
    } //end func toHtml
    
    // }}}
    // {{{ getFrozenHtml()
 
    /**
     * Returns the value of field without HTML tags
     * 
     * @since     1.0
     * @access    public
     * @return    string
     */
    function getFrozenHtml()
    {
        $value = array();
        if (is_array($this->_values)) {
            foreach ($this->_values as $key => $val) {
                for ($i = 0, $optCount = count($this->_options); $i < $optCount; $i++) {
                    if ((string)$val == (string)$this->_options[$i]['attr']['value']) {
                        $value[$key] = $this->_options[$i]['text'];
                        break;
                    }
                }
            }
        }
        $html = empty($value)? '&nbsp;': join('<br />', $value);
        if ($this->_persistantFreeze) {
            $name = $this->getPrivateName();
            // Only use id attribute if doing single hidden input
            if (1 == count($value)) {
                $id     = $this->getAttribute('id');
                $idAttr = isset($id)? array('id' => $id): array();
            } else {
                $idAttr = array();
            }
            foreach ($value as $key => $item) {
                $html .= '<input' . $this->_getAttrString(array(
                             'type'  => 'hidden',
                             'name'  => $name,
                             'value' => $this->_values[$key]
                         ) + $idAttr) . ' />';
            }
        }
        return $html;
    } //end func getFrozenHtml
 
    // }}}
    // {{{ exportValue()
 
   /**
    * We check the options and return only the values that _could_ have been
    * selected. We also return a scalar value if select is not "multiple"
    */
    function exportValue(&$submitValues, $assoc = false)
    {
        $value = $this->_findValue($submitValues);
        if (is_null($value)) {
            $value = $this->getValue();
        } elseif(!is_array($value)) {
            $value = array($value);
        }
        if (is_array($value) && !empty($this->_options)) {
            $cleanValue = null;
            foreach ($value as $v) {
                for ($i = 0, $optCount = count($this->_options); $i < $optCount; $i++) {
                    if ($v == $this->_options[$i]['attr']['value']) {
                        $cleanValue[] = $v;
                        break;
                    }
                }
            }
        } else {
            $cleanValue = $value;
        }
        if (is_array($cleanValue) && !$this->getMultiple()) {
            return $this->_prepareValue($cleanValue[0], $assoc);
        } else {
            return $this->_prepareValue($cleanValue, $assoc);
        }
    }
    
    // }}}
    // {{{ onQuickFormEvent()
 
    function onQuickFormEvent($event, $arg, &$caller)
    {
        if ('updateValue' == $event) {
            $value = $this->_findValue($caller->_constantValues);
            if (null === $value) {
                $value = $this->_findValue($caller->_submitValues);
                // Fix for bug #4465
                // XXX: should we push this to element::onQuickFormEvent()?
                if (null === $value && !$caller->isSubmitted()) {
                    $value = $this->_findValue($caller->_defaultValues);
                }
            }
            if (null !== $value) {
                $this->setValue($value);
            }
            return true;
        } else {
            return parent::onQuickFormEvent($event, $arg, $caller);
        }
    }
 
    // }}}
} //end class HTML_QuickForm_select
?>

Rev 320	Rev 443
1	`<?php`	1	`<?php`
2	`/* vim: set expandtab tabstop=4 shiftwidth=4: */`	2	`/* vim: set expandtab tabstop=4 shiftwidth=4: */`
3	`// +----------------------------------------------------------------------+`	3	`// +----------------------------------------------------------------------+`
4	`// \| PHP version 4.0 \|`	4	`// \| PHP version 4.0 \|`
5	`// +----------------------------------------------------------------------+`	5	`// +----------------------------------------------------------------------+`
6	`// \| Copyright (c) 1997-2003 The PHP Group \|`	6	`// \| Copyright (c) 1997-2003 The PHP Group \|`
7	`// +----------------------------------------------------------------------+`	7	`// +----------------------------------------------------------------------+`
8	`// \| This source file is subject to version 2.0 of the PHP license, \|`	8	`// \| This source file is subject to version 2.0 of the PHP license, \|`
9	`// \| that is bundled with this package in the file LICENSE, and is \|`	9	`// \| that is bundled with this package in the file LICENSE, and is \|`
10	`// \| available at through the world-wide-web at \|`	10	`// \| available at through the world-wide-web at \|`
11	`// \| http://www.php.net/license/2_02.txt. \|`	11	`// \| http://www.php.net/license/2_02.txt. \|`
12	`// \| If you did not receive a copy of the PHP license and are unable to \|`	12	`// \| If you did not receive a copy of the PHP license and are unable to \|`
13	`// \| obtain it through the world-wide-web, please send a note to \|`	13	`// \| obtain it through the world-wide-web, please send a note to \|`
14	`// \| license@php.net so we can mail you a copy immediately. \|`	14	`// \| license@php.net so we can mail you a copy immediately. \|`
15	`// +----------------------------------------------------------------------+`	15	`// +----------------------------------------------------------------------+`
16	`// \| Authors: Adam Daniel <adaniel1@eesus.jnj.com> \|`	16	`// \| Authors: Adam Daniel <adaniel1@eesus.jnj.com> \|`
17	`// \| Bertrand Mansion <bmansion@mamasam.com> \|`	17	`// \| Bertrand Mansion <bmansion@mamasam.com> \|`
18	`// +----------------------------------------------------------------------+`	18	`// +----------------------------------------------------------------------+`
19	`//`	19	`//`
20	`// $Id: select.php,v 1.1 2005-03-30 08:50:33 jpm Exp $`	20	`// $Id: select.php,v 1.2 2005-09-20 17:01:22 ddelon Exp $`
21		21
22	`require_once('HTML/QuickForm/element.php');`	22	`require_once('HTML/QuickForm/element.php');`
23		23
24	`/**`	24	`/**`
25	`* Class to dynamically create an HTML SELECT`	25	`* Class to dynamically create an HTML SELECT`
26	`*`	26	`*`
27	`* @author Adam Daniel <adaniel1@eesus.jnj.com>`	27	`* @author Adam Daniel <adaniel1@eesus.jnj.com>`
28	`* @author Bertrand Mansion <bmansion@mamasam.com>`	28	`* @author Bertrand Mansion <bmansion@mamasam.com>`
29	`* @version 1.0`	29	`* @version 1.0`
30	`* @since PHP4.04pl1`	30	`* @since PHP4.04pl1`
31	`* @access public`	31	`* @access public`
32	`*/`	32	`*/`
33	`class HTML_QuickForm_select extends HTML_QuickForm_element {`	33	`class HTML_QuickForm_select extends HTML_QuickForm_element {`
34		34
35	`// {{{ properties`	35	`// {{{ properties`
36		36
37	`/**`	37	`/**`
38	`* Contains the select options`	38	`* Contains the select options`
39	`*`	39	`*`
40	`* @var array`	40	`* @var array`
41	`* @since 1.0`	41	`* @since 1.0`
42	`* @access private`	42	`* @access private`
43	`*/`	43	`*/`
44	`var $_options = array();`	44	`var $_options = array();`
45		45
46	`/**`	46	`/**`
47	`* Default values of the SELECT`	47	`* Default values of the SELECT`
48	`*`	48	`*`
49	`* @var string`	49	`* @var string`
50	`* @since 1.0`	50	`* @since 1.0`
51	`* @access private`	51	`* @access private`
52	`*/`	52	`*/`
53	`var $_values = null;`	53	`var $_values = null;`
54		54
55	`// }}}`	55	`// }}}`
56	`// {{{ constructor`	56	`// {{{ constructor`
57		57
58	`/**`	58	`/**`
59	`* Class constructor`	59	`* Class constructor`
60	`*`	60	`*`
61	`* @param string Select name attribute`	61	`* @param string Select name attribute`
62	`* @param mixed Label(s) for the select`	62	`* @param mixed Label(s) for the select`
63	`* @param mixed Data to be used to populate options`	63	`* @param mixed Data to be used to populate options`
64	`* @param mixed Either a typical HTML attribute string or an associative array`	64	`* @param mixed Either a typical HTML attribute string or an associative array`
65	`* @since 1.0`	65	`* @since 1.0`
66	`* @access public`	66	`* @access public`
67	`* @return void`	67	`* @return void`
68	`*/`	68	`*/`
69	`function HTML_QuickForm_select($elementName=null, $elementLabel=null, $options=null, $attributes=null)`	69	`function HTML_QuickForm_select($elementName=null, $elementLabel=null, $options=null, $attributes=null)`
70	`{`	70	`{`
71	`HTML_QuickForm_element::HTML_QuickForm_element($elementName, $elementLabel, $attributes);`	71	`HTML_QuickForm_element::HTML_QuickForm_element($elementName, $elementLabel, $attributes);`
72	`$this->_persistantFreeze = true;`	72	`$this->_persistantFreeze = true;`
73	`$this->_type = 'select';`	73	`$this->_type = 'select';`
74	`if (isset($options)) {`	74	`if (isset($options)) {`
75	`$this->load($options);`	75	`$this->load($options);`
76	`}`	76	`}`
77	`} //end constructor`	77	`} //end constructor`
78		78
79	`// }}}`	79	`// }}}`
80	`// {{{ apiVersion()`	80	`// {{{ apiVersion()`
81		81
82	`/**`	82	`/**`
83	`* Returns the current API version`	83	`* Returns the current API version`
84	`*`	84	`*`
85	`* @since 1.0`	85	`* @since 1.0`
86	`* @access public`	86	`* @access public`
87	`* @return double`	87	`* @return double`
88	`*/`	88	`*/`
89	`function apiVersion()`	89	`function apiVersion()`
90	`{`	90	`{`
91	`return 2.3;`	91	`return 2.3;`
92	`} //end func apiVersion`	92	`} //end func apiVersion`
93		93
94	`// }}}`	94	`// }}}`
95	`// {{{ setSelected()`	95	`// {{{ setSelected()`
96		96
97	`/**`	97	`/**`
98	`* Sets the default values of the select box`	98	`* Sets the default values of the select box`
99	`*`	99	`*`
100	`* @param mixed $values Array or comma delimited string of selected values`	100	`* @param mixed $values Array or comma delimited string of selected values`
101	`* @since 1.0`	101	`* @since 1.0`
102	`* @access public`	102	`* @access public`
103	`* @return void`	103	`* @return void`
104	`*/`	104	`*/`
105	`function setSelected($values)`	105	`function setSelected($values)`
106	`{`	106	`{`
107	`if (is_string($values) && $this->getMultiple()) {`	107	`if (is_string($values) && $this->getMultiple()) {`
108	`$values = split("[ ]?,[ ]?", $values);`	108	`$values = split("[ ]?,[ ]?", $values);`
109	`}`	109	`}`
110	`if (is_array($values)) {`	110	`if (is_array($values)) {`
111	`$this->_values = array_values($values);`	111	`$this->_values = array_values($values);`
112	`} else {`	112	`} else {`
113	`$this->_values = array($values);`	113	`$this->_values = array($values);`
114	`}`	114	`}`
115	`} //end func setSelected`	115	`} //end func setSelected`
116		116
117	`// }}}`	117	`// }}}`
118	`// {{{ getSelected()`	118	`// {{{ getSelected()`
119		119
120	`/**`	120	`/**`
121	`* Returns an array of the selected values`	121	`* Returns an array of the selected values`
122	`*`	122	`*`
123	`* @since 1.0`	123	`* @since 1.0`
124	`* @access public`	124	`* @access public`
125	`* @return array of selected values`	125	`* @return array of selected values`
126	`*/`	126	`*/`
127	`function getSelected()`	127	`function getSelected()`
128	`{`	128	`{`
129	`return $this->_values;`	129	`return $this->_values;`
130	`} // end func getSelected`	130	`} // end func getSelected`
131		131
132	`// }}}`	132	`// }}}`
133	`// {{{ setName()`	133	`// {{{ setName()`
134		134
135	`/**`	135	`/**`
136	`* Sets the input field name`	136	`* Sets the input field name`
137	`*`	137	`*`
138	`* @param string $name Input field name attribute`	138	`* @param string $name Input field name attribute`
139	`* @since 1.0`	139	`* @since 1.0`
140	`* @access public`	140	`* @access public`
141	`* @return void`	141	`* @return void`
142	`*/`	142	`*/`
143	`function setName($name)`	143	`function setName($name)`
144	`{`	144	`{`
145	`$this->updateAttributes(array('name' => $name));`	145	`$this->updateAttributes(array('name' => $name));`
146	`} //end func setName`	146	`} //end func setName`
147		147
148	`// }}}`	148	`// }}}`
149	`// {{{ getName()`	149	`// {{{ getName()`
150		150
151	`/**`	151	`/**`
152	`* Returns the element name`	152	`* Returns the element name`
153	`*`	153	`*`
154	`* @since 1.0`	154	`* @since 1.0`
155	`* @access public`	155	`* @access public`
156	`* @return string`	156	`* @return string`
157	`*/`	157	`*/`
158	`function getName()`	158	`function getName()`
159	`{`	159	`{`
160	`return $this->getAttribute('name');`	160	`return $this->getAttribute('name');`
161	`} //end func getName`	161	`} //end func getName`
162		162
163	`// }}}`	163	`// }}}`
164	`// {{{ getPrivateName()`	164	`// {{{ getPrivateName()`
165		165
166	`/**`	166	`/**`
167	`* Returns the element name (possibly with brackets appended)`	167	`* Returns the element name (possibly with brackets appended)`
168	`*`	168	`*`
169	`* @since 1.0`	169	`* @since 1.0`
170	`* @access public`	170	`* @access public`
171	`* @return string`	171	`* @return string`
172	`*/`	172	`*/`
173	`function getPrivateName()`	173	`function getPrivateName()`
174	`{`	174	`{`
175	`if ($this->getAttribute('multiple')) {`	175	`if ($this->getAttribute('multiple')) {`
176	`return $this->getName() . '[]';`	176	`return $this->getName() . '[]';`
177	`} else {`	177	`} else {`
178	`return $this->getName();`	178	`return $this->getName();`
179	`}`	179	`}`
180	`} //end func getPrivateName`	180	`} //end func getPrivateName`
181		181
182	`// }}}`	182	`// }}}`
183	`// {{{ setValue()`	183	`// {{{ setValue()`
184		184
185	`/**`	185	`/**`
186	`* Sets the value of the form element`	186	`* Sets the value of the form element`
187	`*`	187	`*`
188	`* @param mixed $values Array or comma delimited string of selected values`	188	`* @param mixed $values Array or comma delimited string of selected values`
189	`* @since 1.0`	189	`* @since 1.0`
190	`* @access public`	190	`* @access public`
191	`* @return void`	191	`* @return void`
192	`*/`	192	`*/`
193	`function setValue($value)`	193	`function setValue($value)`
194	`{`	194	`{`
195	`$this->setSelected($value);`	195	`$this->setSelected($value);`
196	`} // end func setValue`	196	`} // end func setValue`
197		197
198	`// }}}`	198	`// }}}`
199	`// {{{ getValue()`	199	`// {{{ getValue()`
200		200
201	`/**`	201	`/**`
202	`* Returns an array of the selected values`	202	`* Returns an array of the selected values`
203	`*`	203	`*`
204	`* @since 1.0`	204	`* @since 1.0`
205	`* @access public`	205	`* @access public`
206	`* @return array of selected values`	206	`* @return array of selected values`
207	`*/`	207	`*/`
208	`function getValue()`	208	`function getValue()`
209	`{`	209	`{`
210	`return $this->_values;`	210	`return $this->_values;`
211	`} // end func getValue`	211	`} // end func getValue`
212		212
213	`// }}}`	213	`// }}}`
214	`// {{{ setSize()`	214	`// {{{ setSize()`
215		215
216	`/**`	216	`/**`
217	`* Sets the select field size, only applies to 'multiple' selects`	217	`* Sets the select field size, only applies to 'multiple' selects`
218	`*`	218	`*`
219	`* @param int $size Size of select field`	219	`* @param int $size Size of select field`
220	`* @since 1.0`	220	`* @since 1.0`
221	`* @access public`	221	`* @access public`
222	`* @return void`	222	`* @return void`
223	`*/`	223	`*/`
224	`function setSize($size)`	224	`function setSize($size)`
225	`{`	225	`{`
226	`$this->updateAttributes(array('size' => $size));`	226	`$this->updateAttributes(array('size' => $size));`
227	`} //end func setSize`	227	`} //end func setSize`
228		228
229	`// }}}`	229	`// }}}`
230	`// {{{ getSize()`	230	`// {{{ getSize()`
231		231
232	`/**`	232	`/**`
233	`* Returns the select field size`	233	`* Returns the select field size`
234	`*`	234	`*`
235	`* @since 1.0`	235	`* @since 1.0`
236	`* @access public`	236	`* @access public`
237	`* @return int`	237	`* @return int`
238	`*/`	238	`*/`
239	`function getSize()`	239	`function getSize()`
240	`{`	240	`{`
241	`return $this->getAttribute('size');`	241	`return $this->getAttribute('size');`
242	`} //end func getSize`	242	`} //end func getSize`
243		243
244	`// }}}`	244	`// }}}`
245	`// {{{ setMultiple()`	245	`// {{{ setMultiple()`
246		246
247	`/**`	247	`/**`
248	`* Sets the select mutiple attribute`	248	`* Sets the select mutiple attribute`
249	`*`	249	`*`
250	`* @param bool $multiple Whether the select supports multi-selections`	250	`* @param bool $multiple Whether the select supports multi-selections`
251	`* @since 1.2`	251	`* @since 1.2`
252	`* @access public`	252	`* @access public`
253	`* @return void`	253	`* @return void`
254	`*/`	254	`*/`
255	`function setMultiple($multiple)`	255	`function setMultiple($multiple)`
256	`{`	256	`{`
257	`if ($multiple) {`	257	`if ($multiple) {`
258	`$this->updateAttributes(array('multiple' => 'multiple'));`	258	`$this->updateAttributes(array('multiple' => 'multiple'));`
259	`} else {`	259	`} else {`
260	`$this->removeAttribute('multiple');`	260	`$this->removeAttribute('multiple');`
261	`}`	261	`}`
262	`} //end func setMultiple`	262	`} //end func setMultiple`
263		263
264	`// }}}`	264	`// }}}`
265	`// {{{ getMultiple()`	265	`// {{{ getMultiple()`
266		266
267	`/**`	267	`/**`
268	`* Returns the select mutiple attribute`	268	`* Returns the select mutiple attribute`
269	`*`	269	`*`
270	`* @since 1.2`	270	`* @since 1.2`
271	`* @access public`	271	`* @access public`
272	`* @return bool true if multiple select, false otherwise`	272	`* @return bool true if multiple select, false otherwise`
273	`*/`	273	`*/`
274	`function getMultiple()`	274	`function getMultiple()`
275	`{`	275	`{`
276	`return (bool)$this->getAttribute('multiple');`	276	`return (bool)$this->getAttribute('multiple');`
277	`} //end func getMultiple`	277	`} //end func getMultiple`
278		278
279	`// }}}`	279	`// }}}`
280	`// {{{ addOption()`	280	`// {{{ addOption()`
281		281
282	`/**`	282	`/**`
283	`* Adds a new OPTION to the SELECT`	283	`* Adds a new OPTION to the SELECT`
284	`*`	284	`*`
285	`* @param string $text Display text for the OPTION`	285	`* @param string $text Display text for the OPTION`
286	`* @param string $value Value for the OPTION`	286	`* @param string $value Value for the OPTION`
287	`* @param mixed $attributes Either a typical HTML attribute string`	287	`* @param mixed $attributes Either a typical HTML attribute string`
288	`* or an associative array`	288	`* or an associative array`
289	`* @since 1.0`	289	`* @since 1.0`
290	`* @access public`	290	`* @access public`
291	`* @return void`	291	`* @return void`
292	`*/`	292	`*/`
293	`function addOption($text, $value, $attributes=null)`	293	`function addOption($text, $value, $attributes=null)`
294	`{`	294	`{`
295	`if (null === $attributes) {`	295	`if (null === $attributes) {`
296	`$attributes = array('value' => $value);`	296	`$attributes = array('value' => $value);`
297	`} else {`	297	`} else {`
298	`$attributes = $this->_parseAttributes($attributes);`	298	`$attributes = $this->_parseAttributes($attributes);`
299	`if (isset($attributes['selected'])) {`	299	`if (isset($attributes['selected'])) {`
300	`// the 'selected' attribute will be set in toHtml()`	300	`// the 'selected' attribute will be set in toHtml()`
301	`$this->_removeAttr('selected', $attributes);`	301	`$this->_removeAttr('selected', $attributes);`
302	`if (is_null($this->_values)) {`	302	`if (is_null($this->_values)) {`
303	`$this->_values = array($value);`	303	`$this->_values = array($value);`
304	`} elseif (!in_array($value, $this->_values)) {`	304	`} elseif (!in_array($value, $this->_values)) {`
305	`$this->_values[] = $value;`	305	`$this->_values[] = $value;`
306	`}`	306	`}`
307	`}`	307	`}`
308	`$this->_updateAttrArray($attributes, array('value' => $value));`	308	`$this->_updateAttrArray($attributes, array('value' => $value));`
309	`}`	309	`}`
310	`$this->_options[] = array('text' => $text, 'attr' => $attributes);`	310	`$this->_options[] = array('text' => $text, 'attr' => $attributes);`
311	`} // end func addOption`	311	`} // end func addOption`
312		312
313	`// }}}`	313	`// }}}`
314	`// {{{ loadArray()`	314	`// {{{ loadArray()`
315		315
316	`/**`	316	`/**`
317	`* Loads the options from an associative array`	317	`* Loads the options from an associative array`
318	`*`	318	`*`
319	`* @param array $arr Associative array of options`	319	`* @param array $arr Associative array of options`
320	`* @param mixed $values (optional) Array or comma delimited string of selected values`	320	`* @param mixed $values (optional) Array or comma delimited string of selected values`
321	`* @since 1.0`	321	`* @since 1.0`
322	`* @access public`	322	`* @access public`
323	`* @return PEAR_Error on error or true`	323	`* @return PEAR_Error on error or true`
324	`* @throws PEAR_Error`	324	`* @throws PEAR_Error`
325	`*/`	325	`*/`
326	`function loadArray($arr, $values=null)`	326	`function loadArray($arr, $values=null)`
327	`{`	327	`{`
328	`if (!is_array($arr)) {`	328	`if (!is_array($arr)) {`
329	`return PEAR::raiseError('Argument 1 of HTML_Select::loadArray is not a valid array');`	329	`return PEAR::raiseError('Argument 1 of HTML_Select::loadArray is not a valid array');`
330	`}`	330	`}`
331	`if (isset($values)) {`	331	`if (isset($values)) {`
332	`$this->setSelected($values);`	332	`$this->setSelected($values);`
333	`}`	333	`}`
334	`foreach ($arr as $key => $val) {`	334	`foreach ($arr as $key => $val) {`
335	`// Warning: new API since release 2.3`	335	`// Warning: new API since release 2.3`
336	`$this->addOption($val, $key);`	336	`$this->addOption($val, $key);`
337	`}`	337	`}`
338	`return true;`	338	`return true;`
339	`} // end func loadArray`	339	`} // end func loadArray`
340		340
341	`// }}}`	341	`// }}}`
342	`// {{{ loadDbResult()`	342	`// {{{ loadDbResult()`
343		343
344	`/**`	344	`/**`
345	`* Loads the options from DB_result object`	345	`* Loads the options from DB_result object`
346	`*`	346	`*`
347	`* If no column names are specified the first two columns of the result are`	347	`* If no column names are specified the first two columns of the result are`
348	`* used as the text and value columns respectively`	348	`* used as the text and value columns respectively`
349	`* @param object $result DB_result object`	349	`* @param object $result DB_result object`
350	`* @param string $textCol (optional) Name of column to display as the OPTION text`	350	`* @param string $textCol (optional) Name of column to display as the OPTION text`
351	`* @param string $valueCol (optional) Name of column to use as the OPTION value`	351	`* @param string $valueCol (optional) Name of column to use as the OPTION value`
352	`* @param mixed $values (optional) Array or comma delimited string of selected values`	352	`* @param mixed $values (optional) Array or comma delimited string of selected values`
353	`* @since 1.0`	353	`* @since 1.0`
354	`* @access public`	354	`* @access public`
355	`* @return PEAR_Error on error or true`	355	`* @return PEAR_Error on error or true`
356	`* @throws PEAR_Error`	356	`* @throws PEAR_Error`
357	`*/`	357	`*/`
358	`function loadDbResult(&$result, $textCol=null, $valueCol=null, $values=null)`	358	`function loadDbResult(&$result, $textCol=null, $valueCol=null, $values=null)`
359	`{`	359	`{`
360	`if (!is_object($result) \|\| !is_a($result, 'db_result')) {`	360	`if (!is_object($result) \|\| !is_a($result, 'db_result')) {`
361	`return PEAR::raiseError('Argument 1 of HTML_Select::loadDbResult is not a valid DB_result');`	361	`return PEAR::raiseError('Argument 1 of HTML_Select::loadDbResult is not a valid DB_result');`
362	`}`	362	`}`
363	`if (isset($values)) {`	363	`if (isset($values)) {`
364	`$this->setValue($values);`	364	`$this->setValue($values);`
365	`}`	365	`}`
366	`$fetchMode = ($textCol && $valueCol) ? DB_FETCHMODE_ASSOC : DB_FETCHMODE_DEFAULT;`	366	`$fetchMode = ($textCol && $valueCol) ? DB_FETCHMODE_ASSOC : DB_FETCHMODE_DEFAULT;`
367	`while (is_array($row = $result->fetchRow($fetchMode)) ) {`	367	`while (is_array($row = $result->fetchRow($fetchMode)) ) {`
368	`if ($fetchMode == DB_FETCHMODE_ASSOC) {`	368	`if ($fetchMode == DB_FETCHMODE_ASSOC) {`
369	`$this->addOption($row[$textCol], $row[$valueCol]);`	369	`$this->addOption($row[$textCol], $row[$valueCol]);`
370	`} else {`	370	`} else {`
371	`$this->addOption($row[0], $row[1]);`	371	`$this->addOption($row[0], $row[1]);`
372	`}`	372	`}`
373	`}`	373	`}`
374	`return true;`	374	`return true;`
375	`} // end func loadDbResult`	375	`} // end func loadDbResult`
376		376
377	`// }}}`	377	`// }}}`
378	`// {{{ loadQuery()`	378	`// {{{ loadQuery()`
379		379
380	`/**`	380	`/**`
381	`* Queries a database and loads the options from the results`	381	`* Queries a database and loads the options from the results`
382	`*`	382	`*`
383	`* @param mixed $conn Either an existing DB connection or a valid dsn`	383	`* @param mixed $conn Either an existing DB connection or a valid dsn`
384	`* @param string $sql SQL query string`	384	`* @param string $sql SQL query string`
385	`* @param string $textCol (optional) Name of column to display as the OPTION text`	385	`* @param string $textCol (optional) Name of column to display as the OPTION text`
386	`* @param string $valueCol (optional) Name of column to use as the OPTION value`	386	`* @param string $valueCol (optional) Name of column to use as the OPTION value`
387	`* @param mixed $values (optional) Array or comma delimited string of selected values`	387	`* @param mixed $values (optional) Array or comma delimited string of selected values`
388	`* @since 1.1`	388	`* @since 1.1`
389	`* @access public`	389	`* @access public`
390	`* @return void`	390	`* @return void`
391	`* @throws PEAR_Error`	391	`* @throws PEAR_Error`
392	`*/`	392	`*/`
393	`function loadQuery(&$conn, $sql, $textCol=null, $valueCol=null, $values=null)`	393	`function loadQuery(&$conn, $sql, $textCol=null, $valueCol=null, $values=null)`
394	`{`	394	`{`
395	`if (is_string($conn)) {`	395	`if (is_string($conn)) {`
396	`require_once('DB.php');`	396	`require_once('DB.php');`
397	`$dbConn = &DB::connect($conn, true);`	397	`$dbConn = &DB::connect($conn, true);`
398	`if (DB::isError($dbConn)) {`	398	`if (DB::isError($dbConn)) {`
399	`return $dbConn;`	399	`return $dbConn;`
400	`}`	400	`}`
401	`} elseif (is_subclass_of($conn, "db_common")) {`	401	`} elseif (is_subclass_of($conn, "db_common")) {`
402	`$dbConn = &$conn;`	402	`$dbConn = &$conn;`
403	`} else {`	403	`} else {`
404	`return PEAR::raiseError('Argument 1 of HTML_Select::loadQuery is not a valid type');`	404	`return PEAR::raiseError('Argument 1 of HTML_Select::loadQuery is not a valid type');`
405	`}`	405	`}`
406	`$result = $dbConn->query($sql);`	406	`$result = $dbConn->query($sql);`
407	`if (DB::isError($result)) {`	407	`if (DB::isError($result)) {`
408	`return $result;`	408	`return $result;`
409	`}`	409	`}`
410	`$this->loadDbResult($result, $textCol, $valueCol, $values);`	410	`$this->loadDbResult($result, $textCol, $valueCol, $values);`
411	`$result->free();`	411	`$result->free();`
412	`if (is_string($conn)) {`	412	`if (is_string($conn)) {`
413	`$dbConn->disconnect();`	413	`$dbConn->disconnect();`
414	`}`	414	`}`
415	`return true;`	415	`return true;`
416	`} // end func loadQuery`	416	`} // end func loadQuery`
417		417
418	`// }}}`	418	`// }}}`
419	`// {{{ load()`	419	`// {{{ load()`
420		420
421	`/**`	421	`/**`
422	`* Loads options from different types of data sources`	422	`* Loads options from different types of data sources`
423	`*`	423	`*`
424	`* This method is a simulated overloaded method. The arguments, other than the`	424	`* This method is a simulated overloaded method. The arguments, other than the`
425	`* first are optional and only mean something depending on the type of the first argument.`	425	`* first are optional and only mean something depending on the type of the first argument.`
426	`* If the first argument is an array then all arguments are passed in order to loadArray.`	426	`* If the first argument is an array then all arguments are passed in order to loadArray.`
427	`* If the first argument is a db_result then all arguments are passed in order to loadDbResult.`	427	`* If the first argument is a db_result then all arguments are passed in order to loadDbResult.`
428	`* If the first argument is a string or a DB connection then all arguments are`	428	`* If the first argument is a string or a DB connection then all arguments are`
429	`* passed in order to loadQuery.`	429	`* passed in order to loadQuery.`
430	`* @param mixed $options Options source currently supports assoc array or DB_result`	430	`* @param mixed $options Options source currently supports assoc array or DB_result`
431	`* @param mixed $param1 (optional) See function detail`	431	`* @param mixed $param1 (optional) See function detail`
432	`* @param mixed $param2 (optional) See function detail`	432	`* @param mixed $param2 (optional) See function detail`
433	`* @param mixed $param3 (optional) See function detail`	433	`* @param mixed $param3 (optional) See function detail`
434	`* @param mixed $param4 (optional) See function detail`	434	`* @param mixed $param4 (optional) See function detail`
435	`* @since 1.1`	435	`* @since 1.1`
436	`* @access public`	436	`* @access public`
437	`* @return PEAR_Error on error or true`	437	`* @return PEAR_Error on error or true`
438	`* @throws PEAR_Error`	438	`* @throws PEAR_Error`
439	`*/`	439	`*/`
440	`function load(&$options, $param1=null, $param2=null, $param3=null, $param4=null)`	440	`function load(&$options, $param1=null, $param2=null, $param3=null, $param4=null)`
441	`{`	441	`{`
442	`switch (true) {`	442	`switch (true) {`
443	`case is_array($options):`	443	`case is_array($options):`
444	`return $this->loadArray($options, $param1);`	444	`return $this->loadArray($options, $param1);`
445	`break;`	445	`break;`
446	`case (is_a($options, 'db_result')):`	446	`case (is_a($options, 'db_result')):`
447	`return $this->loadDbResult($options, $param1, $param2, $param3);`	447	`return $this->loadDbResult($options, $param1, $param2, $param3);`
448	`break;`	448	`break;`
449	`case (is_string($options) && !empty($options) \|\| is_subclass_of($options, "db_common")):`	449	`case (is_string($options) && !empty($options) ):`
450	`return $this->loadQuery($options, $param1, $param2, $param3, $param4);`	450	`return $this->loadQuery($options, $param1, $param2, $param3, $param4);`
451	`break;`	451	`break;`
452	`}`	452	`}`
453	`} // end func load`	453	`} // end func load`
454		454
455	`// }}}`	455	`// }}}`
456	`// {{{ toHtml()`	456	`// {{{ toHtml()`
457		457
458	`/**`	458	`/**`
459	`* Returns the SELECT in HTML`	459	`* Returns the SELECT in HTML`
460	`*`	460	`*`
461	`* @since 1.0`	461	`* @since 1.0`
462	`* @access public`	462	`* @access public`
463	`* @return string`	463	`* @return string`
464	`*/`	464	`*/`
465	`function toHtml()`	465	`function toHtml()`
466	`{`	466	`{`
467	`if ($this->_flagFrozen) {`	467	`if ($this->_flagFrozen) {`
468	`return $this->getFrozenHtml();`	468	`return $this->getFrozenHtml();`
469	`} else {`	469	`} else {`
470	`$tabs = $this->_getTabs();`	470	`$tabs = $this->_getTabs();`
471	`$strHtml = '';`	471	`$strHtml = '';`
472		472
473	`if ($this->getComment() != '') {`	473	`if ($this->getComment() != '') {`
474	`$strHtml .= $tabs . '<!-- ' . $this->getComment() . " //-->\n";`	474	`$strHtml .= $tabs . '<!-- ' . $this->getComment() . " //-->\n";`
475	`}`	475	`}`
476		476
477	`if (!$this->getMultiple()) {`	477	`if (!$this->getMultiple()) {`
478	`$attrString = $this->_getAttrString($this->_attributes);`	478	`$attrString = $this->_getAttrString($this->_attributes);`
479	`} else {`	479	`} else {`
480	`$myName = $this->getName();`	480	`$myName = $this->getName();`
481	`$this->setName($myName . '[]');`	481	`$this->setName($myName . '[]');`
482	`$attrString = $this->_getAttrString($this->_attributes);`	482	`$attrString = $this->_getAttrString($this->_attributes);`
483	`$this->setName($myName);`	483	`$this->setName($myName);`
484	`}`	484	`}`
485	`$strHtml .= $tabs . '<select' . $attrString . ">\n";`	485	`$strHtml .= $tabs . '<select' . $attrString . ">\n";`
486		486
487	`foreach ($this->_options as $option) {`	487	`foreach ($this->_options as $option) {`
488	`if (is_array($this->_values) && in_array((string)$option['attr']['value'], $this->_values)) {`	488	`if (is_array($this->_values) && in_array((string)$option['attr']['value'], $this->_values)) {`
489	`$this->_updateAttrArray($option['attr'], array('selected' => 'selected'));`	489	`$this->_updateAttrArray($option['attr'], array('selected' => 'selected'));`
490	`}`	490	`}`
491	`$strHtml .= $tabs . "\t<option" . $this->_getAttrString($option['attr']) . '>' .`	491	`$strHtml .= $tabs . "\t<option" . $this->_getAttrString($option['attr']) . '>' .`
492	`$option['text'] . "</option>\n";`	492	`$option['text'] . "</option>\n";`
493	`}`	493	`}`
494		494
495	`return $strHtml . $tabs . '</select>';`	495	`return $strHtml . $tabs . '</select>';`
496	`}`	496	`}`
497	`} //end func toHtml`	497	`} //end func toHtml`
498		498
499	`// }}}`	499	`// }}}`
500	`// {{{ getFrozenHtml()`	500	`// {{{ getFrozenHtml()`

Subversion Repositories Applications.papyrus

(root)/trunk/api/pear/HTML/QuickForm/select.php – Rev 320 → 443