Basic class for all survey question types The SurveyQuestionGUI class defines and encapsulates basic methods and attributes for survey question types to be used for all parent classes. More...

Inheritance diagram for SurveyQuestionGUI:

Collaboration diagram for SurveyQuestionGUI:

Public Member Functions
	__construct ($a_id=-1)

	setQuestionTabs ()

	executeCommand ()

	getQuestionType ()
	Returns the question type string. More...

	setBackUrl (string $a_url)

	setQuestionTabsForClass (string $guiclass)

	getPrintView (int $question_title=1, bool $show_questiontext=true, ?int $survey_id=null, ?array $working_data=null)

	preview ()

	getWorkingForm (?array $working_data=null, int $question_title=1, bool $show_questiontext=true, string $error_message="", ?int $survey_id=null, bool $compress_view=false)

Static Public Member Functions
static	_getQuestionGUI (?string $questiontype, int $question_id=-1)
	Creates a question gui representation. More...

static	_getGUIClassNameForId (int $a_q_id)

static	_getClassNameForQType (string $q_type)

Data Fields
SurveyQuestion	$object = null

Protected Member Functions
	initObject ()

	outQuestionText (ilTemplate $template)

	initEditForm ()

	addCommandButtons (ilPropertyFormGUI $a_form)

	editQuestion (?ilPropertyFormGUI $a_form=null)

	saveSync ()

	saveReturn ()

	saveForm ()

	save (bool $a_return=false, bool $a_sync=false)

	copySyncForm ()

	syncCopies ()

	originalSyncForm ()

	sync ()

	cancelSync ()

	redirectAfterSaving (bool $a_return=false)
	Redirect to calling survey or to edit form. More...

	cancel ()

	validateEditForm (ilPropertyFormGUI $a_form)

	addFieldsToEditForm (ilPropertyFormGUI $a_form)

	importEditFormValues (ilPropertyFormGUI $a_form)

	getPrintViewQuestionTitle (int $question_title=1)

	getQuestionTitle (int $question_title_mode=1)

	renderStatisticsDetailsTable (array $a_head, array $a_rows, ?array $a_foot=null)

Protected Attributes
ILIAS Survey InternalDomainService	$domain

ILIAS Survey InternalGUIService	$gui

EditingGUIRequest	$request

EditManager	$edit_manager

ilRbacSystem	$rbacsystem

ilObjUser	$user

ilAccessHandler	$access

ilTree	$tree

ilToolbarGUI	$toolbar

ilTabsGUI	$tabs

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilCtrl	$ctrl

array	$cumulated = []

string	$parent_url = ""

ilLogger	$log

ilHtmlPurifierInterface	$purifier

Detailed Description

Basic class for all survey question types The SurveyQuestionGUI class defines and encapsulates basic methods and attributes for survey question types to be used for all parent classes.

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 30 of file class.SurveyQuestionGUI.php.

Constructor & Destructor Documentation

◆ __construct()

SurveyQuestionGUI::__construct ( $a_id = -1 )

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

    {
        global $DIC;
 
        $this->rbacsystem = $DIC->rbac()->system();
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $this->tree = $DIC->repositoryTree();
        $this->toolbar = $DIC->toolbar();
        $lng = $DIC->language();
        $tpl = $DIC["tpl"];
        $ilCtrl = $DIC->ctrl();
 
 
        $this->request = $DIC->surveyQuestionPool()
                             ->internal()
                             ->gui()
                             ->editing()
                             ->request();
 
        $this->lng = $lng;
        $this->tpl = $tpl;
        $this->ctrl = $ilCtrl;
        $this->ctrl->saveParameter($this, "q_id");
        $this->ctrl->setParameterByClass(
            $this->ctrl->getCmdClass(),
            "sel_question_types",
            $this->request->getSelectedQuestionTypes()
        );
        $this->cumulated = array();
        $this->tabs = $DIC->tabs();
 
        $this->initObject();
 
        if ($a_id > 0) {
            $this->object->loadFromDb($a_id);
        }
        $this->log = ilLoggerFactory::getLogger('svy');
 
        $this->edit_manager = $DIC->surveyQuestionPool()
            ->internal()
            ->domain()
            ->editing();
        $this->gui = $DIC->survey()->internal()->gui();
        $this->domain = $DIC->survey()->internal()->domain();
        $this->purifier = new ilSvyStandardPurifier();
    }

References $DIC, $lng, $tpl, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), initObject(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ _getClassNameForQType()

static SurveyQuestionGUI::_getClassNameForQType ( string $q_type )

static

Definition at line 139 of file class.SurveyQuestionGUI.php.

                                                                : string
    {
        return $q_type;
    }

Referenced by _getGUIClassNameForId().

Here is the caller graph for this function:

◆ _getGUIClassNameForId()

static SurveyQuestionGUI::_getGUIClassNameForId ( int $a_q_id )

static

Definition at line 132 of file class.SurveyQuestionGUI.php.

                                                             : string
    {
        $q_type = SurveyQuestion::_getQuestionType($a_q_id);
        $class_name = SurveyQuestionGUI::_getClassNameForQType($q_type);
        return $class_name;
    }

References _getClassNameForQType(), and SurveyQuestion\_getQuestionType().

Referenced by ilSurveyQuestionsTableGUI\fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getQuestionGUI()

static SurveyQuestionGUI::_getQuestionGUI	(	?string	$questiontype,
		int	$question_id = `-1`
	)

static

Creates a question gui representation.

Todo:: move to factory

Definition at line 119 of file class.SurveyQuestionGUI.php.

     : SurveyQuestionGUI {
        if ((!$questiontype) and ($question_id > 0)) {
            $questiontype = SurveyQuestion::_getQuestionType($question_id);
        }
        SurveyQuestion::_includeClass($questiontype, 1);
        $question_type_gui = $questiontype . "GUI";
        $question = new $question_type_gui($question_id);
        return $question;
    }

References SurveyQuestion\_getQuestionType().

Referenced by ilObjSurveyQuestionPoolGUI\createQuestionObject(), ilSurveyEditorGUI\executeCommand(), ilObjSurveyQuestionPoolGUI\executeCommand(), and ilObjSurveyQuestionPoolGUI\previewObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCommandButtons()

SurveyQuestionGUI::addCommandButtons ( ilPropertyFormGUI $a_form )

protected

Definition at line 296 of file class.SurveyQuestionGUI.php.

                                                                   : void
    {
        $a_form->addCommandButton("saveReturn", $this->lng->txt("save_return"));
        $a_form->addCommandButton("save", $this->lng->txt("save"));
 
        // pool question?
        if (ilObject::_lookupType($this->object->getObjId()) === "spl" && $this->object->hasCopies()) {
            $a_form->addCommandButton("saveSync", $this->lng->txt("svy_save_sync"));
        }
    }

References ilObject\_lookupType(), ilPropertyFormGUI\addCommandButton(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ addFieldsToEditForm()

SurveyQuestionGUI::addFieldsToEditForm ( ilPropertyFormGUI $a_form )

abstractprotected

Reimplemented in SurveyMatrixQuestionGUI, SurveyMetricQuestionGUI, SurveyMultipleChoiceQuestionGUI, SurveySingleChoiceQuestionGUI, and SurveyTextQuestionGUI.

◆ cancel()

SurveyQuestionGUI::cancel ( )

protected

Definition at line 539 of file class.SurveyQuestionGUI.php.

                               : void
    {
        if ($this->parent_url) {
            ilUtil::redirect($this->parent_url);
        } else {
            $this->ctrl->redirectByClass("ilobjsurveyquestionpoolgui", "questions");
        }
    }

References ILIAS\Repository\ctrl(), and ilUtil\redirect().

Here is the call graph for this function:

◆ cancelSync()

SurveyQuestionGUI::cancelSync ( )

protected

Definition at line 491 of file class.SurveyQuestionGUI.php.

                                   : void
    {
        $this->tpl->setOnScreenMessage('info', $this->lng->txt("question_changed_in_survey_only"), true);
        $this->redirectAfterSaving($this->request->getReturn());
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ copySyncForm()

SurveyQuestionGUI::copySyncForm ( )

protected

Definition at line 405 of file class.SurveyQuestionGUI.php.

                                     : void
    {
        $ilTabs = $this->tabs;
 
        $ilTabs->activateTab("edit_properties");
 
        $tbl = new ilSurveySyncTableGUI($this, "copySyncForm", $this->object);
 
        $this->tpl->setContent($tbl->getHTML());
    }

◆ editQuestion()

SurveyQuestionGUI::editQuestion ( ?ilPropertyFormGUI $a_form = null )

protected

Definition at line 307 of file class.SurveyQuestionGUI.php.

                                                                      : void
    {
        $ilTabs = $this->tabs;
 
        $ilTabs->activateTab("edit_properties");
 
        if (!$a_form) {
            $a_form = $this->initEditForm();
        }
        $this->tpl->setContent($a_form->getHTML());
    }

◆ executeCommand()

SurveyQuestionGUI::executeCommand ( )

Definition at line 103 of file class.SurveyQuestionGUI.php.

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getPrintView()

SurveyQuestionGUI::getPrintView	(	int	$question_title = `1`,
		bool	$show_questiontext = `true`,
		?int	$survey_id = `null`,
		?array	$working_data = `null`
	)

abstract

Reimplemented in SurveyMatrixQuestionGUI, SurveyMetricQuestionGUI, SurveyMultipleChoiceQuestionGUI, SurveySingleChoiceQuestionGUI, and SurveyTextQuestionGUI.

◆ getPrintViewQuestionTitle()

SurveyQuestionGUI::getPrintViewQuestionTitle ( int $question_title = 1 )

protected

Definition at line 564 of file class.SurveyQuestionGUI.php.

     : string {
        $title = "";
        switch ($question_title) {
            case ilObjSurvey::PRINT_HIDE_LABELS:
                $title = ilLegacyFormElementsUtil::prepareFormOutput($this->object->getTitle());
                break;
 
                #19448  get rid of showing only the label without title
                //case 2:
                //      $title = ilUtil::prepareFormOutput($this->object->getLabel());
                //      break;
 
            case ilObjSurvey::PRINT_SHOW_LABELS:
                $title = ilLegacyFormElementsUtil::prepareFormOutput($this->object->getTitle());
                if (trim($this->object->getLabel())) {
                    $title .= ' <span class="questionLabel">(' . ilLegacyFormElementsUtil::prepareFormOutput(
                        $this->object->getLabel()
                    ) . ')</span>';
                }
                break;
        }
        return $title;
    }

References ILIAS\Repository\object(), ilLegacyFormElementsUtil\prepareFormOutput(), ilObjSurvey\PRINT_HIDE_LABELS, and ilObjSurvey\PRINT_SHOW_LABELS.

Here is the call graph for this function:

◆ getQuestionTitle()

SurveyQuestionGUI::getQuestionTitle ( int $question_title_mode = 1 )

protected

Definition at line 590 of file class.SurveyQuestionGUI.php.

     : string {
        $title = "";
        switch ($question_title_mode) {
            case ilObjSurvey::PRINT_HIDE_LABELS:
                $title = $this->object->getTitle();
                break;
 
            case ilObjSurvey::PRINT_SHOW_LABELS:
                $title = $this->object->getTitle();
                if (trim($this->object->getLabel())) {
                    $title .= ' <span class="questionLabel">(' .
                            $this->object->getLabel()
                         . ')</span>';
                }
                break;
        }
        return $title;
    }

References ILIAS\Repository\object(), ilObjSurvey\PRINT_HIDE_LABELS, and ilObjSurvey\PRINT_SHOW_LABELS.

Here is the call graph for this function:

◆ getQuestionType()

SurveyQuestionGUI::getQuestionType ( )

Returns the question type string.

Definition at line 147 of file class.SurveyQuestionGUI.php.

                                     : string
    {
        return $this->object->getQuestionType();
    }

◆ getWorkingForm()

SurveyQuestionGUI::getWorkingForm	(	?array	$working_data = `null`,
		int	$question_title = `1`,
		bool	$show_questiontext = `true`,
		string	$error_message = `""`,
		?int	$survey_id = `null`,
		bool	$compress_view = `false`
	)

abstract

Reimplemented in SurveyMatrixQuestionGUI, SurveyMetricQuestionGUI, SurveyMultipleChoiceQuestionGUI, SurveySingleChoiceQuestionGUI, and SurveyTextQuestionGUI.

◆ importEditFormValues()

SurveyQuestionGUI::importEditFormValues ( ilPropertyFormGUI $a_form )

abstractprotected

Reimplemented in SurveyMatrixQuestionGUI, SurveyMetricQuestionGUI, SurveyMultipleChoiceQuestionGUI, SurveySingleChoiceQuestionGUI, and SurveyTextQuestionGUI.

◆ initEditForm()

SurveyQuestionGUI::initEditForm ( )

protected

Definition at line 228 of file class.SurveyQuestionGUI.php.

                                     : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "save"));
        $form->setTitle($this->lng->txt($this->getQuestionType()));
        $form->setMultipart(false);
        $form->setTableWidth("100%");
        // $form->setId("essay");
 
        // title
        $title = new ilTextInputGUI($this->lng->txt("title"), "title");
        $title->setMaxLength(200);
        $title->setRequired(true);
        $form->addItem($title);
 
        // label
        $label = new ilTextInputGUI($this->lng->txt("label"), "label");
        $label->setInfo($this->lng->txt("label_info"));
        $title->setMaxLength(255);
        $label->setRequired(false);
        $form->addItem($label);
 
        // author
        $author = new ilTextInputGUI($this->lng->txt("author"), "author");
        $author->setRequired(true);
        $title->setMaxLength(100);
        $form->addItem($author);
 
        // description
        $description = new ilTextInputGUI($this->lng->txt("description"), "description");
        $description->setRequired(false);
        $title->setMaxLength(200);
        $form->addItem($description);
 
        // questiontext
        $question = new ilTextAreaInputGUI($this->lng->txt("question"), "question");
        $question->setRequired(true);
        $question->setRows(10);
        $question->setCols(80);
        if ((new \ilRTESettings($this->lng, $this->user))->getRichTextEditor() === "tinymce") {
            $question->setUseRte(true);
            $question->setRteTagSet("mini");
        }
        $question->usePurifier(true);
        $question->setPurifier($this->purifier);
        $form->addItem($question);
 
        // obligatory
        $shuffle = new ilCheckboxInputGUI($this->lng->txt("obligatory"), "obligatory");
        $shuffle->setValue("1");
        $shuffle->setRequired(false);
        $form->addItem($shuffle);
 
        $this->addFieldsToEditForm($form);
 
        $this->addCommandButtons($form);
 
        // values
        $title->setValue($this->object->getTitle());
        $label->setValue($this->object->label);
        $author->setValue($this->object->getAuthor());
        $description->setValue($this->object->getDescription());
        $question->setValue($this->object->prepareTextareaOutput($this->object->getQuestiontext()));
        $shuffle->setChecked($this->object->getObligatory());
 
        return $form;
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ initObject()

SurveyQuestionGUI::initObject ( )

abstractprotected

Reimplemented in SurveyMatrixQuestionGUI, SurveyMetricQuestionGUI, SurveyMultipleChoiceQuestionGUI, SurveySingleChoiceQuestionGUI, and SurveyTextQuestionGUI.

Referenced by __construct().

Here is the caller graph for this function:

◆ originalSyncForm()

SurveyQuestionGUI::originalSyncForm ( )

protected

Definition at line 462 of file class.SurveyQuestionGUI.php.

                                         : void
    {
        $ilTabs = $this->tabs;
 
        $ilTabs->activateTab("edit_properties");
 
        $this->ctrl->saveParameter($this, "rtrn");
 
        $cgui = new ilConfirmationGUI();
        $cgui->setHeaderText($this->lng->txt("confirm_sync_questions"));
 
        $cgui->setFormAction($this->ctrl->getFormAction($this, "confirmRemoveQuestions"));
        $cgui->setCancel($this->lng->txt("no"), "cancelSync");
        $cgui->setConfirm($this->lng->txt("yes"), "sync");
 
        $this->tpl->setContent($cgui->getHTML());
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ outQuestionText()

SurveyQuestionGUI::outQuestionText ( ilTemplate $template )

protected

Definition at line 152 of file class.SurveyQuestionGUI.php.

                                                            : void
    {
        $questiontext = $this->object->getQuestiontext();
        if (preg_match("/^<.[\\>]?>(.*?)<\\/.[\\>]*?>$/", $questiontext, $matches)) {
            $questiontext = $matches[1];
        }
        $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, true));
        if ($this->object->getObligatory()) {
            $template->setVariable("OBLIGATORY_TEXT", ' *');
        }
    }

References ILIAS\Repository\object(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ preview()

SurveyQuestionGUI::preview ( )

Definition at line 611 of file class.SurveyQuestionGUI.php.

                             : void
    {
        $ilTabs = $this->tabs;
 
        $ilTabs->activateTab("preview");
 
        $tpl = new ilTemplate("tpl.il_svy_qpl_preview.html", true, true, "components/ILIAS/SurveyQuestionPool");
 
        if ($this->object->getObligatory()) {
            $tpl->setCurrentBlock("required");
            $tpl->setVariable("TEXT_REQUIRED", $this->lng->txt("required_field"));
            $tpl->parseCurrentBlock();
        }
 
        $tpl->setVariable("QUESTION_OUTPUT", $this->getWorkingForm());
 
        $f = $this->gui->ui()->factory();
        $r = $this->gui->ui()->renderer();
        $p = $f->panel()->standard(
            "",
            $f->legacy()->content($tpl->get())
        );
 
        $this->tpl->setContent($r->render($p));
    }

References Vendor\Package\$f, ILIAS\News\Common\Table\$tpl, ILIAS\UICore\GlobalTemplate\get(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), and ILIAS\UICore\GlobalTemplate\setVariable().

Here is the call graph for this function:

◆ redirectAfterSaving()

SurveyQuestionGUI::redirectAfterSaving ( bool $a_return = false )

protected

Redirect to calling survey or to edit form.

Definition at line 500 of file class.SurveyQuestionGUI.php.

     : void {
        // return?
        if ($a_return) {
            // to calling survey
            if ($this->parent_url) {
                $addurl = "";
                if ($this->request->getNewForSurvey() > 0) {
                    $addurl = "&new_id=" . $this->request->getQuestionId();
                }
                ilUtil::redirect(str_replace("&amp;", "&", $this->parent_url) . $addurl);
            }
            // to pool
            else {
                $this->ctrl->redirectByClass("ilObjSurveyQuestionPoolGUI", "questions");
            }
        }
        // stay in form
        else {
            $this->ctrl->setParameterByClass(
                $this->ctrl->getCmdClass(),
                "q_id",
                $this->object->getId()
            );
            $this->ctrl->setParameterByClass(
                $this->ctrl->getCmdClass(),
                "sel_question_types",
                $this->request->getSelectedQuestionTypes()
            );
            $this->ctrl->setParameterByClass(
                $this->ctrl->getCmdClass(),
                "new_for_survey",
                $this->request->getNewForSurvey()
            );
            $this->ctrl->redirectByClass($this->ctrl->getCmdClass(), "editQuestion");
        }
    }

References ILIAS\Repository\ctrl(), and ilUtil\redirect().

Here is the call graph for this function:

◆ renderStatisticsDetailsTable()

SurveyQuestionGUI::renderStatisticsDetailsTable	(	array	$a_head,
		array	$a_rows,
		?array	$a_foot = `null`
	)

protected

Definition at line 652 of file class.SurveyQuestionGUI.php.

     : string {
        $html = array();
        $html[] = '<div class="ilTableOuter table-responsive">';
        $html[] = '<table class="table table-striped">';
 
        $html[] = "<thead>";
        $html[] = "<tr>";
        foreach ($a_head as $col) {
            $col = trim($col);
            $html[] = "<th>";
            $html[] = ($col != "") ? $col : "&nbsp;";
            $html[] = "</th>";
        }
        $html[] = "</tr>";
        $html[] = "</thead>";
 
        $html[] = "<tbody>";
        foreach ($a_rows as $row) {
            $html[] = "<tr>";
            foreach ($row as $col) {
                $col = trim($col);
                $html[] = "<td>";
                $html[] = ($col != "") ? $col : "&nbsp;";
                $html[] = "</td>";
            }
            $html[] = "</tr>";
        }
        $html[] = "</tbody>";
 
        if ($a_foot) {
            $html[] = "<tfoot>";
            $html[] = "<tr>";
            foreach ($a_foot as $col) {
                $col = trim($col);
                $html[] = "<td>";
                $html[] = ($col != "") ? $col : "&nbsp;";
                $html[] = "</td>";
            }
            $html[] = "</tr>";
            $html[] = "</tfoot>";
        }
 
        $html[] = "</table>";
        $html[] = "</div>";
        return implode("\n", $html);
    }

◆ save()

SurveyQuestionGUI::save	(	bool	$a_return = `false`,
		bool	$a_sync = `false`
	)

protected

Definition at line 357 of file class.SurveyQuestionGUI.php.

     : void {
        $ilUser = $this->user;
 
        if ($this->saveForm()) {
            // #13784
            if ($a_return &&
                !SurveyQuestion::_isComplete($this->object->getId())) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt("survey_error_insert_incomplete_question"));
                $this->editQuestion();
                return;
            }
 
            $ilUser->setPref("svy_lastquestiontype", $this->object->getQuestionType());
            $ilUser->writePref("svy_lastquestiontype", $this->object->getQuestionType());
 
            $originalexists = SurveyQuestion::_questionExists((int) $this->object->original_id);
            $this->ctrl->setParameter($this, "q_id", $this->object->getId());
 
            // pool question?
            if ($a_sync) {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
                $this->ctrl->redirect($this, 'copySyncForm');
            } elseif ($originalexists &&
                SurveyQuestion::_isWriteable($this->object->original_id, $ilUser->getId())) {
                // form: update original pool question, too?
                if ($a_return) {
                    $this->ctrl->setParameter($this, 'rtrn', 1);
                }
                $this->ctrl->redirect($this, 'originalSyncForm');
            }
 
            // if we got a survey, already save in survey
            if ($this->request->getNewForSurvey() > 0) {
                $survey = new ilObjSurvey($this->request->getNewForSurvey());
                $this->domain->sequence(
                    $survey->getSurveyId(),
                    $survey
                )->appendQuestion($this->object->getId());  // will check if question is already in survey
            }
 
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
            $this->redirectAfterSaving($a_return);
        }
    }

References SurveyQuestion\_isComplete(), SurveyQuestion\_isWriteable(), SurveyQuestion\_questionExists(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ saveForm()

SurveyQuestionGUI::saveForm ( )

protected

Definition at line 329 of file class.SurveyQuestionGUI.php.

                                 : bool
    {
        $form = $this->initEditForm();
        if ($form->checkInput() && $this->validateEditForm($form)) {
            $this->object->setTitle($form->getInput("title"));
            $this->object->label = ($form->getInput("label"));
            $this->object->setAuthor($form->getInput("author"));
            $this->object->setDescription($form->getInput("description"));
 
            $this->object->setQuestiontext(
                $this->purifier->purify($form->getInput("question"))
            );
 
            $this->object->setObligatory((bool) $form->getInput("obligatory"));
 
            $this->importEditFormValues($form);
 
            // will save both core and extended data
            $this->object->saveToDb();
 
            return true;
        }
 
        $form->setValuesByPost();
        $this->editQuestion($form);
        return false;
    }

◆ saveReturn()

SurveyQuestionGUI::saveReturn ( )

protected

Definition at line 324 of file class.SurveyQuestionGUI.php.

                                   : void
    {
        $this->save(true);
    }

◆ saveSync()

SurveyQuestionGUI::saveSync ( )

protected

Definition at line 319 of file class.SurveyQuestionGUI.php.

                                 : void
    {
        $this->save($this->request->getReturn(), true);
    }

◆ setBackUrl()

SurveyQuestionGUI::setBackUrl ( string $a_url )

Definition at line 164 of file class.SurveyQuestionGUI.php.

                                             : void
    {
        $this->parent_url = $a_url;
    }

◆ setQuestionTabs()

SurveyQuestionGUI::setQuestionTabs ( )

abstract

Reimplemented in SurveyMatrixQuestionGUI, SurveyMetricQuestionGUI, SurveyMultipleChoiceQuestionGUI, SurveySingleChoiceQuestionGUI, and SurveyTextQuestionGUI.

◆ setQuestionTabsForClass()

SurveyQuestionGUI::setQuestionTabsForClass ( string $guiclass )

Definition at line 169 of file class.SurveyQuestionGUI.php.

                                                             : void
    {
        $rbacsystem = $this->rbacsystem;
        $ilTabs = $this->tabs;
 
        $this->ctrl->setParameterByClass($guiclass, "sel_question_types", $this->getQuestionType());
        $this->ctrl->setParameterByClass(
            $guiclass,
            "q_id",
            $this->request->getQuestionId()
        );
 
        if ($this->parent_url) {
            $addurl = "";
            if ($this->request->getNewForSurvey() > 0) {
                $addurl = "&new_id=" . $this->request->getQuestionId();
            }
            $ilTabs->setBackTarget($this->lng->txt("menubacktosurvey"), $this->parent_url . $addurl);
        } else {
            $ilTabs->setBackTarget($this->lng->txt("spl"), $this->ctrl->getLinkTargetByClass("ilObjSurveyQuestionPoolGUI", "questions"));
        }
        if ($this->request->getQuestionId()) {
            $ilTabs->addNonTabbedLink(
                "preview",
                $this->lng->txt("preview"),
                $this->ctrl->getLinkTargetByClass($guiclass, "preview")
            );
        }
 
        if ($rbacsystem->checkAccess('edit', $this->request->getRefId())) {
            $ilTabs->addTab(
                "edit_properties",
                $this->lng->txt("properties"),
                $this->ctrl->getLinkTargetByClass($guiclass, "editQuestion")
            );
 
            if (stripos($guiclass, "matrix") !== false) {
                $ilTabs->addTab(
                    "layout",
                    $this->lng->txt("layout"),
                    $this->ctrl->getLinkTargetByClass($guiclass, "layout")
                );
            }
        }
 
        if ($this->object->getId() > 0) {
            $title = $this->lng->txt("edit") . " &quot;" . $this->object->getTitle() . "&quot";
        } else {
            $title = $this->lng->txt("create_new") . " " . $this->lng->txt($this->getQuestionType());
        }
 
        $this->tpl->setVariable("HEADER", $title);
    }

References ilRbacSystem\checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by SurveyMatrixQuestionGUI\setQuestionTabs(), SurveyMetricQuestionGUI\setQuestionTabs(), SurveyMultipleChoiceQuestionGUI\setQuestionTabs(), SurveySingleChoiceQuestionGUI\setQuestionTabs(), and SurveyTextQuestionGUI\setQuestionTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sync()

SurveyQuestionGUI::sync ( )

protected

Definition at line 480 of file class.SurveyQuestionGUI.php.

                             : void
    {
        $original_id = $this->object->original_id;
        if ($original_id) {
            $this->object->syncWithOriginal();
        }
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
        $this->redirectAfterSaving($this->request->getReturn());
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ syncCopies()

SurveyQuestionGUI::syncCopies ( )

protected

Definition at line 416 of file class.SurveyQuestionGUI.php.

                                   : void
    {
        $lng = $this->lng;
        $ilAccess = $this->access;
 
        $qids = $this->request->getQuestionIds();
        if (count($qids) === 0) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("select_one"));
            $this->copySyncForm();
            return;
        }
 
        foreach ($this->object->getCopyIds(true) as $survey_id => $questions) {
            // check permissions for "parent" survey
            $can_write = false;
            $ref_ids = ilObject::_getAllReferences($survey_id);
            foreach ($ref_ids as $ref_id) {
                if ($ilAccess->checkAccess("edit", "", $ref_id)) {
                    $can_write = true;
                    break;
                }
            }
 
            if ($can_write) {
                foreach ($questions as $qid) {
                    if (in_array($qid, $qids)) {
                        $id = $this->object->getId();
 
                        $this->object->setId($qid);
                        $this->object->setOriginalId($id);
                        $this->object->saveToDb();
 
                        $this->object->setId($id);
                        $this->object->setOriginalId(null);
 
                        // see: SurveyQuestion::syncWithOriginal()
                        // what about material?
                    }
                }
            }
        }
 
        $this->tpl->setOnScreenMessage('success', $lng->txt("survey_sync_success"), true);
        $this->redirectAfterSaving($this->request->getReturn());
    }

References $id, $lng, ilObject\_getAllReferences(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ validateEditForm()

SurveyQuestionGUI::validateEditForm ( ilPropertyFormGUI $a_form )

protected

Reimplemented in SurveyMultipleChoiceQuestionGUI.

Definition at line 548 of file class.SurveyQuestionGUI.php.

                                                                  : bool
    {
        return true;
    }

Field Documentation

◆ $access

ilAccessHandler SurveyQuestionGUI::$access

protected

Definition at line 38 of file class.SurveyQuestionGUI.php.

◆ $ctrl

ilCtrl SurveyQuestionGUI::$ctrl

protected

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

◆ $cumulated

array SurveyQuestionGUI::$cumulated = []

protected

Definition at line 45 of file class.SurveyQuestionGUI.php.

◆ $domain

ILIAS Survey InternalDomainService SurveyQuestionGUI::$domain

protected

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

◆ $edit_manager

EditManager SurveyQuestionGUI::$edit_manager

protected

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

◆ $gui

ILIAS Survey InternalGUIService SurveyQuestionGUI::$gui

protected

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

◆ $lng

ilLanguage SurveyQuestionGUI::$lng

protected

Definition at line 43 of file class.SurveyQuestionGUI.php.

Referenced by __construct().

◆ $log

ilLogger SurveyQuestionGUI::$log

protected

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

◆ $object

SurveyQuestion SurveyQuestionGUI::$object = null

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

◆ $parent_url

string SurveyQuestionGUI::$parent_url = ""

protected

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

◆ $purifier

ilHtmlPurifierInterface SurveyQuestionGUI::$purifier

protected

Definition at line 49 of file class.SurveyQuestionGUI.php.

◆ $rbacsystem

ilRbacSystem SurveyQuestionGUI::$rbacsystem

protected

Definition at line 36 of file class.SurveyQuestionGUI.php.

◆ $request

EditingGUIRequest SurveyQuestionGUI::$request

protected

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

◆ $tabs

ilTabsGUI SurveyQuestionGUI::$tabs

protected

Definition at line 41 of file class.SurveyQuestionGUI.php.

◆ $toolbar

ilToolbarGUI SurveyQuestionGUI::$toolbar

protected

Definition at line 40 of file class.SurveyQuestionGUI.php.

◆ $tpl

ilGlobalTemplateInterface SurveyQuestionGUI::$tpl

protected

Definition at line 42 of file class.SurveyQuestionGUI.php.

Referenced by __construct().

◆ $tree

ilTree SurveyQuestionGUI::$tree

protected

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

◆ $user

ilObjUser SurveyQuestionGUI::$user

protected

Definition at line 37 of file class.SurveyQuestionGUI.php.

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

components/ILIAS/SurveyQuestionPool/Questions/class.SurveyQuestionGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getClassNameForQType()

◆ _getGUIClassNameForId()

◆ _getQuestionGUI()

◆ addCommandButtons()

◆ addFieldsToEditForm()

◆ cancel()

◆ cancelSync()

◆ copySyncForm()

◆ editQuestion()

◆ executeCommand()

◆ getPrintView()

◆ getPrintViewQuestionTitle()

◆ getQuestionTitle()

◆ getQuestionType()

◆ getWorkingForm()

◆ importEditFormValues()

◆ initEditForm()

◆ initObject()

◆ originalSyncForm()

◆ outQuestionText()

◆ preview()

◆ redirectAfterSaving()

◆ renderStatisticsDetailsTable()

◆ save()

◆ saveForm()

◆ saveReturn()

◆ saveSync()

◆ setBackUrl()

◆ setQuestionTabs()

◆ setQuestionTabsForClass()

◆ sync()

◆ syncCopies()

◆ validateEditForm()

Field Documentation

◆ $access

◆ $ctrl

◆ $cumulated

◆ $domain

◆ $edit_manager

◆ $gui

◆ $lng

◆ $log

◆ $object

◆ $parent_url

◆ $purifier

◆ $rbacsystem

◆ $request

◆ $tabs

◆ $toolbar

◆ $tpl

◆ $tree

◆ $user