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

    protected $value = array();

    private $inline;

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

    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 getOptions($encode = 0)
    {
        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 getInline()
    {
        if ($this->inline == true) {
            return ' inline';
        } else {
            return '';
        }
    }

    public function render()
    {
        $required = $this->hasAttribute('required');
        $ele_options = $this->getOptions();
        $ele_value = $this->getValue();
        if (!is_array($ele_value)) {
            $ele_value = (array) $ele_value;
        }
        $extra = ($this->getExtra() != '' ? " " . $this->getExtra() : '');

        $ele_name = $this->getName();
        $ele_id = $ele_name;
        if (count($ele_options) > 1 && substr($ele_name, -2, 2) != '[]') {
            $ele_name = $ele_name . '[]';
            $this->setName($ele_name);
            // If required is set, all checkboxes will be required by the browser,
            // which is not usually useful. We stash the value of required above
            // and unset now. We restore it before return so JS validation will still
            // be triggered. This is only a problem if there is more than one checkbox.
            $this->unsetAttribute('required');
        }

        $ret = "";
        $id_ele = 0;
        foreach ($ele_options as $value => $name) {
            $this->unsetAttribute('checked');
            if (!empty($ele_value) && in_array($value, $ele_value)) {
                $this->setAttribute('checked');
            }
            $this->setAttribute('value', $value);
            ++$id_ele;
            $this->setAttribute('id', $ele_id . $id_ele);
            $ret .= '<label class="checkbox' . $this->getInline() . '">' . NWLINE;
            $ret .= '<input ' . $this->renderAttributeString() . $extra . '>' . NWLINE;
            $ret .= $name . NWLINE;
            $ret .= "</label>" . NWLINE;
        }
        if ($required) {
            $this->setAttribute('required');
        }
        return $ret;
    }

    public function renderValidationJS()
    {
        // render custom validation code if any
        if (!empty($this->customValidationCode)) {
            return implode(NWLINE, $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 NWLINE . "var hasChecked = false; var checkBox = myform.elements['{$eltname}']; if (checkBox.length) {for (var i = 0; i < checkBox.length; i++) {if (checkBox[i].checked == true) {hasChecked = true; break;}}}else{if (checkBox.checked == true) {hasChecked = true;}}if (!hasChecked) {window.alert(\"{$eltmsg}\");if (checkBox.length) {checkBox[0].focus();}else{checkBox.focus();}return false;}";
        }
        return '';
    }
}