Select.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

namespace Xoops\Form;

class Select extends Element
{
    private $options = array();

    //private $multiple = false;

    //private $size;

    protected $value = array();

    private $optgroup = array();

    public function __construct($caption, $name, $value = null, $size = 1, $multiple = false)
    {
        $this->setCaption($caption);
        $this->setAttribute('name', $name);
        $this->setAttribute('size', intval($size));
        if ($multiple) {
            $this->setAttribute('multiple');
        }
        if (isset($value)) {
            $this->setValue($value);
        }
    }

    public function isMultiple()
    {
        return $this->hasAttribute('multiple');
    }

    public function getSize()
    {
        return (int) $this->getAttribute('size');
    }

    public function addOption($value, $name = '')
    {
        if ($name != '') {
            $this->options[$value] = $name;
        } else {
            $this->options[$value] = $value;
        }
    }

    public function addOptionArray($options)
    {
        if (is_array($options)) {
            foreach ($options as $k => $v) {
                $this->addOption($k, $v);
            }
        }
    }

    public function addOptgroup($name, $optgroup)
    {
        $this->optgroup[$name] = $optgroup;
    }

    public function getOptions($encode = false)
    {
        if (!$encode) {
            return $this->options;
        }
        $value = array();
        foreach ($this->options as $val => $name) {
            $value[$encode ? htmlspecialchars($val, ENT_QUOTES) : $val] = ($encode > 1)
                ? htmlspecialchars($name, ENT_QUOTES) : $name;
        }
        return $value;
    }

    public function getOptgroup()
    {
        return $this->optgroup;
    }

    public function render()
    {
        $ele_value = $this->getValue();
        if (!is_array($ele_value)) {
            $ele_value = (array) $ele_value;
        }
        $ele_options = $this->getOptions();
        $ele_optgroup = $this->getOptgroup();

        $extra = ($this->getExtra() != '' ? " " . $this->getExtra() : '');
        $attributes = $this->renderAttributeString();
        $ret = '<select ' . $attributes . $extra .' >' . NWLINE;

        if (empty($ele_optgroup)) {
            foreach ($ele_options as $value => $name) {
                $ret .= '<option value="' . htmlspecialchars($value, ENT_QUOTES) . '"';
                if (count($ele_value) > 0 && in_array($value, $ele_value)) {
                    $ret .= ' selected="selected"';
                }
                $ret .= '>' . $name . '</option>' . NWLINE;
            }
        } else {
            foreach ($ele_optgroup as $name_optgroup => $value_optgroup) {
                $ret .= '<optgroup label="' . $name_optgroup . '">' . NWLINE;
                foreach ($value_optgroup as $value => $name) {
                    $ret .= '<option value="' . htmlspecialchars($value, ENT_QUOTES) . '"';
                    if (count($ele_value) > 0 && in_array($value, $ele_value)) {
                        $ret .= ' selected="selected"';
                    }
                    $ret .= '>' . $name . '</option>' . NWLINE;
                }
                $ret .= '</optgroup>' . NWLINE;
            }
        }
        $ret .= '</select>' . NWLINE;
        return $ret;
    }

    public function renderValidationJS()
    {
        // render custom validation code if any
        if (!empty($this->customValidationCode)) {
            return implode("\n", $this->customValidationCode);
            // generate validation code if required
        } elseif ($this->isRequired()) {
            $eltname = $this->getName();
            $eltcaption = $this->getCaption();
            $eltmsg = empty($eltcaption)
                ? sprintf(\XoopsLocale::F_ENTER, $eltname)
                : sprintf(\XoopsLocale::F_ENTER, $eltcaption);
            $eltmsg = str_replace('"', '\"', stripslashes($eltmsg));
            return "\nvar hasSelected = false; var selectBox = myform.{$eltname};"
                . "for (i = 0; i < selectBox.options.length; i++ ) { "
                . "if (selectBox.options[i].selected == true && selectBox.options[i].value != '') "
                . "{ hasSelected = true; break; } }" . "if (!hasSelected) "
                . "{ window.alert(\"{$eltmsg}\"); selectBox.focus(); return false; }";
        }
        return '';
    }
}