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

Collaboration diagram for ilSurveyPhrases:

Public Member Functions
	__construct ()

	deletePhrases (array $phrase_array)
	Delete phrases from the database. More...

	updatePhrase (int $phrase_id)

	savePhrase ()
	Saves a set of categories to a default phrase. More...

	__get (string $value)

	__set (string $key, $value)

Static Public Member Functions
static	_getAvailablePhrases (bool $useronly=false)
	Gets the available phrases from the database. More...

static	_getCategoriesForPhrase (int $phrase_id)
	Gets the available categories for a given phrase. More...

Protected Attributes
ilDBInterface	$db

ilObjUser	$user

array	$arrData

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 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

Todo:: split up in dto and repo class

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

Constructor & Destructor Documentation

◆ __construct()

ilSurveyPhrases::__construct ( )

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

References $DIC, and ILIAS\Repository\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 ( string $value )

Returns: mixed|null

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

     {
         switch ($value) {
             default:
                 return $this->arrData[$value] ?? null;
         }
     }

◆ __set()

ilSurveyPhrases::__set	(	string	$key,
			$value
	)

Parameters

mixed | null $value

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

References ILIAS\LTI\ToolProvider\$key.

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

◆ _getAvailablePhrases()

static ilSurveyPhrases::_getAvailablePhrases ( bool $useronly = false )

static

Gets the available phrases from the database.

Parameters

bool $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 50 of file class.ilSurveyPhrases.php.

References $DIC, $ilDB, $ilUser, $lng, and ILIAS\Repository\int().

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

      : array {
         global $DIC;
 
         $ilUser = $DIC->user();
         $ilDB = $DIC->database();
         $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 ((int) $row->defaultvalue === 1 && (int) $row->owner_fi === 0) {
                 if (!$useronly) {
                     $phrases[$row->phrase_id] = array(
                         "title" => $lng->txt($row->title),
                         "owner" => $row->owner_fi,
                         "org_title" => $row->title
                     );
                 }
             } elseif ($ilUser->getId() === (int) $row->owner_fi) {
                 $phrases[$row->phrase_id] = array(
                     "title" => $row->title,
                     "owner" => $row->owner_fi
                 );
             }
         }
         return $phrases;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getCategoriesForPhrase()

static ilSurveyPhrases::_getCategoriesForPhrase ( int $phrase_id )

static

Gets the available categories for a given phrase.

Parameters

int $phrase_id The database id of the given phrase

Returns: array All available categories

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

References $DIC, $ilDB, $lng, and ILIAS\Repository\int().

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

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
         $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 ((int) $row->defaultvalue === 1 && (int) $row->owner_fi === 0) {
                 $categories[$row->category_id] = $lng->txt($row->title);
             } else {
                 $categories[$row->category_id] = $row->title;
             }
         }
         return $categories;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deletePhrases()

ilSurveyPhrases::deletePhrases ( array $phrase_array )

Delete phrases from the database.

Parameters

array $phrase_array An array containing phrase id's to delete

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

References $db, and $ilDB.

      : void {
         $ilDB = $this->db;
 
         if (count($phrase_array) > 0) {
             $ilDB->manipulate("DELETE FROM svy_phrase WHERE " . $ilDB->in('phrase_id', $phrase_array, false, 'integer'));
             $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 169 of file class.ilSurveyPhrases.php.

References $db, $i, $ilDB, $ilUser, and $user.

                                 : void
     {
         $ilUser = $this->user;
         $ilDB = $this->db;
 
         $next_id = $ilDB->nextId('svy_phrase');
         $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 ( int $phrase_id )

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

References $db, $i, $ilDB, $ilUser, and $user.

      : void {
         $ilUser = $this->user;
         $ilDB = $this->db;
 
         $ilDB->manipulateF(
             "UPDATE svy_phrase SET title = %s, tstamp = %s WHERE phrase_id = %s",
             array('text','integer','integer'),
             array($this->title, time(), $phrase_id)
         );
 
         $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

array ilSurveyPhrases::$arrData

protected

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

◆ $db

ilDBInterface ilSurveyPhrases::$db

protected

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

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

◆ $user

ilObjUser ilSurveyPhrases::$user

protected

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

Referenced by savePhrase(), and updatePhrase().

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

Modules/SurveyQuestionPool/Phrases/class.ilSurveyPhrases.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ __set()

◆ _getAvailablePhrases()

◆ _getCategoriesForPhrase()

◆ deletePhrases()

◆ savePhrase()

◆ updatePhrase()

Field Documentation

◆ $arrData

◆ $db

◆ $user