Survey phrases GUI class. More...

Collaboration diagram for ilSurveyPhrasesGUI:

Public Member Functions
	__construct ($a_object)
	ilSurveyPhrasesGUI constructor More...

	executeCommand ()
	execute command More...

	getCommand ($cmd)
	Retrieves the ilCtrl command. More...

	deletePhrase ()
	Creates a confirmation form to delete personal phases from the database. More...

	phrases ()
	Displays a form to manage the user created phrases. More...

	cancelDeletePhrase ()
	cancel delete phrases More...

	confirmDeletePhrase ()
	confirm delete phrases More...

	deletePhrasesForm ($checked_phrases)
	Creates a confirmation form to delete personal phases from the database. More...

	cancelEditPhrase ()

	saveEditPhrase ()

	writePostData ($always=false)
	Evaluates a posted edit form and writes the form data in the question object. More...

	newPhrase ()

	editPhrase ()

	phraseEditor ($checkonly=false)

Data Fields
	$object

	$gui_object

	$lng

	$tpl

	$ctrl

	$tree

	$ref_id

Protected Member Functions
	getCategoriesForPhrase ($phrase_id)

	getPhraseTitle ($phrase_id)

Protected Attributes
	$rbacsystem

	$toolbar

	$db

Detailed Description

Survey phrases GUI class.

The ilSurveyPhrases GUI class creates the GUI output for survey phrases (collections of survey categories) of ordinal survey question types.

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilSurveyPhrasesGUI::__construct ( $a_object )

ilSurveyPhrasesGUI constructor

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

References $DIC, $ilCtrl, $lng, $tpl, and $tree.

     {
         global $DIC;
 
         $this->rbacsystem = $DIC->rbac()->system();
         $this->toolbar = $DIC->toolbar();
         $this->db = $DIC->database();
         $lng = $DIC->language();
         $tpl = $DIC["tpl"];
         $ilCtrl = $DIC->ctrl();
         $tree = $DIC->repositoryTree();
 
         include_once "./Modules/SurveyQuestionPool/classes/class.ilSurveyPhrases.php";
         $this->lng = $lng;
         $this->tpl = $tpl;
         $this->ctrl = $ilCtrl;
         $this->gui_object = $a_object;
         $this->object = new ilSurveyPhrases();
         $this->tree = $tree;
         $this->ref_id = $a_object->ref_id;
         $this->ctrl->saveParameter($this, "p_id");
     }

Member Function Documentation

◆ cancelDeletePhrase()

ilSurveyPhrasesGUI::cancelDeletePhrase ( )

cancel delete phrases

Definition at line 168 of file class.ilSurveyPhrasesGUI.php.

     {
         $this->ctrl->redirect($this, "phrases");
     }

◆ cancelEditPhrase()

ilSurveyPhrasesGUI::cancelEditPhrase ( )

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

     {
         $this->ctrl->redirect($this, 'phrases');
     }

◆ confirmDeletePhrase()

ilSurveyPhrasesGUI::confirmDeletePhrase ( )

confirm delete phrases

Definition at line 176 of file class.ilSurveyPhrasesGUI.php.

References $_POST, and ilUtil\sendSuccess().

     {
         $phrases = $_POST['phrase'];
         $this->object->deletePhrases($phrases);
         ilUtil::sendSuccess($this->lng->txt("qpl_phrases_deleted"), true);
         $this->ctrl->redirect($this, "phrases");
     }

Here is the call graph for this function:

◆ deletePhrase()

ilSurveyPhrasesGUI::deletePhrase ( )

Creates a confirmation form to delete personal phases from the database.

Definition at line 115 of file class.ilSurveyPhrasesGUI.php.

References $_POST, deletePhrasesForm(), phrases(), ilUtil\sendInfo(), and ilUtil\sendQuestion().

     {
         ilUtil::sendInfo();
 
         $checked_phrases = $_POST['phrase'];
         if (count($checked_phrases)) {
             ilUtil::sendQuestion($this->lng->txt("qpl_confirm_delete_phrases"));
             $this->deletePhrasesForm($checked_phrases);
             return;
         } else {
             ilUtil::sendInfo($this->lng->txt("qpl_delete_phrase_select_none"));
             $this->phrases();
             return;
         }
     }

Here is the call graph for this function:

◆ deletePhrasesForm()

ilSurveyPhrasesGUI::deletePhrasesForm ( $checked_phrases )

Creates a confirmation form to delete personal phases from the database.

Parameters

array $checked_phrases An array with the id's of the phrases checked for deletion

Definition at line 224 of file class.ilSurveyPhrasesGUI.php.

References $data, ilSurveyPhrases\_getAvailablePhrases(), ilSurveyPhrases\_getCategoriesForPhrase(), and array.

Referenced by deletePhrase().

     {
         include_once "./Modules/SurveyQuestionPool/classes/tables/class.ilSurveyPhrasesTableGUI.php";
         $table_gui = new ilSurveyPhrasesTableGUI($this, 'phrases', true);
         $phrases =&ilSurveyPhrases::_getAvailablePhrases(1);
         $data = array();
         foreach ($checked_phrases as $phrase_id) {
             $phrase_array = $phrases[$phrase_id];
             $categories =&ilSurveyPhrases::_getCategoriesForPhrase($phrase_id);
             array_push($data, array('phrase_id' => $phrase_id, 'phrase' => $phrase_array["title"], 'answers' => join($categories, ", ")));
         }
         $table_gui->setData($data);
         $this->tpl->setVariable('ADM_CONTENT', $table_gui->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editPhrase()

ilSurveyPhrasesGUI::editPhrase ( )

Definition at line 293 of file class.ilSurveyPhrasesGUI.php.

References $_POST, and ilUtil\sendFailure().

     {
         if (!array_key_exists('phrase', $_POST)) {
             ilUtil::sendFailure($this->lng->txt('no_phrase_selected'), true);
             $this->ctrl->redirect($this, 'phrases');
         }
         if ((array_key_exists('phrase', $_POST)) && count($_POST['phrase']) > 1) {
             ilUtil::sendFailure($this->lng->txt('select_max_one_item'), true);
             $this->ctrl->redirect($this, 'phrases');
         }
         $phrase_id = (array_key_exists('phrase', $_POST)) ? $_POST['phrase'][key($_POST['phrase'])] : null;
         if ($phrase_id) {
             $this->ctrl->setParameter($this, 'p_id', $phrase_id);
         }
         $this->ctrl->redirect($this, 'phraseEditor');
     }

Here is the call graph for this function:

◆ executeCommand()

ilSurveyPhrasesGUI::executeCommand ( )

execute command

Definition at line 90 of file class.ilSurveyPhrasesGUI.php.

References $ret, and getCommand().

     {
         $cmd = $this->ctrl->getCmd();
         $next_class = $this->ctrl->getNextClass($this);
 
         $cmd = $this->getCommand($cmd);
         switch ($next_class) {
             default:
                 $ret =&$this->$cmd();
                 break;
         }
         return $ret;
     }

Here is the call graph for this function:

◆ getCategoriesForPhrase()

ilSurveyPhrasesGUI::getCategoriesForPhrase ( $phrase_id )

protected

Definition at line 184 of file class.ilSurveyPhrasesGUI.php.

References $data, $db, $ilDB, $result, and array.

Referenced by phraseEditor().

     {
         $ilDB = $this->db;
         
         include_once "./Modules/SurveyQuestionPool/classes/class.SurveyCategories.php";
         $categories = new SurveyCategories();
         $result = $ilDB->queryF(
             "SELECT svy_category.title, svy_category.neutral, svy_phrase_cat.sequence FROM svy_phrase_cat, svy_category WHERE svy_phrase_cat.phrase_fi = %s AND svy_phrase_cat.category_fi = svy_category.category_id ORDER BY svy_phrase_cat.sequence ASC",
             array('integer'),
             array($phrase_id)
         );
         if ($result->numRows() > 0) {
             while ($data = $ilDB->fetchAssoc($result)) {
                 $categories->addCategory($data["title"], 0, $data["neutral"], null, $data['sequence']);
             }
         }
         return $categories;
     }

Here is the caller graph for this function:

◆ getCommand()

ilSurveyPhrasesGUI::getCommand ( $cmd )

Retrieves the ilCtrl command.

Definition at line 107 of file class.ilSurveyPhrasesGUI.php.

Referenced by executeCommand().

     {
         return $cmd;
     }

Here is the caller graph for this function:

◆ getPhraseTitle()

ilSurveyPhrasesGUI::getPhraseTitle ( $phrase_id )

protected

Definition at line 203 of file class.ilSurveyPhrasesGUI.php.

References $db, $ilDB, $result, $row, and array.

Referenced by phraseEditor().

     {
         $ilDB = $this->db;
         
         $result = $ilDB->queryF(
             "SELECT svy_phrase.title FROM svy_phrase WHERE svy_phrase.phrase_id = %s",
             array('integer'),
             array($phrase_id)
         );
         if ($result->numRows() > 0) {
             $row = $ilDB->fetchAssoc($result);
             return $row['title'];
         }
         return null;
     }

Here is the caller graph for this function:

◆ newPhrase()

ilSurveyPhrasesGUI::newPhrase ( )

Definition at line 288 of file class.ilSurveyPhrasesGUI.php.

     {
         $this->ctrl->redirect($this, 'phraseEditor');
     }

◆ phraseEditor()

ilSurveyPhrasesGUI::phraseEditor ( $checkonly = false )

Definition at line 310 of file class.ilSurveyPhrasesGUI.php.

References $_GET, $errors, $form, $title, getCategoriesForPhrase(), getPhraseTitle(), and ilFormPropertyGUI\setRequired().

Referenced by writePostData().

     {
         $save = (strcmp($this->ctrl->getCmd(), "saveEditPhrase") == 0) ? true : false;
 
         include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this, 'phraseEditor'));
         $form->setTitle($this->lng->txt('edit_phrase'));
         $form->setMultipart(false);
         $form->setTableWidth("100%");
         $form->setId("phraseeditor");
 
         $phrase_id = $_GET['p_id'];
 
         // title
         $title = new ilTextInputGUI($this->lng->txt("title"), "title");
         $title->setValue($this->getPhraseTitle($phrase_id));
         $title->setRequired(true);
         $form->addItem($title);
 
         // Answers
         include_once "./Modules/SurveyQuestionPool/classes/class.ilCategoryWizardInputGUI.php";
         $answers = new ilCategoryWizardInputGUI($this->lng->txt("answers"), "answers");
         $answers->setRequired(true);
         $answers->setAllowMove(true);
         $answers->setShowWizard(false);
         $answers->setShowSavePhrase(false);
         $answers->setUseOtherAnswer(false);
         $answers->setShowNeutralCategory(true);
         $answers->setNeutralCategoryTitle($this->lng->txt('matrix_neutral_answer'));
         include_once "./Modules/SurveyQuestionPool/classes/class.SurveyCategories.php";
         $categories =&$this->getCategoriesForPhrase($phrase_id);
         if (!$categories->getCategoryCount()) {
             $categories->addCategory("");
         }
         $answers->setValues($categories);
         $answers->setDisabledScale(true);
         $form->addItem($answers);
 
         $form->addCommandButton("saveEditPhrase", $this->lng->txt("save"));
         $form->addCommandButton("cancelEditPhrase", $this->lng->txt("cancel"));
 
         $errors = false;
 
         if ($save) {
             $form->setValuesByPost();
             $errors = !$form->checkInput();
             $form->setValuesByPost(); // again, because checkInput now performs the whole stripSlashes handling and we need this if we don't want to have duplication of backslashes
             if ($errors) {
                 $checkonly = false;
             }
         }
 
         if (!$checkonly) {
             $this->tpl->setVariable("ADM_CONTENT", $form->getHTML());
         }
         return $errors;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ phrases()

ilSurveyPhrasesGUI::phrases ( )

Displays a form to manage the user created phrases.

public

Definition at line 136 of file class.ilSurveyPhrasesGUI.php.

References $data, $rbacsystem, $toolbar, ilSurveyPhrases\_getAvailablePhrases(), ilSurveyPhrases\_getCategoriesForPhrase(), array, ilLinkButton\getInstance(), and ilUtil\sendInfo().

Referenced by deletePhrase().

     {
         $rbacsystem = $this->rbacsystem;
         $ilToolbar = $this->toolbar;
         
         $this->ctrl->setParameter($this, "p_id", "");
         
         if ($rbacsystem->checkAccess("write", $this->ref_id)) {
             include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
             $button = ilLinkButton::getInstance();
             $button->setCaption("phrase_new");
             $button->setUrl($this->ctrl->getLinkTarget($this, "newPhrase"));
             $ilToolbar->addButtonInstance($button);
         
             include_once "./Modules/SurveyQuestionPool/classes/tables/class.ilSurveyPhrasesTableGUI.php";
             $table_gui = new ilSurveyPhrasesTableGUI($this, 'phrases');
             $phrases =&ilSurveyPhrases::_getAvailablePhrases(1);
             $data = array();
             foreach ($phrases as $phrase_id => $phrase_array) {
                 $categories =&ilSurveyPhrases::_getCategoriesForPhrase($phrase_id);
                 array_push($data, array('phrase_id' => $phrase_id, 'phrase' => $phrase_array["title"], 'answers' => join($categories, ", ")));
             }
             $table_gui->setData($data);
             $this->tpl->setContent($table_gui->getHTML());
         } else {
             ilUtil::sendInfo($this->lng->txt("cannot_manage_phrases"));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveEditPhrase()

ilSurveyPhrasesGUI::saveEditPhrase ( )

Definition at line 244 of file class.ilSurveyPhrasesGUI.php.

References $_GET, $result, ilUtil\sendSuccess(), and writePostData().

     {
         $result = $this->writePostData();
         if ($result == 0) {
             if ($_GET['p_id']) {
                 $this->object->updatePhrase($_GET['p_id']);
                 ilUtil::sendSuccess($this->lng->txt('phrase_saved'), true);
             } else {
                 $this->object->savePhrase();
                 ilUtil::sendSuccess($this->lng->txt('phrase_added'), true);
             }
             $this->ctrl->redirect($this, 'phrases');
         }
     }

Here is the call graph for this function:

◆ writePostData()

ilSurveyPhrasesGUI::writePostData ( $always = false )

Evaluates a posted edit form and writes the form data in the question object.

Returns: integer A positive value, if one of the required fields wasn't set, else 0 private

Definition at line 265 of file class.ilSurveyPhrasesGUI.php.

References $_POST, $db, $ilDB, $key, and phraseEditor().

Referenced by saveEditPhrase().

     {
         $ilDB = $this->db;
         $hasErrors = (!$always) ? $this->phraseEditor(true) : false;
         if (!$hasErrors) {
             $this->object->title = $_POST["title"];
             include_once "./Modules/SurveyQuestionPool/classes/class.SurveyCategories.php";
             $categories = new SurveyCategories();
             foreach ($_POST['answers']['answer'] as $key => $value) {
                 if (strlen($value)) {
                     $categories->addCategory($value, $_POST['answers']['other'][$key], 0, null, $_POST['answers']['scale'][$key]);
                 }
             }
             if (strlen($_POST['answers']['neutral'])) {
                 $categories->addCategory($_POST['answers']['neutral'], 0, 1, null, $_POST['answers_neutral_scale']);
             }
             $this->object->categories = $categories;
             return 0;
         } else {
             return 1;
         }
     }