ilObjSurveyQuestionPoolGUI Class Reference

Class ilObjSurveyQuestionPoolGUI. More...

Inheritance diagram for ilObjSurveyQuestionPoolGUI:

Collaboration diagram for ilObjSurveyQuestionPoolGUI:

Public Member Functions
	__construct ()
	executeCommand ()
	propertiesObject (?ilPropertyFormGUI $a_form=null)
	Edit question pool properties. More...
	copyObject ()
	Copies checked questions in the questionpool to a clipboard. More...
	moveObject ()
	mark one or more question objects for moving More...
	exportQuestionObject ()
	export a question More...
	exportQuestionExportTabObject ()
	deleteQuestionsObject ()
	Creates a confirmation form to delete questions from the question pool. More...
	confirmDeleteQuestionsObject ()
	cancelDeleteQuestionsObject ()
	pasteObject ()
	paste questions from the clipboard into the question pool More...
	importQuestionsObject ()
	display the import form to import questions into the question pool More...
	getImportForm ()
	uploadQuestionsObject ()
	imports question(s) into the questionpool More...
	filterQuestionBrowserObject ()
	resetfilterQuestionBrowserObject ()
	questionsObject ()
	list questions of question pool More...
	updateObject ()
	exportObject ()
	list all export files More...
	downloadExportFileObject ()
	download export file More...
	confirmDeleteExportFileObject ()
	confirmation screen for export file deletion More...
	cancelDeleteExportFileObject ()
	deleteExportFileObject ()
	createQuestionObject ()
	create new question More...
	previewObject ()
	create preview of object More...
	infoScreenObject ()
	this one is called from the info button in the repository More...
	infoScreenForward ()
	show information screen More...
	saveObligatoryObject ()
	Save obligatory states. More...
Public Member Functions inherited from ilObjectGUI
	getRefId ()
	setAdminMode (string $mode)
	getAdminMode ()
	getObject ()
	executeCommand ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	editAvailabilityPeriodObject ()
	saveAvailabilityPeriodObject ()
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	addExternalEditFormCustom (ilPropertyFormGUI $form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...
	isVisible (int $ref_id, string $type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...
	setColumnSettings (ilColumnGUI $column_gui)
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto (string $a_target)
	Redirect script to call a survey question pool reference id. More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode (int $ref_id, string $cmd="")
static	_gotoSharedWorkspaceNode (int $wsp_id)

Data Fields
string	$defaultscript
Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""
const	ADMIN_MODE_SETTINGS = "settings"
const	ADMIN_MODE_REPOSITORY = "repository"
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3
const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]

Protected Member Functions
	afterSave (ilObject $new_object)
	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
	addLocatorItems ()
	getTabs ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	createActionDispatcherGUI ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	getCreationFormsHTML (StandardForm|ilPropertyFormGUI|array $form)
	getTitleForCreationFormPage ()
	getCreationFormTitle ()
	initCreateForm (string $new_type)
	didacticTemplatesToForm ()
	initDidacticTemplate (ilPropertyFormGUI $form)
	retrieveAdditionalDidacticTemplateOptions ()
	addAdoptContentLinkToToolbar ()
	addImportButtonToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	parseDidacticTemplateVar (string $var, string $type)
	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	routeImportCmdObject ()
	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...
	setFormAction (string $cmd, string $form_action)
	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...
	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...
	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...
	getTabs ()
	overwrite in derived GUI class of your object type More...
	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	getCreatableObjectTypes ()
	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)
	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Protected Attributes
ILIAS SurveyQuestionPool InternalGUIService	$gui
ILIAS SurveyQuestionPool Editing EditManager	$edit_manager
bool	$update
EditingGUIRequest	$edit_request
ilNavigationHistory	$nav_history
ilHelpGUI	$help
ilLogger	$log
RefineryFactory	$refinery
ILIASArchives	$archives
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
GlobalHttpState	$http
ServerRequestInterface	$request
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilSetting	$settings
ilToolbarGUI	$toolbar
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
ilObjectService	$object_service
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilTree	$tree
ilCtrl	$ctrl
ilErrorHandling	$error
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ILIAS	$ilias
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
Refinery	$refinery
ilFavouritesManager	$favourites
CustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
Filesystem	$temp_file_system
ilObject	$object = null
bool	$creation_mode = false
	$data
int	$id
bool	$call_by_reference = false
bool	$prepare_output
int	$ref_id
int	$obj_id
int	$maxcount
array	$form_action = []
array	$return_location = []
array	$target_frame = []
string	$tmp_import_dir
string	$sub_objects = ""
bool	$omit_locator = false
string	$type = ""
string	$admin_mode = self::ADMIN_MODE_NONE
int	$requested_ref_id = 0
int	$requested_crtptrefid = 0
int	$requested_crtcb = 0
string	$requested_new_type = ""
string	$link_params
string	$html = ""

Detailed Description

Class ilObjSurveyQuestionPoolGUI.

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 ilObjSurveyQuestionPoolGUI: SurveyMultipleChoiceQuestionGUI, SurveyMetricQuestionGUI ilObjSurveyQuestionPoolGUI: SurveySingleChoiceQuestionGUI, SurveyTextQuestionGUI ilObjSurveyQuestionPoolGUI: SurveyMatrixQuestionGUI ilObjSurveyQuestionPoolGUI: ilInfoScreenGUI ilObjSurveyQuestionPoolGUI: ilObjectMetaDataGUI, ilPermissionGUI, ilObjectCopyGUI ilObjSurveyQuestionPoolGUI: ilCommonActionDispatcherGUI ilObjSurveyQuestionPoolGUI: ILIAS ilObjSurveyQuestionPoolGUI: ilExportGUI

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

Constructor & Destructor Documentation

__construct()

ilObjSurveyQuestionPoolGUI::__construct

(

)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

    {
        global $DIC;

        $this->nav_history = $DIC["ilNavigationHistory"];
        $this->toolbar = $DIC->toolbar();
        $this->help = $DIC["ilHelp"];
        $this->refinery = $DIC->refinery();
        $this->archives = $DIC->archives();
        $this->edit_request = $DIC->surveyQuestionPool()
            ->internal()
            ->gui()
            ->editing()
            ->request();
        $this->edit_manager = $DIC->surveyQuestionPool()
                                  ->internal()
                                  ->domain()
                                  ->editing();

        $this->type = "spl";

        parent::__construct(
            "",
            $this->edit_request->getRefId(),
            true,
            false
        );
        $this->lng->loadLanguageModule("survey");
        $this->ctrl->saveParameter($this, array("ref_id"));
        $this->log = ilLoggerFactory::getLogger('svy');
        $this->gui = $DIC->surveyQuestionPool()->internal()->gui();
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjSurveyQuestionPoolGUI::_goto ( string  $a_target )

static

Redirect script to call a survey question pool reference id.

Definition at line 759 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilObjectGUI\$ctrl, $DIC, ilObjectGUI\$lng, ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilCtrl\redirectByClass(), ROOT_FOLDER_ID, ilCtrl\setParameterByClass(), and ilLanguage\txt().

                                                  : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();

        $ctrl = $DIC->ctrl();
        $ilAccess = $DIC->access();
        $lng = $DIC->language();

        if ($ilAccess->checkAccess("visible", "", $a_target) ||
            $ilAccess->checkAccess("read", "", $a_target)) {
            $ctrl->setParameterByClass("ilObjSurveyQuestionPoolGUI", "ref_id", $a_target);
            $ctrl->redirectByClass("ilObjSurveyQuestionPoolGUI", "infoScreen");
        } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage('failure', sprintf(
                $lng->txt("msg_no_perm_read_item"),
                ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))
            ), true);
            ilObjectGUI::_gotoRepositoryRoot();
        }
    }

Here is the call graph for this function:

addLocatorItems()

ilObjSurveyQuestionPoolGUI::addLocatorItems ( )

protected

Definition at line 663 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilObjectGUI\$locator, SurveyQuestion\_getQuestionType(), SurveyQuestion\_getTitle(), ILIAS\Repository\ctrl(), and ILIAS\Repository\object().

                                        : void
    {
        $ilLocator = $this->locator;
        switch ($this->ctrl->getCmd()) {
            case "create":
            case "importFile":
            case "cancel":
                break;
            default:
                $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->edit_request->getRefId());
                break;
        }
        if ($this->edit_request->getQuestionId() > 0) {
            $q_id = $this->edit_request->getQuestionId();
            $q_type = SurveyQuestion::_getQuestionType($q_id) . "GUI";
            $q_title = SurveyQuestion::_getTitle($q_id);
            if ($q_title) {
                // not on create
                $this->ctrl->setParameterByClass($q_type, "q_id", $q_id);
                $ilLocator->addItem(
                    $q_title,
                    $this->ctrl->getLinkTargetByClass($q_type, "editQuestion")
                );
            }
        }
    }

Here is the call graph for this function:

afterSave()

ilObjSurveyQuestionPoolGUI::afterSave ( ilObject  $new_object )

protected

Definition at line 460 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilObject\getRefId(), ILIAS\Repository\lng(), and ilUtil\redirect().

                                                      : void
    {
        // always send a message
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_added"), true);

        ilUtil::redirect("ilias.php?ref_id=" . $new_object->getRefId() .
            "&baseClass=ilObjSurveyQuestionPoolGUI");
    }

Here is the call graph for this function:

cancelDeleteExportFileObject()

ilObjSurveyQuestionPoolGUI::cancelDeleteExportFileObject

(

)

Definition at line 542 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilSession\clear(), and ILIAS\Repository\ctrl().

                                                  : void
    {
        ilSession::clear("ilExportFiles");
        $this->ctrl->redirect($this, "export");
    }

Here is the call graph for this function:

cancelDeleteQuestionsObject()

ilObjSurveyQuestionPoolGUI::cancelDeleteQuestionsObject

(

)

Definition at line 302 of file class.ilObjSurveyQuestionPoolGUI.php.

References ILIAS\Repository\ctrl().

                                                 : void
    {
        // delete questions after confirmation
        $this->ctrl->redirect($this, "questions");
    }

Here is the call graph for this function:

confirmDeleteExportFileObject()

ilObjSurveyQuestionPoolGUI::confirmDeleteExportFileObject

(

)

confirmation screen for export file deletion

Definition at line 519 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilObjectGUI\$data, ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), IL_CAL_UNIX, and ILIAS\Repository\lng().

                                                   : void
    {
        $files = $this->edit_request->getFiles();
        if (count($files) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "export");
        }

        $this->tpl->setOnScreenMessage('question', $this->lng->txt("info_delete_sure"));
        $table_gui = new ilSurveyQuestionPoolExportTableGUI($this, 'export', true);
        $export_dir = $this->object->getExportDirectory();
        $data = array();
        foreach ($files as $exp_file) {
            $file_arr = explode("__", $exp_file);
            $data[] = array('file' => $exp_file,
                            'date' => ilDatePresentation::formatDate(new ilDateTime($file_arr[0], IL_CAL_UNIX)),
                            'size' => filesize($export_dir . "/" . $exp_file)
            );
        }
        $table_gui->setData($data);
        $this->tpl->setVariable('ADM_CONTENT', $table_gui->getHTML());
    }

Here is the call graph for this function:

confirmDeleteQuestionsObject()

ilObjSurveyQuestionPoolGUI::confirmDeleteQuestionsObject

(

)

Definition at line 291 of file class.ilObjSurveyQuestionPoolGUI.php.

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

                                                  : void
    {
        // delete questions after confirmation
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("qpl_questions_deleted"), true);
        $qids = $this->edit_request->getQuestionIds();
        foreach ($qids as $q_id) {
            $this->object->removeQuestion($q_id);
        }
        $this->ctrl->redirect($this, "questions");
    }

Here is the call graph for this function:

copyObject()

ilObjSurveyQuestionPoolGUI::copyObject

(

)

Copies checked questions in the questionpool to a clipboard.

Definition at line 198 of file class.ilObjSurveyQuestionPoolGUI.php.

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

                                : void
    {
        $qids = $this->edit_request->getQuestionIds();
        if (count($qids) > 0) {
            foreach ($qids as $key => $value) {
                $this->object->copyToClipboard($value);
            }
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("spl_copy_insert_clipboard"), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("spl_copy_select_none"), true);
        }
        $this->ctrl->redirect($this, "questions");
    }

Here is the call graph for this function:

createQuestionObject()

ilObjSurveyQuestionPoolGUI::createQuestionObject

(

)

create new question

Definition at line 570 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilObjectGUI\$user, SurveyQuestionGUI\_getQuestionGUI(), ILIAS\Repository\ctrl(), ILIAS\Repository\object(), and ilObjUser\writePref().

                                          : void
    {
        $ilUser = $this->user;

        $ilUser->writePref(
            "svy_lastquestiontype",
            $this->edit_request->getSelectedQuestionTypes()
        );

        $q_gui = SurveyQuestionGUI::_getQuestionGUI(
            $this->edit_request->getSelectedQuestionTypes()
        );
        $q_gui->object->setObjId($this->object->getId());
        $q_gui->object->createNewQuestion();

        $this->ctrl->setParameterByClass(get_class($q_gui), "q_id", $q_gui->object->getId());
        $this->ctrl->setParameterByClass(
            get_class($q_gui),
            "sel_question_types",
            $this->edit_request->getSelectedQuestionTypes()
        );
        $this->ctrl->redirectByClass(get_class($q_gui), "editQuestion");
    }

Here is the call graph for this function:

deleteExportFileObject()

ilObjSurveyQuestionPoolGUI::deleteExportFileObject

(

)

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

References ILIAS\Repository\ctrl(), and ilFileUtils\delDir().

                                            : void
    {
        $export_dir = $this->object->getExportDirectory();
        $files = $this->edit_request->getFiles();
        foreach ($files as $file) {
            $file = basename($file);

            $exp_file = $export_dir . "/" . $file;
            $exp_dir = $export_dir . "/" . substr($file, 0, -4);
            if (is_file($exp_file)) {
                unlink($exp_file);
            }
            if (is_dir($exp_dir)) {
                ilFileUtils::delDir($exp_dir);
            }
        }
        $this->ctrl->redirect($this, "export");
    }

Here is the call graph for this function:

deleteQuestionsObject()

ilObjSurveyQuestionPoolGUI::deleteQuestionsObject

(

)

Creates a confirmation form to delete questions from the question pool.

Definition at line 258 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilObjectGUI\$data, $txt, SurveyQuestion\_getQuestionTypeName(), ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and questionsObject().

                                           : void
    {
        $this->checkPermission('write');

        // create an array of all checked checkboxes
        $checked_questions = $this->edit_request->getQuestionIds();
        if (count($checked_questions) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("qpl_delete_select_none"));
            $this->questionsObject();
            return;
        }

        $cgui = new ilConfirmationGUI();
        $cgui->setHeaderText($this->lng->txt("qpl_confirm_delete_questions"));

        $cgui->setFormAction($this->ctrl->getFormAction($this));
        $cgui->setCancel($this->lng->txt("cancel"), "cancelDeleteQuestions");
        $cgui->setConfirm($this->lng->txt("confirm"), "confirmDeleteQuestions");

        $infos = $this->object->getQuestionInfos($checked_questions);
        foreach ($infos as $data) {
            $txt = $data["title"] . " (" .
                SurveyQuestion::_getQuestionTypeName($data["type_tag"]) . ")";
            if ($data["description"]) {
                $txt .= "<div class=\"small\">" . $data["description"] . "</div>";
            }

            $cgui->addItem("q_id[]", $data["id"], $txt);
        }

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

Here is the call graph for this function:

downloadExportFileObject()

ilObjSurveyQuestionPoolGUI::downloadExportFileObject

(

)

download export file

Definition at line 495 of file class.ilObjSurveyQuestionPoolGUI.php.

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

                                              : void
    {
        $files = $this->edit_request->getFiles();
        if (count($files) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "export");
        }

        if (count($files) > 1) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("select_max_one_item"), true);
            $this->ctrl->redirect($this, "export");
        }


        $export_dir = $this->object->getExportDirectory();

        $file = basename($files[0]);

        ilFileDelivery::deliverFileLegacy($export_dir . "/" . $file, $file);
    }

Here is the call graph for this function:

executeCommand()

ilObjSurveyQuestionPoolGUI::executeCommand

(

)

Definition at line 84 of file class.ilObjSurveyQuestionPoolGUI.php.

References $nav_history, SurveyQuestionGUI\_getQuestionGUI(), ilObjectGUI\checkPermission(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilObjectGUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilUtil\getStyleSheetLocation(), infoScreenForward(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilObjectGUI\prepareOutput().

                                    : void
    {
        $ilNavigationHistory = $this->nav_history;
        if (!$this->checkPermissionBool("visible") &&
            !$this->checkPermissionBool("read")) {
            $this->checkPermission("read");
        }

        // add entry to navigation history
        if (!$this->getCreationMode() &&
            $this->checkPermissionBool("read")) {
            $ilNavigationHistory->addItem(
                $this->ref_id,
                "ilias.php?baseClass=ilObjSurveyQuestionPoolGUI&cmd=questions&ref_id=" . $this->ref_id,
                "spl"
            );
        }

        $this->tpl->addCss(ilUtil::getStyleSheetLocation("output", "survey.css"), "screen");
        $this->prepareOutput();

        $cmd = $this->ctrl->getCmd("questions");
        $next_class = $this->ctrl->getNextClass($this);
        if ($cmd !== "cancel") {
            $this->ctrl->setReturn($this, "questions");
        }
        $q_type = "";
        if ($this->edit_request->getQuestionId() < 1) {
            $q_type = $this->edit_request->getSelectedQuestionTypes();
        }

        $this->log->debug("- cmd=" . $cmd . " next_class=" . $next_class);
        switch ($next_class) {
            case 'ilobjectmetadatagui':
                $this->tabs_gui->activateTab("meta_data");
                $this->checkPermission('write');
                $md_gui = new ilObjectMetaDataGUI($this->object);
                $this->ctrl->forwardCommand($md_gui);
                break;

            case 'ilpermissiongui':
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case 'ilobjectcopygui':
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('spl');
                $this->ctrl->forwardCommand($cp);
                break;

            case 'ilinfoscreengui':
                $this->tabs_gui->activateTab("info_short");
                $this->infoScreenForward();
                break;

            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;

            case strtolower(\ILIAS\SurveyQuestionPool\Settings\SettingsGUI::class):
                $this->checkPermission("write");
                $this->tabs_gui->activateTab("settings");
                $gui = $this->gui->settings()->settingsGUI(
                    $this->object->getId(),
                    $this->object->getRefId()
                );
                $this->ctrl->forwardCommand($gui);
                break;

            case strtolower(ilExportGUI::class):
                $export = new ilExportGUI($this, $this->object);
                $this->ctrl->forwardCommand($export);
                break;

            case "":
                $cmd .= "Object";
                $this->$cmd();
                break;

            default:
                $q_gui = SurveyQuestionGUI::_getQuestionGUI(
                    $q_type,
                    $this->edit_request->getQuestionId()
                );
                $this->log->debug("- This is the switch/case default, going to question id =" . $this->edit_request->getQuestionId());
                $q_gui->setQuestionTabs();
                $this->ctrl->forwardCommand($q_gui);

                // not on create
                if ($q_gui->object->isComplete()) {
                    $this->tpl->setTitle($this->lng->txt("question") . ": " . $q_gui->object->getTitle());
                }
                break;
        }
        if (strtolower($this->edit_request->getBaseClass()) !== "iladministrationgui" &&
            $this->getCreationMode() !== true) {
            $this->tpl->printToStdout();
        }
    }

Here is the call graph for this function:

exportObject()

ilObjSurveyQuestionPoolGUI::exportObject

(

)

list all export files

Definition at line 472 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilObjectGUI\$object, ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), and null.

                                  : void
    {
        $export = new ilExportGUI($this, $this->object);
        $export->listExportFiles();
    }

Here is the call graph for this function:

exportQuestionExportTabObject()

ilObjSurveyQuestionPoolGUI::exportQuestionExportTabObject

(

)

Definition at line 243 of file class.ilObjSurveyQuestionPoolGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                                                   : void
    {
        $qids = $this->http->wrapper()->query()->retrieve(
            "qid",
            $this->refinery->custom()->transformation(function (string $value) {
                $value = urldecode($value);
                return explode(',', $value);
            })
        );
        $this->createExportFileObject($qids);
    }

Here is the call graph for this function:

exportQuestionObject()

ilObjSurveyQuestionPoolGUI::exportQuestionObject

(

)

export a question

Definition at line 232 of file class.ilObjSurveyQuestionPoolGUI.php.

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

                                          : void
    {
        $qids = $this->edit_request->getQuestionIds();
        if (count($qids) > 0) {
            $this->createExportFileObject($qids);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("qpl_export_select_none"));
            $this->questionsObject();
        }
    }

Here is the call graph for this function:

filterQuestionBrowserObject()

ilObjSurveyQuestionPoolGUI::filterQuestionBrowserObject

(

)

Definition at line 390 of file class.ilObjSurveyQuestionPoolGUI.php.

References ILIAS\Repository\ctrl().

                                                 : void
    {
        $table_gui = new ilSurveyQuestionsTableGUI($this, 'questions');
        $table_gui->writeFilterToSession();
        $this->ctrl->redirect($this, 'questions');
    }

Here is the call graph for this function:

getImportForm()

ilObjSurveyQuestionPoolGUI::getImportForm

(

)

Definition at line 332 of file class.ilObjSurveyQuestionPoolGUI.php.

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

Referenced by importQuestionsObject(), and uploadQuestionsObject().

                                   : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "uploadQuestions"));
        $form->setTitle($this->lng->txt("import_question"));

        $fi = new ilFileInputGUI($this->lng->txt("select_file"), "qtidoc");
        $fi->setSuffixes(array("xml", "zip"));
        $fi->setRequired(true);
        $form->addItem($fi);

        $form->addCommandButton("uploadQuestions", $this->lng->txt("import"));
        $form->addCommandButton("questions", $this->lng->txt("cancel"));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTabs()

ilObjSurveyQuestionPoolGUI::getTabs ( )

protected

Definition at line 690 of file class.ilObjSurveyQuestionPoolGUI.php.

References $help, ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilHelpGUI\setScreenIdComponent().

                                : void
    {
        $ilHelp = $this->help;
        $ilHelp->setScreenIdComponent("spl");

        if ($this->checkPermissionBool("read")) {
            $this->tabs_gui->addTab(
                "survey_questions",
                $this->lng->txt("survey_questions"),
                $this->ctrl->getLinkTarget($this, 'questions')
            );

            $this->tabs_gui->addTab(
                "info_short",
                $this->lng->txt("info_short"),
                $this->ctrl->getLinkTarget($this, "infoScreen")
            );
        }

        if ($this->checkPermissionBool('write')) {
            $this->tabs_gui->addTab(
                "settings",
                $this->lng->txt("settings"),
                $this->ctrl->getLinkTargetByClass(\ILIAS\SurveyQuestionPool\Settings\SettingsGUI::class)
            );

            // meta data
            $mdgui = new ilObjectMetaDataGUI($this->object);
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $this->tabs_gui->addTab(
                    "meta_data",
                    $this->lng->txt("meta_data"),
                    $mdtab
                );
            }

            // export
            $this->tabs_gui->addTab(
                "export",
                $this->lng->txt("export"),
                $this->ctrl->getLinkTarget($this, 'export')
            );
        }

        if ($this->checkPermissionBool("edit_permission")) {
            $this->tabs_gui->addTab(
                "perm_settings",
                $this->lng->txt("perm_settings"),
                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm")
            );
        }
    }

Here is the call graph for this function:

importFile()

ilObjSurveyQuestionPoolGUI::importFile ( string  $file_to_import, string  $path_to_uploaded_file_in_temp_dir  )

protected

Definition at line 634 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilObjectGUI\$tpl, ilObjectGUI\deleteUploadedImportFile(), ILIAS\Repository\lng(), ilObjectGUI\putObjectInTree(), and ilUtil\redirect().

                                                                                                    : void
    {
        $unzip = $this->archives->unzip(Streams::ofResource(fopen($file_to_import, 'r')));
        # If export contains a manifest xml use standard import
        if (in_array(basename($file_to_import, ".zip") . DIRECTORY_SEPARATOR . "manifest.xml", iterator_to_array($unzip->getFiles()))) {
            parent::importFile($file_to_import, $path_to_uploaded_file_in_temp_dir);
            return;
        }
        $tpl = $this->tpl;

        $newObj = new ilObjSurveyQuestionPool();
        $newObj->setTitle("dummy");
        $newObj->create();
        $this->putObjectInTree($newObj);

        // import qti data
        $newObj->importObject($file_to_import);

        if ($path_to_uploaded_file_in_temp_dir !== ''
            && $this->temp_file_system->hasDir($path_to_uploaded_file_in_temp_dir)) {
            $this->temp_file_system->deleteDir($path_to_uploaded_file_in_temp_dir);
        }

        $this->deleteUploadedImportFile($path_to_uploaded_file_in_temp_dir);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_imported"), true);
        ilUtil::redirect("ilias.php?ref_id=" . $newObj->getRefId() .
            "&baseClass=ilObjSurveyQuestionPoolGUI");
    }

Here is the call graph for this function:

importQuestionsObject()

ilObjSurveyQuestionPoolGUI::importQuestionsObject

(

)

display the import form to import questions into the question pool

Definition at line 325 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilObjectGUI\$tpl, getImportForm(), and ILIAS\UICore\GlobalTemplate\setContent().

                                           : void
    {
        $tpl = $this->tpl;
        $form = $this->getImportForm();
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

infoScreenForward()

ilObjSurveyQuestionPoolGUI::infoScreenForward

(

)

show information screen

Definition at line 619 of file class.ilObjSurveyQuestionPoolGUI.php.

References $info, ilObjectGUI\checkPermission(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), and ILIAS\Repository\object().

Referenced by executeCommand().

                                       : void
    {
        if (!$this->checkPermissionBool("read")) {
            $this->checkPermission("visible");
        }

        $info = new ilInfoScreenGUI($this);
        $info->enablePrivateNotes();

        // standard meta data
        $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());

        $this->ctrl->forwardCommand($info);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

infoScreenObject()

ilObjSurveyQuestionPoolGUI::infoScreenObject

(

)

this one is called from the info button in the repository

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

References ILIAS\Repository\ctrl().

                                      : void
    {
        $this->ctrl->redirectByClass(ilInfoScreenGUI::class, "showSummary");
    }

Here is the call graph for this function:

moveObject()

ilObjSurveyQuestionPoolGUI::moveObject

(

)

mark one or more question objects for moving

Definition at line 215 of file class.ilObjSurveyQuestionPoolGUI.php.

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

                                : void
    {
        $qids = $this->edit_request->getQuestionIds();
        if (count($qids) > 0) {
            foreach ($qids as $key => $value) {
                $this->object->moveToClipboard($value);
            }
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("spl_move_insert_clipboard"), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("spl_move_select_none"), true);
        }
        $this->ctrl->redirect($this, "questions");
    }

Here is the call graph for this function:

pasteObject()

ilObjSurveyQuestionPoolGUI::pasteObject

(

)

paste questions from the clipboard into the question pool

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

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

                                 : void
    {
        $clip_questions = $this->edit_manager->getQuestionsFromClipboard();
        if (count($clip_questions) > 0) {
            $this->object->pasteFromClipboard();
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("spl_paste_no_objects"), true);
        }
        $this->ctrl->redirect($this, "questions");
    }

Here is the call graph for this function:

previewObject()

ilObjSurveyQuestionPoolGUI::previewObject

(

)

create preview of object

Definition at line 597 of file class.ilObjSurveyQuestionPoolGUI.php.

References SurveyQuestionGUI\_getQuestionGUI(), and ILIAS\Repository\ctrl().

                                   : void
    {
        $q_gui = SurveyQuestionGUI::_getQuestionGUI(
            "",
            $this->edit_request->getPreview()
        );
        $this->ctrl->setParameterByClass(get_class($q_gui), "sel_question_types", $q_gui->getQuestionType());
        $this->ctrl->setParameterByClass(get_class($q_gui), "q_id", $this->edit_request->getPreview());
        $this->ctrl->redirectByClass(get_class($q_gui), "preview");
    }

Here is the call graph for this function:

propertiesObject()

ilObjSurveyQuestionPoolGUI::propertiesObject

(

?ilPropertyFormGUI

$a_form = null

)

Edit question pool properties.

Definition at line 189 of file class.ilObjSurveyQuestionPoolGUI.php.

References ILIAS\Repository\ctrl().

                                                                       : void
    {
        $this->ctrl->redirectByClass(\ILIAS\SurveyQuestionPool\Settings\SettingsGUI::class);
    }

Here is the call graph for this function:

questionsObject()

ilObjSurveyQuestionPoolGUI::questionsObject

(

)

list questions of question pool

Definition at line 407 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilObjectGUI\$data, ilObjectGUI\$toolbar, ilObjectGUI\$user, ilObjSurveyQuestionPool\_getQuestiontypes(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by deleteQuestionsObject(), and exportQuestionObject().

                                     : void
    {
        $this->tabs_gui->activateTab("survey_questions");
        $ilUser = $this->user;
        $ilToolbar = $this->toolbar;

        $this->object->purgeQuestions();

        if ($this->checkPermissionBool('write')) {
            $qtypes = new ilSelectInputGUI("", "sel_question_types");
            $qtypes->setValue($ilUser->getPref("svy_lastquestiontype"));
            $ilToolbar->addInputItem($qtypes);

            $options = array();
            foreach (ilObjSurveyQuestionPool::_getQuestiontypes() as $translation => $data) {
                $options[$data["type_tag"]] = $translation;
            }
            $qtypes->setOptions($options);

            $ilToolbar->setFormAction($this->ctrl->getFormAction($this));

            $this->gui->button(
                $this->lng->txt("svy_create_question"),
                "createQuestion"
            )->submit()->toToolbar();

            $ilToolbar->addSeparator();
            /*
            $this->gui->button(
                $this->lng->txt("import"),
                "importQuestions"
            )->submit()->toToolbar();
            */
        }

        $table_gui = new ilSurveyQuestionsTableGUI($this, 'questions', $this->checkPermissionBool('write'));
        $table_gui->setEditable($this->checkPermissionBool('write'));
        $arrFilter = array();
        foreach ($table_gui->getFilterItems() as $item) {
            if ($item->getValue() !== false) {
                $arrFilter[$item->getPostVar()] = $item->getValue();
            }
        }
        $table_gui->setData($this->object->getQuestionsData($arrFilter));
        $this->tpl->setContent($table_gui->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetfilterQuestionBrowserObject()

ilObjSurveyQuestionPoolGUI::resetfilterQuestionBrowserObject

(

)

Definition at line 397 of file class.ilObjSurveyQuestionPoolGUI.php.

References ILIAS\Repository\ctrl().

                                                      : void
    {
        $table_gui = new ilSurveyQuestionsTableGUI($this, 'questions');
        $table_gui->resetFilter();
        $this->ctrl->redirect($this, 'questions');
    }

Here is the call graph for this function:

saveObligatoryObject()

ilObjSurveyQuestionPoolGUI::saveObligatoryObject

(

)

Save obligatory states.

Definition at line 747 of file class.ilObjSurveyQuestionPoolGUI.php.

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

                                          : void
    {
        $obligatory = $this->edit_request->getObligatory();
        $this->object->setObligatoryStates($obligatory);

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
        $this->ctrl->redirect($this, "questions");
    }

Here is the call graph for this function:

updateObject()

ilObjSurveyQuestionPoolGUI::updateObject

(

)

Definition at line 454 of file class.ilObjSurveyQuestionPoolGUI.php.

References ILIAS\Repository\lng().

                                  : void
    {
        $this->update = $this->object->update();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
    }

Here is the call graph for this function:

uploadQuestionsObject()

ilObjSurveyQuestionPoolGUI::uploadQuestionsObject

(

)

imports question(s) into the questionpool

Definition at line 351 of file class.ilObjSurveyQuestionPoolGUI.php.

References ilObjectGUI\$error, ilObjectGUI\$tpl, ILIAS\Repository\ctrl(), getImportForm(), ilFileUtils\moveUploadedFile(), and ILIAS\UICore\GlobalTemplate\setContent().

                                           : void
    {
        $form = $this->getImportForm();
        if ($form->checkInput()) {
            // check if file was uploaded
            $source = $_FILES["qtidoc"]["tmp_name"];
            $error = 0;
            if (($source === 'none') || (!$source) || $_FILES["qtidoc"]["error"] > UPLOAD_ERR_OK) {
                $error = 1;
            }
            // check correct file type
            if (!$error && strpos("xml", $_FILES["qtidoc"]["type"]) !== false) {
                $error = 1;
            }
            if (!$error) {
                // import file into questionpool
                // create import directory
                $this->object->createImportDirectory();

                // copy uploaded file to import directory
                $full_path = $this->object->getImportDirectory() . "/" . $_FILES["qtidoc"]["name"];

                ilFileUtils::moveUploadedFile(
                    $_FILES["qtidoc"]["tmp_name"],
                    $_FILES["qtidoc"]["name"],
                    $full_path
                );
                $source = $full_path;
                $this->object->importObject($source, true);
                unlink($source);
            }
            $this->ctrl->redirect($this, "questions");
        } else {
            $form->setValuesByPost();
            $tpl = $this->tpl;
            $tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

Field Documentation

$archives

ILIASArchives ilObjSurveyQuestionPoolGUI::$archives

protected

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

$defaultscript

string ilObjSurveyQuestionPoolGUI::$defaultscript

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

$edit_manager

ILIAS SurveyQuestionPool Editing EditManager ilObjSurveyQuestionPoolGUI::$edit_manager

protected

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

$edit_request

EditingGUIRequest ilObjSurveyQuestionPoolGUI::$edit_request

protected

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

$gui

ILIAS SurveyQuestionPool InternalGUIService ilObjSurveyQuestionPoolGUI::$gui

protected

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

$help

ilHelpGUI ilObjSurveyQuestionPoolGUI::$help

protected

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

Referenced by getTabs().

$log

ilLogger ilObjSurveyQuestionPoolGUI::$log

protected

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

$nav_history

ilNavigationHistory ilObjSurveyQuestionPoolGUI::$nav_history

protected

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

Referenced by executeCommand().

$refinery

RefineryFactory ilObjSurveyQuestionPoolGUI::$refinery

protected

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

$update

bool ilObjSurveyQuestionPoolGUI::$update

protected

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

---

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

• components/ILIAS/SurveyQuestionPool/classes/class.ilObjSurveyQuestionPoolGUI.php