Radio.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 Radio extends Element
{
    private $options = array();

    protected $value = null;

    private $inline;

    public function __construct($caption, $name, $value = null, $inline = true)
    {
        $this->setAttribute('type', 'radio');
        $this->setAttribute('name', $name);
        $this->setCaption($caption);
        if (isset($value)) {
            $this->setValue($value);
        }
        $this->inline = $inline;
    }

    public function getValue($encode = false)
    {
        return ($encode && $this->value !== null) ? htmlspecialchars($this->value, ENT_QUOTES) : $this->value;
    }

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

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

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

    public function getInline()
    {
        if ($this->inline == true) {
            return ' inline';
        } else {
            return '';
        }
    }

    public function render()
    {
        $ele_options = $this->getOptions();
        $ele_value = $this->getValue();
        $ele_name = $this->getName();
        $extra = ($this->getExtra() != '' ? " " . $this->getExtra() : '');
        $ret = "";
        static $id_ele = 0;
        foreach ($ele_options as $value => $buttonCaption) {
            $this->unsetAttribute('checked');
            if (isset($ele_value) && $value == $ele_value) {
                $this->setAttribute('checked');
            }
            $this->setAttribute('value', $value);
            ++$id_ele;
            $this->setAttribute('id', $ele_name . $id_ele);
            $ret .= '<label class="radio' . $this->getInline() . '">' . NWLINE;
            $ret .= '<input ' . $this->renderAttributeString() . $extra . ">" . NWLINE;
            $ret .= $buttonCaption . NWLINE;
            $ret .= "</label>" . NWLINE;
        }
        return $ret;
    }
}