Mage_Core_Block_Html_Select Class Reference

Inheritance diagram for Mage_Core_Block_Html_Select:

List of all members.

Public Member Functions
	getOptions ()
	setOptions ($options)
	addOption ($value, $label, $params=array())
	setId ($id)
	setClass ($class)
	setTitle ($title)
	getId ()
	getClass ()
	getTitle ()
	getHtml ()
Protected Member Functions
	_toHtml ()
	_optionToHtml ($option, $selected=false)
Protected Attributes
	$_options = array()

---

Detailed Description

Definition at line 35 of file Select.php.

---

Member Function Documentation

_optionToHtml	(	$	option,
		$	selected = false
	)			[protected]

Definition at line 148 of file Select.php.

    {
        $selectedHtml = $selected ? ' selected="selected"' : '';
        $html = '<option value="'.$option['value'].'"'.$selectedHtml.'>'.$option['label'].'</option>';

        return $html;
    }

_toHtml

(

)

[protected]

Override this method in descendants to produce html

Returns:

string

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 90 of file Select.php.

    {
        if (!$this->_beforeToHtml()) {
            return '';
        }

        $html = '<select name="'.$this->getName().'" id="'.$this->getId().'" class="'
            .$this->getClass().'" title="'.$this->getTitle().'" '.$this->getExtraParams().'>';
        $values = $this->getValue();

        if (!is_array($values)){
            if (!is_null($values)) {
                $values = array($values);
            } else {
                $values = array();
            }
        }

        $isArrayOption = true;
        foreach ($this->getOptions() as $key => $option) {
            if ($isArrayOption && is_array($option)) {
                $value = $option['value'];
                $label = $option['label'];
            }
            else {
                $value = $key;
                $label = $option;
                $isArrayOption = false;
            }

            if (is_array($value)) {
                $html.= '<optgroup label="'.$label.'">';
                foreach ($value as $keyGroup => $optionGroup) {
                    if (!is_array($optionGroup)) {
                        $optionGroup = array(
                            'value' => $keyGroup,
                            'label' => $optionGroup
                        );
                    }
                    $html.= $this->_optionToHtml(
                        $optionGroup,
                        in_array($optionGroup['value'], $values)
                    );
                }
                $html.= '</optgroup>';
            } else {
                $html.= $this->_optionToHtml(array(
                    'value' => $value,
                    'label' => $label
                ),
                    in_array($value, $values)
                );
            }
        }
        $html.= '</select>';
        return $html;
    }

addOption	(	$	value,
		$	label,
		$	params = array()
	)

Definition at line 51 of file Select.php.

    {
        $this->_options[] = array('value'=>$value, 'label'=>$label);
        return $this;
    }

getClass

(

)

Definition at line 80 of file Select.php.

    {
        return $this->getData('class');
    }

getHtml

(

)

Definition at line 156 of file Select.php.

    {
        return $this->toHtml();
    }

getId

(

)

Retrieve object id

Returns:

mixed

Reimplemented from Varien_Object.

Definition at line 75 of file Select.php.

    {
        return $this->getData('id');
    }

getOptions

(

)

Definition at line 40 of file Select.php.

    {
        return $this->_options;
    }

getTitle

(

)

Definition at line 85 of file Select.php.

    {
        return $this->getData('title');
    }

setClass

(

$

class

)

Definition at line 63 of file Select.php.

    {
        $this->setData('class', $class);
        return $this;
    }

setId

(

$

value

)

Set object id field value

Parameters:

mixed

$value

Returns:

Varien_Object

Reimplemented from Varien_Object.

Definition at line 57 of file Select.php.

    {
        $this->setData('id', $id);
        return $this;
    }

setOptions

(

$

options

)

Definition at line 45 of file Select.php.

    {
        $this->_options = $options;
        return $this;
    }

setTitle

(

$

title

)

Definition at line 69 of file Select.php.

    {
        $this->setData('title', $title);
        return $this;
    }

---

Member Data Documentation

$_options = array() [protected]

Definition at line 38 of file Select.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Core/Block/Html/Select.php