Collaboration diagram for SurveyCategories:

Public Member Functions
	__construct ()
	Constructor @access public. More...

	getCategoryCount ()
	Returns the number of categories. More...

	addCategoryAtPosition ($categoryname, $position, $other=0, $neutral=0, $label=null)
	Adds a category at a given position. More...

	moveCategoryUp ($index)

	moveCategoryDown ($index)

	addCategory ($categoryname, $other=0, $neutral=0, $label=null, $scale=null)
	Adds a category. More...

	addCategoryArray ($categories)
	Adds a category array. More...

	removeCategory ($index)
	Removes a category from the list of categories. More...

	removeCategories ($array)
	Removes many categories from the list of categories. More...

	removeCategoryWithName ($name)
	Removes a category from the list of categories. More...

	getCategory ($index)
	Returns the name of a category for a given index. More...

	getCategoryForScale ($scale)
	Returns the name of a category for a given index. More...

	getCategoryIndex ($name)
	Returns the index of a category with a given name. More...

	getIndex ($category)
	Returns the index of a category. More...

	getNewScale ()

	getScale ($index)

	flushCategories ()
	Empties the categories list. More...

	getCategories ()
	Get categories. More...

Data Fields
	$categories

Protected Attributes
	$log

Detailed Description

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 10 of file class.SurveyCategories.php.

Constructor & Destructor Documentation

◆ __construct()

SurveyCategories::__construct ( )

Constructor @access public.

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

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

References ilLoggerFactory\getLogger().

Here is the call graph for this function:

Member Function Documentation

◆ addCategory()

SurveyCategories::addCategory	(	$categoryname,
		$other = `0`,
		$neutral = `0`,
		$label = `null`,
		$scale = `null`
	)

Adds a category.

Adds a category

Parameters

integer $categoryname The name of the category @access public

See also: $categories

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

    {
        array_push($this->categories, new ilSurveyCategory($categoryname, $other, $neutral, $label, $scale));
    }

◆ addCategoryArray()

SurveyCategories::addCategoryArray ( $categories )

Adds a category array.

Adds a category array

Parameters

array $categories An array with categories @access public

See also: $categories

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

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

References $categories.

◆ addCategoryAtPosition()

SurveyCategories::addCategoryAtPosition	(	$categoryname,
		$position,
		$other = `0`,
		$neutral = `0`,
		$label = `null`
	)

Adds a category at a given position.

Adds a category at a given position

Parameters

string	$categoryname	The name of the category
integer	$position	The position of the category (starting with index 0) @access public

See also: $categories

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

    {
        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));
        }
    }

◆ flushCategories()

SurveyCategories::flushCategories ( )

Empties the categories list.

Empties the categories list

@access public

See also: $categories

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

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

◆ getCategories()

SurveyCategories::getCategories ( )

Get categories.

Parameters

return

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

    {
        return $this->categories;
    }

References $categories.

◆ getCategory()

SurveyCategories::getCategory ( $index )

Returns the name of a category for a given index.

Returns the name of a category for a given index

Parameters

integer $index The index of the category

Returns: string Category name @access public

See also: $categories

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

    {
        if (array_key_exists($index, $this->categories)) {
            return $this->categories[$index];
        } else {
            return "";
        }
    }

References $index.

◆ getCategoryCount()

SurveyCategories::getCategoryCount ( )

Returns the number of categories.

Returns the number of categories

Returns: integer The number of contained categories @access public

See also: $categories

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

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

◆ getCategoryForScale()

SurveyCategories::getCategoryForScale ( $scale )

Returns the name of a category for a given index.

Parameters

integer $scale The scale of the category

Returns: string Category object

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

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

◆ getCategoryIndex()

SurveyCategories::getCategoryIndex ( $name )

Returns the index of a category with a given name.

Parameters

string $name The name of the category @access public

See also: $categories

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

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

References $index, and $name.

◆ getIndex()

SurveyCategories::getIndex ( $category )

Returns the index of a category.

Parameters

string $category The category object @access public

See also: $categories

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

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

References $index.

◆ getNewScale()

SurveyCategories::getNewScale ( )

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

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

References $index.

Referenced by getScale().

Here is the caller graph for this function:

◆ getScale()

SurveyCategories::getScale ( $index )

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

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

References $index, and getNewScale().

Here is the call graph for this function:

◆ moveCategoryDown()

SurveyCategories::moveCategoryDown ( $index )

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

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

References $index.

◆ moveCategoryUp()

SurveyCategories::moveCategoryUp ( $index )

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

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

References $index.

◆ removeCategories()

SurveyCategories::removeCategories ( $array )

Removes many categories from the list of categories.

Removes many categories from the list of categories

Parameters

array $array An array containing the index positions of the categories to be removed @access public

See also: $categories

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

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

References $index.

◆ removeCategory()

SurveyCategories::removeCategory ( $index )

Removes a category from the list of categories.

Removes a category from the list of categories

Parameters

integer $index The index of the category to be removed @access public

See also: $categories

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

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

References $index.

Referenced by removeCategoryWithName().

Here is the caller graph for this function:

◆ removeCategoryWithName()

SurveyCategories::removeCategoryWithName ( $name )

Removes a category from the list of categories.

Removes a category from the list of categories

Parameters

string $name The name of the category to be removed @access public

See also: $categories

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

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

References $index, $name, and removeCategory().

Here is the call graph for this function:

Field Documentation

◆ $categories

SurveyCategories::$categories

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

Referenced by addCategoryArray(), and getCategories().

◆ $log

SurveyCategories::$log

protected

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

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

Modules/SurveyQuestionPool/Categories/class.SurveyCategories.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCategory()

◆ addCategoryArray()

◆ addCategoryAtPosition()

◆ flushCategories()

◆ getCategories()

◆ getCategory()

◆ getCategoryCount()

◆ getCategoryForScale()

◆ getCategoryIndex()

◆ getIndex()

◆ getNewScale()

◆ getScale()

◆ moveCategoryDown()

◆ moveCategoryUp()

◆ removeCategories()

◆ removeCategory()

◆ removeCategoryWithName()

Field Documentation

◆ $categories

◆ $log