File oops_lib/Xoops/Form/GroupFormCheckbox.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:  * GroupFormCheckbox - checkbox options for a group permission form
 16:  *
 17:  * @category  Xoops\Form\GroupFormCheckbox
 18:  * @package   Xoops\Form
 19:  * @author    Xoops Development Team
 20:  * @copyright 2001-2015 XOOPS Project (http://xoops.org)
 21:  * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 22:  * @link      http://xoops.org
 23:  */
 24: class GroupFormCheckbox extends Element
 25: {
 26:     /**
 27:      * Group ID
 28:      *
 29:      * @var int
 30:      */
 31:     private $groupId;
 32: 
 33:     /**
 34:      * Option tree
 35:      *
 36:      * @var array
 37:      */
 38:     private $optionTree = array();
 39: 
 40:     /**
 41:      * __construct
 42:      *
 43:      * @param string|array $caption Caption or array of all attributes
 44:      * @param string       $name    element name
 45:      * @param integer      $groupId group id
 46:      * @param mixed        $values  values
 47:      */
 48:     public function __construct($caption, $name = null, $groupId = null, $values = null)
 49:     {
 50:         if (is_array($caption)) {
 51:             parent::__construct($caption);
 52:         } else {
 53:             parent::__construct([]);
 54:             $this->setCaption($caption);
 55:             $this->setName($name);
 56:             $this->setWithDefaults('value', (array) $values, []);
 57:             $this->set(':groupid', $groupId);
 58:         }
 59:         $this->groupId = $this->get(':groupid', 0);
 60:     }
 61: 
 62:     /**
 63:      * Sets the tree structure of items
 64:      *
 65:      * @param array $optionTree options
 66:      *
 67:      * @return void
 68:      */
 69:     public function setOptionTree(&$optionTree)
 70:     {
 71:         $this->optionTree = $optionTree;
 72:     }
 73: 
 74:     /**
 75:      * Renders checkbox options for this group
 76:      *
 77:      * @return string
 78:      */
 79:     public function render()
 80:     {
 81:         $ele_name = $this->getName();
 82:         $ret = '<table class="outer"><tr><td class="odd"><table><tr>';
 83:         $cols = 1;
 84: 
 85:         foreach ($this->optionTree[0]['children'] as $topitem) {
 86:             if ($cols > 4) {
 87:                 $ret .= '</tr><tr>';
 88:                 $cols = 1;
 89:             }
 90:             $tree = '<td valign="top">';
 91:             $prefix = '';
 92:             $this->renderOptionTree($tree, $this->optionTree[$topitem], $prefix);
 93:             $ret .= $tree . '</td>';
 94:             ++$cols;
 95:         }
 96:         $ret .= '</tr></table></td><td class="even" valign="top">';
 97:         $option_ids = array();
 98:         foreach (array_keys($this->optionTree) as $id) {
 99:             if (!empty($id)) {
100:                 $option_ids[] = "'" . $ele_name . '[groups][' . $this->groupId . '][' . $id . ']' . "'";
101:             }
102:         }
103:         $checkAllButtonId = $ele_name . '[checkallbtn][' . $this->groupId . ']';
104:         $option_ids_str = implode(', ', $option_ids);
105:         $ret .= \XoopsLocale::ALL . " <input id=\"" . $checkAllButtonId . "\" type=\"checkbox\" value=\"\" "
106:             . "onclick=\"var optionids = new Array(" . $option_ids_str . "); "
107:             . "xoopsCheckAllElements(optionids, '" . $checkAllButtonId . "');\" />";
108:         $ret .= '</td></tr></table>';
109:         return $ret;
110:     }
111: 
112:     /**
113:      * Renders checkbox options for an item tree
114:      *
115:      * @param string $tree      rendered tree by reference
116:      * @param array  $option    option
117:      * @param string $prefix    prefix
118:      * @param array  $parentIds parent ids
119:      *
120:      * @return void append
121:      */
122:     private function renderOptionTree(&$tree, $option, $prefix, $parentIds = array())
123:     {
124:         $elementName = $this->getName();
125:         $tree .= $prefix . "<input type=\"checkbox\" name=\"" . $elementName . "[groups]["
126:             . $this->groupId . "][" . $option['id'] . "]\" id=\"" . $elementName
127:             . "[groups][" . $this->groupId . "][" . $option['id'] . "]\" onclick=\"";
128:         // If there are parent elements, add javascript that will
129:         // make them selected when this element is checked to make
130:         // sure permissions to parent items are added as well.
131:         foreach ($parentIds as $pid) {
132:             $parent_ele = $elementName . '[groups][' . $this->groupId . '][' . $pid . ']';
133:             $tree .= "var ele = xoopsGetElementById('" . $parent_ele
134:                 . "'); if(ele.checked != true) {ele.checked = this.checked;}";
135:         }
136:         // If there are child elements, add javascript that will
137:         // make them unchecked when this element is unchecked to make
138:         // sure permissions to child items are not added when there
139:         // is no permission to this item.
140:         foreach ($option['allchild'] as $cid) {
141:             $child_ele = $elementName . '[groups][' . $this->groupId . '][' . $cid . ']';
142:             $tree .= "var ele = xoopsGetElementById('" . $child_ele
143:                 . "'); if(this.checked != true) {ele.checked = false;}";
144:         }
145:         $tree .= '" value="1"';
146:         if (in_array($option['id'], $this->get('value', []))) {
147:             $tree .= ' checked="checked"';
148:         }
149:         $tree .= " />" . $option['name'] . "<input type=\"hidden\" name=\"" . $elementName . "[parents]["
150:             . $option['id'] . "]\" value=\"" . implode(':', $parentIds) . "\" /><input type=\"hidden\" name=\""
151:             . $elementName . "[itemname][" . $option['id'] . "]\" value=\""
152:             . htmlspecialchars($option['name']) . "\" /><br />\n";
153:         if (isset($option['children'])) {
154:             foreach ($option['children'] as $child) {
155:                 array_push($parentIds, $option['id']);
156:                 $this->renderOptionTree($tree, $this->optionTree[$child], $prefix . '&nbsp;-', $parentIds);
157:             }
158:         }
159:     }
160: }
161:
Namespaces

Classes

Interfaces

Exceptions

Functions
