SurveyQuestionGUI Class Reference

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

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

Constructor & Destructor Documentation

__construct()

SurveyQuestionGUI::__construct

(

$a_id = -1

)

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

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

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

Here is the call graph for this function:

Member Function Documentation

_getClassNameForQType()

static SurveyQuestionGUI::_getClassNameForQType ( string  $q_type )

static

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

Referenced by _getGUIClassNameForId().

                                                                : string
    {
        return $q_type;
    }

Here is the caller graph for this function:

_getGUIClassNameForId()

static SurveyQuestionGUI::_getGUIClassNameForId ( int  $a_q_id )

static

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

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

Referenced by ilSurveyQuestionsTableGUI\fillRow().

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

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

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

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

     : 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;
    }

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

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

Referenced by initEditForm().

                                                                   : 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"));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addFieldsToEditForm()

SurveyQuestionGUI::addFieldsToEditForm ( ilPropertyFormGUI  $a_form )

abstractprotected

Referenced by initEditForm(), and validateEditForm().

Here is the caller graph for this function:

cancel()

SurveyQuestionGUI::cancel ( )

protected

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

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

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

Here is the call graph for this function:

cancelSync()

SurveyQuestionGUI::cancelSync ( )

protected

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

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

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

Here is the call graph for this function:

copySyncForm()

SurveyQuestionGUI::copySyncForm ( )

protected

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

References $tabs, and ilTabsGUI\activateTab().

Referenced by syncCopies().

                                     : void
    {
        $ilTabs = $this->tabs;

        $ilTabs->activateTab("edit_properties");

        $tbl = new ilSurveySyncTableGUI($this, "copySyncForm", $this->object);

        $this->tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editQuestion()

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

protected

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

References $tabs, ilTabsGUI\activateTab(), and initEditForm().

Referenced by save(), and saveForm().

                                                                      : void
    {
        $ilTabs = $this->tabs;

        $ilTabs->activateTab("edit_properties");

        if (!$a_form) {
            $a_form = $this->initEditForm();
        }
        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

SurveyQuestionGUI::executeCommand

(

)

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

References ILIAS\Repository\ctrl().

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

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

Referenced by validateEditForm().

Here is the caller graph for this function:

getPrintViewQuestionTitle()

SurveyQuestionGUI::getPrintViewQuestionTitle ( int  $question_title = 1 )

protected

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

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

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

     : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getQuestionTitle()

SurveyQuestionGUI::getQuestionTitle ( int  $question_title_mode = 1 )

protected

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

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

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

     : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getQuestionType()

SurveyQuestionGUI::getQuestionType

(

)

Returns the question type string.

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

Referenced by setQuestionTabsForClass().

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

Here is the caller graph for this function:

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

Referenced by preview().

Here is the caller graph for this function:

importEditFormValues()

SurveyQuestionGUI::importEditFormValues ( ilPropertyFormGUI  $a_form )

abstractprotected

Referenced by saveForm(), and validateEditForm().

Here is the caller graph for this function:

initEditForm()

SurveyQuestionGUI::initEditForm ( )

protected

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

References ilObjAdvancedEditing\_getRichTextEditor(), addCommandButtons(), addFieldsToEditForm(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilFormPropertyGUI\setRequired().

Referenced by editQuestion(), and saveForm().

                                     : 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 (ilObjAdvancedEditing::_getRichTextEditor() === "tinymce") {
            $question->setUseRte(true);
            $question->setRteTagSet("mini");
        }
        $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initObject()

SurveyQuestionGUI::initObject ( )

abstractprotected

Referenced by __construct().

Here is the caller graph for this function:

originalSyncForm()

SurveyQuestionGUI::originalSyncForm ( )

protected

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

References $tabs, ilTabsGUI\activateTab(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                         : 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());
    }

Here is the call graph for this function:

outQuestionText()

SurveyQuestionGUI::outQuestionText ( ilTemplate  $template )

protected

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

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

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

                                                            : 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", ' *');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

preview()

SurveyQuestionGUI::preview

(

)

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

References Vendor\Package\$f, $r, $tabs, ilTabsGUI\activateTab(), ILIAS\UICore\GlobalTemplate\get(), getWorkingForm(), ILIAS\Repository\lng(), null, ILIAS\Repository\object(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), and ILIAS\UICore\GlobalTemplate\setVariable().

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

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

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

Referenced by cancelSync(), save(), sync(), and syncCopies().

     : 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("&", "&", $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");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderStatisticsDetailsTable()

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

protected

Definition at line 631 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 345 of file class.SurveyQuestionGUI.php.

References $user, SurveyQuestion\_isComplete(), SurveyQuestion\_isWriteable(), SurveyQuestion\_questionExists(), ILIAS\Repository\ctrl(), editQuestion(), ILIAS\Repository\lng(), ILIAS\Repository\object(), redirectAfterSaving(), and saveForm().

Referenced by saveReturn(), and saveSync().

     : 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');
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
            $this->redirectAfterSaving($a_return);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveForm()

SurveyQuestionGUI::saveForm ( )

protected

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

References editQuestion(), importEditFormValues(), initEditForm(), and validateEditForm().

Referenced by save().

                                 : 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($form->getInput("question"));
            $this->object->setObligatory($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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveReturn()

SurveyQuestionGUI::saveReturn ( )

protected

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

References save().

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

Here is the call graph for this function:

saveSync()

SurveyQuestionGUI::saveSync ( )

protected

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

References save().

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

Here is the call graph for this function:

setBackUrl()

SurveyQuestionGUI::setBackUrl

(

string

$a_url

)

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

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

setQuestionTabs()

SurveyQuestionGUI::setQuestionTabs ( )

abstract

Referenced by __construct().

Here is the caller graph for this function:

setQuestionTabsForClass()

SurveyQuestionGUI::setQuestionTabsForClass

(

string

$guiclass

)

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

References $rbacsystem, $tabs, ilRbacSystem\checkAccess(), ILIAS\Repository\ctrl(), getQuestionType(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

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

                                                             : 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") . " "" . $this->object->getTitle() . "&quot";
        } else {
            $title = $this->lng->txt("create_new") . " " . $this->lng->txt($this->getQuestionType());
        }

        $this->tpl->setVariable("HEADER", $title);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sync()

SurveyQuestionGUI::sync ( )

protected

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

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

                             : 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());
    }

Here is the call graph for this function:

syncCopies()

SurveyQuestionGUI::syncCopies ( )

protected

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

References $access, $id, $lng, $ref_id, ilObject\_getAllReferences(), copySyncForm(), null, ILIAS\Repository\object(), redirectAfterSaving(), and ilLanguage\txt().

                                   : 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());
    }

Here is the call graph for this function:

validateEditForm()

SurveyQuestionGUI::validateEditForm ( ilPropertyFormGUI  $a_form )

protected

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

References addFieldsToEditForm(), getPrintView(), importEditFormValues(), and null.

Referenced by saveForm().

                                                                  : bool
    {
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler SurveyQuestionGUI::$access

protected

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

Referenced by syncCopies().

$ctrl

ilCtrl SurveyQuestionGUI::$ctrl

protected

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

$cumulated

array SurveyQuestionGUI::$cumulated = []

protected

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

$edit_manager

EditManager SurveyQuestionGUI::$edit_manager

protected

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

$gui

ILIAS Survey InternalGUIService SurveyQuestionGUI::$gui

protected

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

$lng

ilLanguage SurveyQuestionGUI::$lng

protected

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

Referenced by __construct(), and syncCopies().

$log

ilLogger SurveyQuestionGUI::$log

protected

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

$object

SurveyQuestion SurveyQuestionGUI::$object = null

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

$parent_url

string SurveyQuestionGUI::$parent_url = ""

protected

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

$rbacsystem

ilRbacSystem SurveyQuestionGUI::$rbacsystem

protected

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

Referenced by setQuestionTabsForClass().

$request

EditingGUIRequest SurveyQuestionGUI::$request

protected

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

$tabs

ilTabsGUI SurveyQuestionGUI::$tabs

protected

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

Referenced by copySyncForm(), editQuestion(), SurveyMatrixQuestionGUI\layout(), originalSyncForm(), preview(), and setQuestionTabsForClass().

$toolbar

ilToolbarGUI SurveyQuestionGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface SurveyQuestionGUI::$tpl

protected

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

Referenced by __construct().

$tree

ilTree SurveyQuestionGUI::$tree

protected

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

$user

ilObjUser SurveyQuestionGUI::$user

protected

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

Referenced by save().

---

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

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