SurveyCategories Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for SurveyCategories:

Public Member Functions
	__construct ()
	getCategoryCount ()
	addCategoryAtPosition (string $categoryname, int $position, int $other=0, int $neutral=0, ?string $label=null)
	Adds a category at a given position. More...
	moveCategoryUp (int $index)
	moveCategoryDown (int $index)
	addCategory (string $categoryname, int $other=0, int $neutral=0, ?string $label=null, ?int $scale=null)
	addCategoryArray (array $categories)
	removeCategory (int $index)
	removeCategories (array $array)
	removeCategoryWithName (string $name)
	getCategory (int $index)
	getCategoryForScale (int $scale)
	getCategoryIndex (string $name)
	getIndex (ilSurveyCategory $category)
	getNewScale ()
	getScale (int $index)
	flushCategories ()
	getCategories ()

Data Fields
array	$categories
	An array containing the categories of a nominal or ordinal question object. More...

Protected Attributes
ilLogger	$log

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class SurveyCategories

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Definition at line 23 of file class.SurveyCategories.php.

Constructor & Destructor Documentation

__construct()

SurveyCategories::__construct

(

)

Definition at line 33 of file class.SurveyCategories.php.

References ilLoggerFactory\getLogger().

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

Here is the call graph for this function:

Member Function Documentation

addCategory()

SurveyCategories::addCategory	(	string	$categoryname,
		int	$other = 0,
		int	$neutral = 0,
		?string	$label = null,
		?int	$scale = null
	)

Definition at line 82 of file class.SurveyCategories.php.

     : void {
        $this->categories[] = new ilSurveyCategory($categoryname, $other, $neutral, $label, $scale);
    }

addCategoryArray()

SurveyCategories::addCategoryArray

(

array

$categories

)

Parameters

array

$categories

array with categories

Definition at line 95 of file class.SurveyCategories.php.

                                                       : void
    {
        $this->categories = array_merge($this->categories, $categories);
    }

addCategoryAtPosition()

SurveyCategories::addCategoryAtPosition	(	string	$categoryname,
		int	$position,
		int	$other = 0,
		int	$neutral = 0,
		?string	$label = null
	)

Adds a category at a given position.

Parameters

int

$position

The position of the category (starting with index 0)

Definition at line 48 of file class.SurveyCategories.php.

     : void {
        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 {
            $this->categories[] = new ilSurveyCategory($categoryname, $other, $neutral, $label);
        }
    }

flushCategories()

SurveyCategories::flushCategories

(

)

Definition at line 193 of file class.SurveyCategories.php.

                                     : void
    {
        $this->categories = array();
    }

getCategories()

SurveyCategories::getCategories

(

)

Definition at line 198 of file class.SurveyCategories.php.

References $categories.

                                   : array
    {
        return $this->categories;
    }

getCategory()

SurveyCategories::getCategory

(

int

$index

)

Definition at line 128 of file class.SurveyCategories.php.

References $index.

     : ?ilSurveyCategory {
        return $this->categories[$index] ?? null;
    }

getCategoryCount()

SurveyCategories::getCategoryCount

(

)

Definition at line 39 of file class.SurveyCategories.php.

                                      : int
    {
        return count($this->categories);
    }

getCategoryForScale()

SurveyCategories::getCategoryForScale

(

int

$scale

)

Definition at line 134 of file class.SurveyCategories.php.

     : ?ilSurveyCategory {
        foreach ($this->categories as $cat) {
            if ($cat->scale == $scale) {
                return $cat;
            }
        }
        return null;
    }

getCategoryIndex()

SurveyCategories::getCategoryIndex

(

string

$name

)

Definition at line 145 of file class.SurveyCategories.php.

References $index.

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

getIndex()

SurveyCategories::getIndex

(

ilSurveyCategory

$category

)

Definition at line 156 of file class.SurveyCategories.php.

References $index.

                                                        : ?int
    {
        foreach ($this->categories as $index => $cat) {
            if ($cat == $category) {
                return $index;
            }
        }
        return null;
    }

getNewScale()

SurveyCategories::getNewScale

(

)

Definition at line 166 of file class.SurveyCategories.php.

References $index.

Referenced by getScale().

                                 : int
    {
        $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;
    }

Here is the caller graph for this function:

getScale()

SurveyCategories::getScale

(

int

$index

)

Definition at line 180 of file class.SurveyCategories.php.

References $index, and getNewScale().

     : int {
        $obj = $this->categories[$index];
        if (is_object($obj) && $obj->scale > 0) {
            $this->log->debug("getScale has scale =" . $obj->scale);
        } else {
            $obj->scale = $this->getNewScale();
            $this->log->debug("getScale needed new scale, scale =" . $obj->scale);
        }
        return $obj->scale;
    }

Here is the call graph for this function:

moveCategoryDown()

SurveyCategories::moveCategoryDown

(

int

$index

)

Definition at line 73 of file class.SurveyCategories.php.

References $index.

                                                : void
    {
        if ($index < (count($this->categories) - 1)) {
            $temp = $this->categories[$index + 1];
            $this->categories[$index + 1] = $this->categories[$index];
            $this->categories[$index] = $temp;
        }
    }

moveCategoryUp()

SurveyCategories::moveCategoryUp

(

int

$index

)

Definition at line 64 of file class.SurveyCategories.php.

References $index.

                                              : void
    {
        if ($index > 0) {
            $temp = $this->categories[$index - 1];
            $this->categories[$index - 1] = $this->categories[$index];
            $this->categories[$index] = $temp;
        }
    }

removeCategories()

SurveyCategories::removeCategories

(

array

$array

)

Parameters

int[]

$array index positions

Definition at line 109 of file class.SurveyCategories.php.

References $index.

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

removeCategory()

SurveyCategories::removeCategory

(

int

$index

)

Definition at line 100 of file class.SurveyCategories.php.

Referenced by removeCategoryWithName().

                                              : void
    {
        unset($this->categories[$index]);
        $this->categories = array_values($this->categories);
    }

Here is the caller graph for this function:

removeCategoryWithName()

SurveyCategories::removeCategoryWithName

(

string

$name

)

Definition at line 117 of file class.SurveyCategories.php.

References $index, and removeCategory().

     : void {
        foreach ($this->categories as $index => $category) {
            if (strcmp($category->title, $name) == 0) {
                $this->removeCategory($index);
                return;
            }
        }
    }

Here is the call graph for this function:

Field Documentation

$categories

array SurveyCategories::$categories

An array containing the categories of a nominal or ordinal question object.

Definition at line 31 of file class.SurveyCategories.php.

Referenced by getCategories().

$log

ilLogger SurveyCategories::$log

protected

Definition at line 25 of file class.SurveyCategories.php.

---

The documentation for this class was generated from the following file:

• Modules/SurveyQuestionPool/Categories/class.SurveyCategories.php