Merge branch 'main' into issue-3911issue-3911

1 files changed, 294 insertions, 0 deletions

diff --git a/lib/classes/RangeTreeObject.php b/lib/classes/RangeTreeObject.php
new file mode 100644
index 0000000..06f84bf
--- /dev/null
+++ b/lib/classes/RangeTreeObject.php
@@ -0,0 +1,294 @@
+<?php
+# Lifter002: TODO
+# Lifter007: TODO
+# Lifter003: TODO
+# Lifter010: TODO
+// +---------------------------------------------------------------------------+
+// This file is part of Stud.IP
+// RangeTreeObject.php
+// Class to handle items in the "range tree"
+//
+// Copyright (c) 2002 André Noack <noack@data-quest.de>
+// Suchi & Berg GmbH <info@data-quest.de>
+// +---------------------------------------------------------------------------+
+// 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 any later version.
+// +---------------------------------------------------------------------------+
+// 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.
+// +---------------------------------------------------------------------------+
+
+/**
+* base class for items in the "range tree"
+*
+* This class is used for items
+*
+* @access   public
+* @author   André Noack <noack@data-quest.de>
+* @package
+*/
+class RangeTreeObject {
+
+    /**
+    * item_id in range_tree
+    *
+    *
+    * @access   public
+    * @var      string $tree_item_id
+    */
+    var $tree_item_id;
+    /**
+    * References the tree object
+    *
+    *
+    * @access   private
+    * @var      object StudipRangeTree $tree
+    */
+    var $tree;
+    /**
+    * associative array with data from database fields
+    *
+    *
+    * @access   public
+    * @var      array $item_data
+    */
+    var $item_data = null;
+
+    /**
+    * associative array with mapping for database fields
+    *
+    *
+    * @access   public
+    * @var      array $item_data_mapping
+    */
+    var $item_data_mapping = null;
+
+    /**
+    * Factory method
+    *
+    *
+    * @access public
+    * @static
+    * @param    string  $item_id
+    * @return   object RangeTreeObject
+    */
+    public static function GetInstance($item_id){
+        $tree = TreeAbstract::GetInstance("StudipRangeTree", false);
+        $class_name = "RangeTreeObject" . ucfirst($tree->tree_data[$item_id]['studip_object']);
+        return new $class_name($item_id);
+    }
+
+    /**
+    * Constructor
+    *
+    * Do not use directly, call factory method instead
+    * @access private
+    * @param    string  $item_id
+    */
+    function __construct($item_id) {
+        $this->tree = TreeAbstract::GetInstance("StudipRangeTree", false);
+        $this->tree_item_id = $item_id;
+        $this->item_data = $this->tree->tree_data[$item_id] ?? null;
+    }
+
+    /**
+    * Returns all tree items which are kids of this object
+    *
+    *
+    * @access public
+    * @param    boolean $as_value_list
+    * @return   mixed   returns numeric array if param is false, else comma separated string
+    */
+    function getAllItemKids($as_value_list = false){
+        return ($as_value_list) ? $this->getValueList($this->tree->getKidsKids($this->tree_item_id)) : $this->tree->getKidsKids($this->tree_item_id);
+    }
+
+    /**
+    * Returns all tree items which are kids of this object and are "real" Stud.IP objects
+    *
+    *
+    * @access public
+    * @param    boolean $as_value_list
+    * @return   mixed   returns numeric array if param is false, else comma separated string
+    */
+    function getAllObjectKids($as_value_list = false){
+        $all_object_kids = array_merge((array)$this->getInstKids(), (array)$this->getFakKids());
+        return ($as_value_list) ? $this->getValueList($all_object_kids) : $all_object_kids;
+    }
+
+    /**
+    * Returns all tree items which are kids of this object and are Stud.IP "Einrichtungen"
+    *
+    *
+    * @access public
+    * @param    boolean $as_value_list
+    * @return   mixed   returns numeric array if param is false, else comma separated string
+    */
+    function getInstKids($as_value_list = false){
+        $all_kids = $this->tree->getKidsKids($this->tree_item_id);
+        $inst_kids = [];
+        for ($i = 0; $i < count($all_kids); ++$i){
+            if ($this->tree->tree_data[$all_kids[$i]]['studip_object'] == 'inst'){
+                $inst_kids[] = $this->tree->tree_data[$all_kids[$i]]['studip_object_id'];
+            }
+        }
+        return ($as_value_list) ? $this->getValueList($inst_kids) : $inst_kids;
+    }
+
+    /**
+    * Returns all tree items which are kids of this object and are Stud.IP "Fakultaeten"
+    *
+    *
+    * @access public
+    * @param    boolean $as_value_list
+    * @return   mixed   returns numeric array if param is false, else comma separated string
+    */
+    function getFakKids($as_value_list = false){
+        $all_kids = $this->tree->getKidsKids($this->tree_item_id);
+        $fak_kids = [];
+        for ($i = 0; $i < count($all_kids); ++$i){
+            if ($this->tree->tree_data[$all_kids[$i]]['studip_object'] == 'fak'){
+                $inst_kids[] = $this->tree->tree_data[$all_kids[$i]]['studip_object_id'];
+            }
+        }
+        return ($as_value_list) ? $this->getValueList($fak_kids) : $fak_kids;
+    }
+
+    /**
+    * Returns array of Stud.IP range_ids of "real" objects
+    *
+    * This function is a wrapper for the according function in StudipRangeTree
+    * @see StudipRangeTree::getAdminRange()
+    * @access   public
+    * @return   array   of primary keys from table "institute"
+    */
+    function getAdminRange(){
+        return $this->tree->getAdminRange($this->tree_item_id);
+    }
+
+    /**
+    * Only useful in RangeTreeObjectInst ,all other items are always in the correct branch
+    *
+    * @access   public
+    * @return   bool
+    */
+    function isInCorrectBranch(){
+        return true;
+    }
+
+    /**
+    * Returns tree path of the current object
+    *
+    * This function is a wrapper for the according function in StudipRangeTree
+    * @see StudipRangeTree::getItemPath()
+    * @access public
+    * @return   string
+    */
+    function getItemPath(){
+        return $this->tree->getItemPath($this->tree_item_id);
+    }
+
+    /**
+    * extends the $item_data array
+    *
+    * This function fills the $item_data array with fields from the according database table (is of no use in the base class)
+    * @abstract
+    * @access private
+    */
+    function initItemDetail(){
+        if ($type = $this->item_data['studip_object']){
+            $view = DbView::getView('range_tree');
+            $view->params = [$this->tree->studip_objects[$type]['table'],
+                                $this->tree->studip_objects[$type]['pk'],
+                                $this->item_data['studip_object_id']];
+            $snap = new DbSnapshot($view->get_query("view:TREE_OBJECT_DETAIL"));
+            if ($snap->numRows){
+                $fields = $snap->getFieldList();
+                $snap->nextRow();
+                for ($i = 0; $i < count($fields); ++$i){
+                    $this->item_data[$fields[$i]] = $snap->getField($fields[$i]);
+                }
+            }
+        return true;
+        }
+    return false;
+    }
+
+    /**
+    * fetch categories of this object from database
+    *
+    * the categories are appended to the $item_data array, key 'categories', value is object of type DbSnapshot
+    * @access private
+    * @return   boolean true if categories were found
+    */
+    function fetchCategories(){
+        $view = DbView::getView('range_tree');
+        $view->params[] = $this->tree_item_id;
+        $rs = $view->get_query("view:TREE_OBJECT_CAT");
+        if (is_object($rs)){
+            $this->item_data['categories'] = new DbSnapshot($rs);
+            return true;
+        }
+    return false;
+    }
+
+    /**
+    * getter method for categories of this object
+    *
+    *
+    * @access public
+    * @return   object DbSnapshot
+    */
+    function &getCategories(){
+        if (empty($this->item_data['categories']) || !is_object($this->item_data['categories'])){
+            $this->fetchCategories();
+        }
+        return $this->item_data['categories'];
+    }
+
+    function fetchNumStaff(){
+        $view = DbView::getView('range_tree');
+        if (!($view->params[0] = $this->item_data['studip_object_id']))
+            $view->params[0] = $this->tree_item_id;
+        $rs = $view->get_query("view:STATUS_COUNT");
+        if ($rs->next_record()){
+            $this->item_data['num_staff'] = $rs->f(0);
+            return true;
+        }
+        return false;
+    }
+
+    function getNumStaff(){
+        if(!isset($this->item_data['num_staff'])){
+            $this->fetchNumStaff();
+        }
+        return $this->item_data['num_staff'];
+    }
+
+
+    /**
+    * transform numerical array into a comma separated string
+    *
+    * the result could be used in a SQL query
+    * @access private
+    * @param    array   $list
+    * @return   string
+    */
+
+    function getValueList($list){
+        $value_list = false;
+        if (count($list) == 1)
+            $value_list = "'$list[0]'";
+        else
+            $value_list = "'".join("','",$list)."'";
+        return $value_list;
+    }
+
+}