1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 <?php
// ------------------------------------------------------------------------ //
// XOOPS - PHP Content Management System //
// Copyright (c) 2000 XOOPS.org //
// <http://www.xoops.org/> //
// ------------------------------------------------------------------------ //
// This program is free software; you can redistribute it and/or modify //
// it under the terms of the GNU General Public License as published by //
// the Free Software Foundation; either version 2 of the License, or //
// (at your option) any later version. //
// //
// 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. See the //
// GNU General Public License for more details. //
// //
// You should have received a copy of the GNU General Public License //
// along with this program; if not, write to the Free Software //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA //
// ------------------------------------------------------------------------ //
// Author: Kazumi Ono (AKA onokazu) //
// URL: http://www.myweb.ne.jp/, http://www.xoops.org/, http://jp.xoops.org/ //
// Project: The XOOPS Project //
// ------------------------------------------------------------------------- //
/**
* TfishAngryTree class file.
*
* @copyright XOOPS.org (https://xoops.org) 2000
* @license https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GNU General Public License (GPL) V2
* @author Kazumi Ono <[email protected]>
* @author marcan aka Marc-André Lanciault <[email protected]>
* @author Simon Wilkinson <[email protected]>
* @since 1.0
* @package core
*/
// Enable strict type declaration.
declare(strict_types=1);
if (!defined("TFISH_ROOT_PATH")) die("TFISH_ERROR_ROOT_PATH_NOT_DEFINED");
/**
* Represents hierarchical relationships between collections and member content objects.
*
* Essentially this is a category tree, although collections (category analogues) are fully-fledged
* content objects in their own right. Pass in an array of collection objects; you can choose to
* pass in all collection objects or you can pass in a branch, in which case the tree will just
* consist of descendants of the root node.
*
* As for the name, don't ask.
*
* @copyright http://smartfactory.ca The SmartFactory
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU General Public License (GPL)
* @author Kazumi Ono <[email protected]>
* @author marcan aka Marc-André Lanciault <[email protected]>
* @author Madfish <[email protected]>
* @version Release: 1.0
* @since 1.0
* @package core
*/
class TfishAngryTree
{
/** @var array $_objects Array of objects to be assembled into a category tree. */
public $_objects;
/** @var string $_myId Name of object ID field. */
public $_myId;
/** @var string $_parentId Name of parent object ID field. */
private $_parentId;
/** @var int $_rootId Name of root object ID, to be used as the root node of the tree. */
private $_rootId = null;
/** @var object $_tree Associative array that comprises the category tree. */
public $_tree = array();
/**
* Constructor
*
* @param array $objectArr Array of collection objects.
* @param string $myId Name of object ID field.
* @param string $parentId Name of parent object ID field.
* @param string $rootId Name of root object ID field.
* */
function __construct(array &$objectArr, string $myId, string $parentId, string $rootId = null)
{
$this->_objects = & $objectArr;
$this->_myId = $myId;
$this->_parentId = $parentId;
if (isset($rootId)) {
$this->_rootId = $rootId;
}
$this->_initialize();
}
/**
* Initialise the tree.
*
* @internal
*/
private function _initialize()
{
foreach (array_keys($this->_objects) as $i) {
$id_field = $this->_myId;
$key1 = $this->_objects[$i]->$id_field;
$this->_tree[$key1]['obj'] = & $this->_objects[$i];
$parent_id_field = $this->_parentId;
$key2 = $this->_objects[$i]->$parent_id_field;
$this->_tree[$key1]['parent'] = $key2;
$this->_tree[$key2]['child'][] = $key1;
if (isset($this->_rootId)) {
$this->_tree[$key1]['root'] = $this->_objects[$i]->getVar($this->_rootId);
}
}
}
/**
* Get a category tree.
*
* @return array Associative array comprising the tree.
* */
public function &getTree()
{
return $this->_tree;
}
/**
* returns an object from the category tree specified by its id.
*
* @param string $key ID of the object to retrieve.
* @return object Object (node) within the tree.
* */
public function &getByKey(int $key)
{
return $this->_tree[$key]['obj'];
}
/**
* Returns an array of all the first child objects of a parental object specified by its id.
*
* @param string $key ID of the parent object.
* @return array Array of child objects.
* */
public function getFirstChild(int $key)
{
$ret = array();
if (isset($this->_tree[$key]['child'])) {
foreach ($this->_tree[$key]['child'] as $childkey) {
$ret[$childkey] = & $this->_tree[$childkey]['obj'];
}
}
return $ret;
}
/**
* Returns an array of all child objects of a parental object specified by its ID.
*
* @param string $key ID of the parent.
* @param array $ret Array of child objects from previous recursions (empty if called from client).
* @return array Array of child nodes.
* */
public function getAllChild(int $key, array $ret = array())
{
if (isset($this->_tree[$key]['child'])) {
foreach ($this->_tree[$key]['child'] as $childkey) {
$ret[$childkey] = & $this->_tree[$childkey]['obj'];
$children = & $this->getAllChild($childkey, $ret);
foreach (array_keys($children) as $newkey) {
$ret[$newkey] = & $children[$newkey];
}
}
}
return $ret;
}
/**
* Returns an array of all parent objects.
*
* The key of returned array represents how many levels up from the specified object.
*
* @param string $key ID of the child object.
* @param array $ret Result from previous recursions (empty when called from outside).
* @param int $uplevel Level of recursion (empty when called from outside).
* @return array Array of parent nodes.
* */
public function getAllParent(int $key, array $ret = array(), int $uplevel = 1)
{
if (isset($this->_tree[$key]['parent'])
&& isset($this->_tree[$this->_tree[$key]['parent']]['obj'])) {
$ret[$uplevel] = & $this->_tree[$this->_tree[$key]['parent']]['obj'];
$parents = & $this->getAllParent($this->_tree[$key]['parent'], $ret, $uplevel + 1);
foreach (array_keys($parents) as $newkey) {
$ret[$newkey] = & $parents[$newkey];
}
}
return $ret;
}
/**
* Make options for a select box from tree.
*
* @param string $fieldName Name of the member variable from the node objects that should
* be used as the title for the options.
* @param int $selected Value to display as selected.
* @param int $key ID of the object to display as the root of select options.
* @param string $ret Result from previous recursions (reference to a string when called from outside).
* @param string $prefix_orig String to indent items at deeper levels.
* @param string $prefix_curr String to indent the current item.
*/
private function _makeSelBoxOptions(string $fieldName, int $selected, int $key, &$ret,
string $prefix_orig, string $prefix_curr = '')
{
if ($key > 0) {
$id_field = $this->_myId;
$value = $this->_tree[$key]['obj']->$id_field;
$ret[$value] = $prefix_curr . $this->_tree[$key]['obj']->$fieldName;
$prefix_curr .= $prefix_orig;
}
if (isset($this->_tree[$key]['child']) && !empty($this->_tree[$key]['child'])) {
foreach ($this->_tree[$key]['child'] as $childkey) {
$this->_makeSelBoxOptions($fieldName, $selected, $childkey, $ret, $prefix_orig,
$prefix_curr);
}
}
}
/**
* Make select box options from the tree
*
* Returns an indented array of options that can be used to build a HTML select box, indented
* according to the relative hierarchy.
*
* @param string $name Name of the select box.
* @param string $fieldName Name of the member variable from the node objects that should be
* used as the title field for the options.
* @param string $prefix String to indent deeper levels.
* @param int $selected Value to display as selected.
* @param bool $addEmptyOption Set TRUE to add an empty option with value "0" at the top of the
* hierarchy.
* @param int $key ID of the object to display as the root of select options.
* @return array Select box options as ID => title pairs.
* */
public function makeSelBox(string $name, string $fieldName, string $prefix = '-- ',
int $selected = 0, bool $addEmptyOption = false, int $key = 0)
{
$ret = array(0 => TFISH_SELECT_BOX_ZERO_OPTION);
$this->_makeSelBoxOptions($fieldName, $selected, $key, $ret, $prefix);
return $ret;
}
/**
* Make a select box of parent collections from the tree.
*
* @param int $selected Currently selected option.
* @param int $key ID of the object to display as root of the select options.
* @return string HTML select box.
*/
public function makeParentSelectBox(int $selected = 0, int $key = 0)
{
$ret = array(0 => TFISH_SELECT_PARENT);
$this->_makeSelBoxOptions('title', $selected, $key, $ret, '-- ');
return $ret;
}
}