ilSurveyPhrases Class Reference

Survey phrases class. More...

Collaboration diagram for ilSurveyPhrases:

Public Member Functions
	__construct ()
	ilSurveyPhrases constructor More...
	deletePhrases ($phrase_array)
	Delete phrases from the database. More...
	updatePhrase ($phrase_id)
	Saves a set of categories to a default phrase. More...
	savePhrase ()
	Saves a set of categories to a default phrase. More...
	__get ($value)
	Object getter. More...
	__set ($key, $value)
	Object setter. More...

Static Public Member Functions
static	_getAvailablePhrases ($useronly=0)
	Gets the available phrases from the database. More...
static	_getCategoriesForPhrase ($phrase_id)
	Gets the available categories for a given phrase. More...

Protected Attributes
	$db
	$user
	$arrData

Detailed Description

Survey phrases class.

The ilSurveyPhrases class manages survey phrases (collections of survey categories) for ordinal survey question types.

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

Version

$Id$

Definition at line 34 of file class.ilSurveyPhrases.php.

Constructor & Destructor Documentation

__construct()

ilSurveyPhrases::__construct

(

)

ilSurveyPhrases constructor

Definition at line 51 of file class.ilSurveyPhrases.php.

References $DIC, array, and user().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->arrData = array();
    }

Here is the call graph for this function:

Member Function Documentation

__get()

ilSurveyPhrases::__get

(

$value

)

Object getter.

Definition at line 234 of file class.ilSurveyPhrases.php.

    {
        switch ($value) {
            default:
                if (array_key_exists($value, $this->arrData)) {
                    return $this->arrData[$value];
                } else {
                    return null;
                }
                break;
        }
    }

__set()

ilSurveyPhrases::__set	(		$key,
			$value
	)

Object setter.

Definition at line 250 of file class.ilSurveyPhrases.php.

References $key.

    {
        switch ($key) {
            default:
                $this->arrData[$key] = $value;
                break;
        }
    }

_getAvailablePhrases()

static ilSurveyPhrases::_getAvailablePhrases (   $useronly = 0 )

static

Gets the available phrases from the database.

Parameters

boolean

$useronly

Returns only the user defined phrases if set to true. The default is false.

Returns

array All available phrases as key/value pairs

Definition at line 66 of file class.ilSurveyPhrases.php.

References $DIC, $ilDB, $ilUser, $lng, $result, $row, and array.

Referenced by ilSurveyPhrasesGUI\deletePhrasesForm(), SurveyQuestionGUI\initPhrasesForm(), and ilSurveyPhrasesGUI\phrases().

    {
        global $DIC;

        $ilUser = $DIC->user();
        global $DIC;

        $ilDB = $DIC->database();
        global $DIC;

        $lng = $DIC->language();
        
        $phrases = array();
        $result = $ilDB->queryF(
            "SELECT * FROM svy_phrase WHERE defaultvalue = %s OR owner_fi = %s ORDER BY title",
            array('text', 'integer'),
            array('1', $ilUser->getId())
        );
        while ($row = $ilDB->fetchObject($result)) {
            if (($row->defaultvalue == 1) and ($row->owner_fi == 0)) {
                if (!$useronly) {
                    $phrases[$row->phrase_id] = array(
                        "title" => $lng->txt($row->title),
                        "owner" => $row->owner_fi,
                        "org_title" => $row->title
                    );
                }
            } else {
                if ($ilUser->getId() == $row->owner_fi) {
                    $phrases[$row->phrase_id] = array(
                        "title" => $row->title,
                        "owner" => $row->owner_fi
                    );
                }
            }
        }
        return $phrases;
    }

Here is the caller graph for this function:

_getCategoriesForPhrase()

static ilSurveyPhrases::_getCategoriesForPhrase (   $phrase_id )

static

Gets the available categories for a given phrase.

Parameters

integer

$phrase_id

The database id of the given phrase

Returns

array All available categories

Definition at line 111 of file class.ilSurveyPhrases.php.

References $DIC, $ilDB, $lng, $result, $row, and array.

Referenced by ilSurveyPhrasesGUI\deletePhrasesForm(), SurveyQuestionGUI\initPhrasesForm(), and ilSurveyPhrasesGUI\phrases().

    {
        global $DIC;

        $ilDB = $DIC->database();
        global $DIC;

        $lng = $DIC->language();
        
        $categories = array();
        $result = $ilDB->queryF(
            "SELECT svy_category.* FROM svy_category, svy_phrase_cat WHERE svy_phrase_cat.category_fi = svy_category.category_id AND svy_phrase_cat.phrase_fi = %s ORDER BY svy_phrase_cat.sequence",
            array('integer'),
            array($phrase_id)
        );
        while ($row = $ilDB->fetchObject($result)) {
            if (($row->defaultvalue == 1) and ($row->owner_fi == 0)) {
                $categories[$row->category_id] = $lng->txt($row->title);
            } else {
                $categories[$row->category_id] = $row->title;
            }
        }
        return $categories;
    }

Here is the caller graph for this function:

deletePhrases()

ilSurveyPhrases::deletePhrases

(

$phrase_array

)

Delete phrases from the database.

Parameters

array

$phrase_array

An array containing phrase id's to delete

Definition at line 141 of file class.ilSurveyPhrases.php.

References $db, and $ilDB.

    {
        $ilDB = $this->db;
        
        if ((is_array($phrase_array)) && (count($phrase_array))) {
            $affectedRows = $ilDB->manipulate("DELETE FROM svy_phrase WHERE " . $ilDB->in('phrase_id', $phrase_array, false, 'integer'));
            $affectedRows = $ilDB->manipulate("DELETE FROM svy_phrase_cat WHERE " . $ilDB->in('phrase_fi', $phrase_array, false, 'integer'));
        }
    }

savePhrase()

ilSurveyPhrases::savePhrase

(

)

Saves a set of categories to a default phrase.

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

References $counter, $db, $i, $ilDB, $ilUser, $user, array, and time.

    {
        $ilUser = $this->user;
        $ilDB = $this->db;

        $next_id = $ilDB->nextId('svy_phrase');
        $affectedRows = $ilDB->manipulateF(
            "INSERT INTO svy_phrase (phrase_id, title, defaultvalue, owner_fi, tstamp) VALUES (%s, %s, %s, %s, %s)",
            array('integer','text','text','integer','integer'),
            array($next_id, $this->title, 1, $ilUser->getId(), time())
        );
        $phrase_id = $next_id;

        $counter = 1;
        for ($i = 0; $i < $this->categories->getCategoryCount(); $i++) {
            $cat = $this->categories->getCategory($i);
            $next_id = $ilDB->nextId('svy_category');
            $affectedRows = $ilDB->manipulateF(
                "INSERT INTO svy_category (category_id, title, defaultvalue, owner_fi, tstamp, neutral) VALUES (%s, %s, %s, %s, %s, %s)",
                array('integer','text','text','integer','integer','text'),
                array($next_id, $cat->title, 1, $ilUser->getId(), time(), $cat->neutral)
            );
            $category_id = $next_id;
            $next_id = $ilDB->nextId('svy_phrase_cat');
            $affectedRows = $ilDB->manipulateF(
                "INSERT INTO svy_phrase_cat (phrase_category_id, phrase_fi, category_fi, sequence) VALUES (%s, %s, %s, %s)",
                array('integer', 'integer', 'integer','integer'),
                array($next_id, $phrase_id, $category_id, $counter)
            );
            $counter++;
        }
    }

updatePhrase()

ilSurveyPhrases::updatePhrase

(

$phrase_id

)

Saves a set of categories to a default phrase.

Parameters

array	$phrases	The database ids of the seleted phrases
string	$title	The title of the default phrase public

Definition at line 158 of file class.ilSurveyPhrases.php.

References $counter, $db, $i, $ilDB, $ilUser, $user, array, and time.

    {
        $ilUser = $this->user;
        $ilDB = $this->db;

        $affectedRows = $ilDB->manipulateF(
            "UPDATE svy_phrase SET title = %s, tstamp = %s WHERE phrase_id = %s",
            array('text','integer','integer'),
            array($this->title, time(), $phrase_id)
        );

        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_phrase_cat WHERE phrase_fi = %s",
            array('integer'),
            array($phrase_id)
        );

        $counter = 1;
        for ($i = 0; $i < $this->categories->getCategoryCount(); $i++) {
            $cat = $this->categories->getCategory($i);
            $next_id = $ilDB->nextId('svy_category');
            $affectedRows = $ilDB->manipulateF(
                "INSERT INTO svy_category (category_id, title, defaultvalue, owner_fi, tstamp, neutral) VALUES (%s, %s, %s, %s, %s, %s)",
                array('integer','text','text','integer','integer','text'),
                array($next_id, $cat->title, 1, $ilUser->getId(), time(), $cat->neutral)
            );
            $category_id = $next_id;
            $next_id = $ilDB->nextId('svy_phrase_cat');
            $affectedRows = $ilDB->manipulateF(
                "INSERT INTO svy_phrase_cat (phrase_category_id, phrase_fi, category_fi, sequence) VALUES (%s, %s, %s, %s)",
                array('integer', 'integer', 'integer','integer'),
                array($next_id, $phrase_id, $category_id, $counter)
            );
            $counter++;
        }
    }

Field Documentation

$arrData

ilSurveyPhrases::$arrData

protected

Definition at line 46 of file class.ilSurveyPhrases.php.

$db

ilSurveyPhrases::$db

protected

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

Referenced by deletePhrases(), savePhrase(), and updatePhrase().

$user

ilSurveyPhrases::$user

protected

Definition at line 44 of file class.ilSurveyPhrases.php.

Referenced by savePhrase(), and updatePhrase().

---

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

• Modules/SurveyQuestionPool/classes/class.ilSurveyPhrases.php