SurveyTextQuestionGUI Class Reference

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

Inheritance diagram for SurveyTextQuestionGUI:

Collaboration diagram for SurveyTextQuestionGUI:

Public Member Functions
	setQuestionTabs ()
	getParsedAnswers (?array $a_working_data=null, $a_only_user_anwers=false)
	getPrintView (int $question_title=1, bool $show_questiontext=true, ?int $survey_id=null, ?array $working_data=null)
	getWorkingForm (?array $working_data=null, int $question_title=1, bool $show_questiontext=true, string $error_message="", ?int $survey_id=null, bool $compress_view=false)
	Creates the question output form for the learner. More...
Public Member Functions inherited from SurveyQuestionGUI
	__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)

Protected Member Functions
	initObject ()
	addFieldsToEditForm (ilPropertyFormGUI $a_form)
	importEditFormValues (ilPropertyFormGUI $a_form)
Protected Member Functions inherited from SurveyQuestionGUI
	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)

Additional Inherited Members
Static Public Member Functions inherited from SurveyQuestionGUI
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 inherited from SurveyQuestionGUI
SurveyQuestion	$object = null
Protected Attributes inherited from SurveyQuestionGUI
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

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 Text survey question GUI representation The SurveyTextQuestionGUI class encapsulates the GUI representation for text 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

Definition at line 25 of file class.SurveyTextQuestionGUI.php.

Member Function Documentation

addFieldsToEditForm()

SurveyTextQuestionGUI::addFieldsToEditForm ( ilPropertyFormGUI  $a_form )

protected

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

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilFormPropertyGUI\setRequired().

                                                                     : void
    {
        // maximum number of characters
        $maxchars = new ilNumberInputGUI($this->lng->txt("maxchars"), "maxchars");
        $maxchars->setRequired(false);
        $maxchars->setSize(5);
        $maxchars->setDecimals(0);
        $a_form->addItem($maxchars);

        // values
        if ($this->object->getMaxChars() > 0) {
            $maxchars->setValue($this->object->getMaxChars());
        }
    }

Here is the call graph for this function:

getParsedAnswers()

SurveyTextQuestionGUI::getParsedAnswers	(	?array	$a_working_data = null,
			$a_only_user_anwers = false
	)

Definition at line 63 of file class.SurveyTextQuestionGUI.php.

References $res.

Referenced by getPrintView().

     : array {
        $res = array();
        if (is_array($a_working_data) && isset($a_working_data[0])) {
            $res[] = array("textanswer" => trim($a_working_data[0]["textanswer"] ?? ""));
        }

        return $res;
    }

Here is the caller graph for this function:

getPrintView()

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

Definition at line 75 of file class.SurveyTextQuestionGUI.php.

References ilUtil\getHtmlPath(), ilUtil\getImagePath(), getParsedAnswers(), SurveyQuestionGUI\getPrintViewQuestionTitle(), ILIAS\Repository\lng(), null, ILIAS\Repository\object(), and SurveyQuestionGUI\outQuestionText().

     : string {
        $user_answer = null;
        if ($working_data) {
            $user_answer = $this->getParsedAnswers($working_data);
            $user_answer = $user_answer[0]["textanswer"];
        }

        $template = new ilTemplate("tpl.il_svy_qpl_text_printview.html", true, true, "components/ILIAS/SurveyQuestionPool");
        if ($show_questiontext) {
            $this->outQuestionText($template);
        }
        if ($question_title) {
            $template->setVariable("QUESTION_TITLE", $this->getPrintViewQuestionTitle($question_title));
        }
        $template->setVariable("QUESTION_ID", $this->object->getId());
        $template->setVariable("TEXT_ANSWER", $this->lng->txt("answer"));
        if (is_array($working_data) && trim($user_answer)) {
            $template->setVariable("TEXT", nl2br($user_answer));
        } else {
            $template->setVariable("TEXTBOX_IMAGE", ilUtil::getHtmlPath(ilUtil::getImagePath("textbox.png")));
            $template->setVariable("TEXTBOX", $this->lng->txt("textbox"));
        }
        if ($this->object->getMaxChars()) {
            $template->setVariable("TEXT_MAXCHARS", sprintf($this->lng->txt("text_maximum_chars_allowed"), $this->object->getMaxChars()));
        }
        return $template->get();
    }

Here is the call graph for this function:

getWorkingForm()

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

Creates the question output form for the learner.

Definition at line 116 of file class.SurveyTextQuestionGUI.php.

References SurveyQuestionGUI\getQuestionTitle(), ILIAS\Repository\lng(), ILIAS\Repository\object(), SurveyQuestionGUI\outQuestionText(), and ilLegacyFormElementsUtil\prepareFormOutput().

     : string {
        $template = new ilTemplate("tpl.il_svy_out_text.html", true, true, "components/ILIAS/SurveyQuestionPool");

        $template->setCurrentBlock("textarea");
        if (is_array($working_data) && isset($working_data[0]["textanswer"])) {
            $template->setVariable("VALUE_ANSWER", ilLegacyFormElementsUtil::prepareFormOutput($working_data[0]["textanswer"]));
        }
        $template->setVariable("QUESTION_ID", $this->object->getId());

        $template->parseCurrentBlock();
        $template->setCurrentBlock("question_data_text");
        if ($show_questiontext) {
            $this->outQuestionText($template);
        }
        $template->setVariable("QUESTION_TITLE", $this->getQuestionTitle($question_title));
        $template->setVariable("TEXT_ANSWER", $this->lng->txt("answer"));
        $template->setVariable("LABEL_QUESTION_ID", $this->object->getId());
        if (strcmp($error_message, "") !== 0) {
            $template->setVariable("ERROR_MESSAGE", "<p class=\"warning\">$error_message</p>");
        }
        if ($this->object->getMaxChars()) {
            $template->setVariable("TEXT_MAXCHARS", sprintf($this->lng->txt("text_maximum_chars_allowed"), $this->object->getMaxChars()));
        }
        $template->parseCurrentBlock();
        return $template->get();
    }

Here is the call graph for this function:

importEditFormValues()

SurveyTextQuestionGUI::importEditFormValues ( ilPropertyFormGUI  $a_form )

protected

Definition at line 57 of file class.SurveyTextQuestionGUI.php.

References ilPropertyFormGUI\getInput().

                                                                      : void
    {
        $max = $a_form->getInput("maxchars");
        $this->object->setMaxChars((int) $max);
    }

Here is the call graph for this function:

initObject()

SurveyTextQuestionGUI::initObject ( )

protected

Definition at line 27 of file class.SurveyTextQuestionGUI.php.

                                   : void
    {
        $this->object = new SurveyTextQuestion();
    }

setQuestionTabs()

SurveyTextQuestionGUI::setQuestionTabs

(

)

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

References SurveyQuestionGUI\setQuestionTabsForClass().

                                     : void
    {
        $this->setQuestionTabsForClass("surveytextquestiongui");
    }

Here is the call graph for this function:

---

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

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