class.SurveyCategories.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
        |                                                                             |
        | 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.                      |
        |                                                                             |
        | 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. |
        +-----------------------------------------------------------------------------+
*/

include_once "./Modules/Survey/classes/inc.SurveyConstants.php";
include_once "./Modules/SurveyQuestionPool/classes/class.ilSurveyCategory.php";

class SurveyCategories
{
  var $categories;

        function SurveyCategories()
        {
                $this->categories = array();
        }

        function getCategoryCount() 
        {
                return count($this->categories);
        }

        function addCategoryAtPosition($categoryname, $position, $other = 0, $neutral = 0, $label = null) 
        {
                if (array_key_exists($position, $this->categories))
                {
                        $head = array_slice($this->categories, 0, $position);
                        $tail = array_slice($this->categories, $position);
                        $this->categories = array_merge($head, array(new ilSurveyCategory($categoryname, $other, $neutral, $label)), $tail);
                }
                else
                {
                        array_push($this->categories, new ilSurveyCategory($categoryname, $other, $neutral, $label));
                }
        }
        
        function moveCategoryUp($index)
        {
                if ($index > 0)
                {
                        $temp = $this->categories[$index-1];
                        $this->categories[$index - 1] = $this->categories[$index];
                        $this->categories[$index] = $temp;
                }
        }
        
        function moveCategoryDown($index)
        {
                if ($index < (count($this->categories)-1))
                {
                        $temp = $this->categories[$index+1];
                        $this->categories[$index + 1] = $this->categories[$index];
                        $this->categories[$index] = $temp;
                }
        }

        function addCategory($categoryname, $other = 0, $neutral = 0, $label = null, $scale = null) 
        {
                array_push($this->categories, new ilSurveyCategory($categoryname, $other, $neutral, $label, $scale));
        }
        
        function addCategoryArray($categories) 
        {
                $this->categories = array_merge($this->categories, $categories);
        }
        
        function removeCategory($index)
        {
                unset($this->categories[$index]);
                $this->categories = array_values($this->categories);
        }

        function removeCategories($array)
        {
                foreach ($array as $index)
                {
                        unset($this->categories[$index]);
                }
                $this->categories = array_values($this->categories);
        }

        function removeCategoryWithName($name)
        {
                foreach ($this->categories as $index => $category)
                {
                        if (strcmp($category->title, $name) == 0)
                        {
                                $this->removeCategory($index);
                                return;
                        }
                }
        }
        
        function getCategory($index)
        {
                if (array_key_exists($index, $this->categories))
                {
                        return $this->categories[$index];
                }
                else
                {
                        return "";
                }
        }

                public function getCategoryForScale($scale)
                {
                        foreach ($this->categories as $cat)
                        {
                                if ($cat->scale == $scale) return $cat;
                        }
                        return null;
                }

        function getCategoryIndex($name)
        {
                foreach ($this->categories as $index => $category)
                {
                        if (strcmp($category->title, $name) == 0)
                        {
                                return $index;
                        }
                }
                return null;
        }

        function getIndex($category)
        {
                foreach ($this->categories as $index => $cat)
                {
                        if ($cat == $category)
                        {
                                return $index;
                        }
                }
                return null;
        }
        
        public function getNewScale()
        {
                $max = 0;
                foreach ($this->categories as $index => $category)
                {
                        if (is_object($category) && $category->scale > 0)
                        {
                                if ($category->scale > $max) $max = $category->scale;
                        }
                }
                return $max+1;
        }
        
        function getScale($index)
        {
                $obj = $this->categories[$index];
                if (is_object($obj) && $obj->scale > 0)
                {
                        return $obj->scale;
                }
                else
                {
                        $obj->scale = $this->getNewScale();
                        return $obj->scale;
                }
        }
        
        function flushCategories() 
        {
                $this->categories = array();
        }
                
} // END class.SurveyCategories
?>