File oops_lib/Xoops/Form/Checkbox.php

  1: <?php
  2: /*
  3:  You may not change or alter any portion of this comment or credits
  4:  of supporting developers from this source code or any supporting source code
  5:  which is considered copyrighted (c) material of the original comment or credit authors.
  6: 
  7:  This program is distributed in the hope that it will be useful,
  8:  but WITHOUT ANY WARRANTY; without even the implied warranty of
  9:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 10: */
 11: 
 12: namespace Xoops\Form;
 13: 
 14: /**
 15:  * Checkbox - a checkbox form element
 16:  *
 17:  * @category  Xoops\Form\Checkbox
 18:  * @package   Xoops\Form
 19:  * @author    Kazumi Ono <onokazu@xoops.org>
 20:  * @author    Skalpa Keo <skalpa@xoops.org>
 21:  * @author    Taiwen Jiang <phppp@users.sourceforge.net>
 22:  * @copyright 2001-2015 XOOPS Project (http://xoops.org)
 23:  * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 24:  * @link      http://xoops.org
 25:  */
 26: class Checkbox extends OptionElement
 27: {
 28:     /**
 29:      * pre-selected values in array
 30:      *
 31:      * @var array
 32:      */
 33:     protected $value = array();
 34: 
 35:     /**
 36:      * Constructor
 37:      *
 38:      * @param string|array $caption Caption or array of all attributes
 39:      *                               Control attributes:
 40:      *                                   :inline true to render with inline style
 41:      * @param string       $name    element name
 42:      * @param mixed        $value   value(s) to be set on display, either one value or an array of them.
 43:      * @param boolean      $inline  true for inline arrangement
 44:      */
 45:     public function __construct($caption, $name = null, $value = null, $inline = true)
 46:     {
 47:         if (is_array($caption)) {
 48:             parent::__construct($caption);
 49:             $this->setIfNotSet(':inline', true);
 50:         } else {
 51:             parent::__construct([]);
 52:             $this->setWithDefaults('caption', $caption, '');
 53:             $this->setWithDefaults('name', $name, 'name_error');
 54:             $this->set('value', $value);
 55:             $this->set(':inline', $inline);
 56:         }
 57:         $this->set('type', 'checkbox');
 58:     }
 59: 
 60:     /**
 61:      * prepare HTML for output
 62:      *
 63:      * @return string
 64:      */
 65:     public function render()
 66:     {
 67:         $required = $this->has('required');
 68:         $elementOptions = $this->getOptions();
 69:         $elementValue = $this->getValue();
 70:         if (!is_array($elementValue)) {
 71:             $elementValue = (array) $elementValue;
 72:         }
 73:         $extra = ($this->getExtra() != '' ? " " . $this->getExtra() : '');
 74: 
 75:         $elementName = $this->getName();
 76:         $elementId = $elementName;
 77:         if (count($elementOptions) > 1 && substr($elementName, -2, 2) !== '[]') {
 78:             $elementName = $elementName . '[]';
 79:             $this->setName($elementName);
 80:             // If required is set, all checkboxes will be required by the browser,
 81:             // which is not usually useful. We stash the value of required above
 82:             // and unset now. We restore it before return so JS validation will still
 83:             // be triggered. This is only a problem if there is more than one checkbox.
 84:             $this->remove('required');
 85:         }
 86: 
 87:         $ret = "";
 88:         $idCount = 0;
 89:         foreach ($elementOptions as $value => $name) {
 90:             $this->remove('checked');
 91:             if (!empty($elementValue) && in_array($value, $elementValue)) {
 92:                 $this->set('checked');
 93:             }
 94:             $this->set('value', $value);
 95:             ++$idCount;
 96:             $this->set('id', $elementId . $idCount);
 97:             $ret .= '<label class="checkbox' . ((bool) $this->get(':inline', false) ? ' inline' : '') . '">' . "\n";
 98:             $ret .= '<input ' . $this->renderAttributeString() . $extra . '>' . "\n";
 99:             $ret .= $name . "\n";
100:             $ret .= "</label>" . "\n";
101:         }
102:         if ($required) {
103:             $this->set('required');
104:         }
105:         return $ret;
106:     }
107: 
108:     /**
109:      * Render custom javascript validation code
110:      *
111:      * @return string
112:      */
113:     public function renderValidationJS()
114:     {
115:         // render custom validation code if any
116:         if (!empty($this->customValidationCode)) {
117:             return implode("\n", $this->customValidationCode);
118:             // generate validation code if required
119:         } elseif ($this->isRequired()) {
120:             $eltname = $this->getName();
121:             $eltcaption = $this->getCaption();
122:             $eltmsg = empty($eltcaption)
123:                 ? sprintf(\XoopsLocale::F_ENTER, $eltname)
124:                 : sprintf(\XoopsLocale::F_ENTER, $eltcaption);
125:             $eltmsg = str_replace('"', '\"', stripslashes($eltmsg));
126:             return "\n"
127:             . "var hasChecked = false; var checkBox = myform.elements['{$eltname}'];"
128:             . " if (checkBox.length) {for (var i = 0; i < checkBox.length; i++)"
129:             . " {if (checkBox[i].checked == true) {hasChecked = true; break;}}}"
130:             . "else{if (checkBox.checked == true) {hasChecked = true;}}"
131:             . "if (!hasChecked) {window.alert(\"{$eltmsg}\");if (checkBox.length)"
132:             . " {checkBox[0].focus();}else{checkBox.focus();}return false;}";
133:         }
134:         return '';
135:     }
136: }
137:
Namespaces

Classes

Interfaces

Exceptions

Functions
