class.SurveyCategories.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2019 ILIAS open source, Extended GPL, see docs/LICENSE */

class SurveyCategories
{

    protected $log;

    public $categories;

    public function __construct()
    {
        $this->categories = array();
        $this->log = ilLoggerFactory::getLogger("svy");
    }

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

    public 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));
        }
    }
    
    public function moveCategoryUp($index)
    {
        if ($index > 0) {
            $temp = $this->categories[$index - 1];
            $this->categories[$index - 1] = $this->categories[$index];
            $this->categories[$index] = $temp;
        }
    }
    
    public 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;
        }
    }

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

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

    public function removeCategoryWithName($name)
    {
        foreach ($this->categories as $index => $category) {
            if (strcmp($category->title, $name) == 0) {
                $this->removeCategory($index);
                return;
            }
        }
    }
    
    public 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;
    }

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

    public 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;
    }
    
    public function getScale($index)
    {
        $obj = $this->categories[$index];
        if (is_object($obj) && $obj->scale > 0) {
            $this->log->debug("getScale has scale =" . $obj->scale);
            return $obj->scale;
        } else {
            $obj->scale = $this->getNewScale();
            $this->log->debug("getScale needed new scale, scale =" . $obj->scale);
            return $obj->scale;
        }
    }
    
    public function flushCategories()
    {
        $this->categories = array();
    }

    public function getCategories()
    {
        return $this->categories;
    }
}