ilSurveyPageGUI Class Reference

Survey per page view. More...

Collaboration diagram for ilSurveyPageGUI:

Public Member Functions
	__construct (ilObjSurvey $a_survey, ilSurveyEditorGUI $a_survey_editor_gui)
	Constructor. More...
	executeCommand ()
	Routing. More...
	determineCurrentPage ()
	determine current page More...
	insertNewQuestion ($a_new_id)
	Add new question to survey. More...
	insertQuestionBlock ($a_block_id)
	Copy and insert questions from block. More...
	getPageNodes (array $a_questions, $a_has_previous_page=false, $a_has_next_page=false, $a_readonly=false)
	Get Form HTML. More...
	renderPageNode (ilTemplate $a_tpl, $a_type, $a_id, $a_content=null, array $a_menu=null, $a_spacer=false, $a_subtitle=false, $a_status=false, $a_heading=false)
	Render single of dnd page view. More...
	getAutoBlockTitle ()
	Get name for newly created blocks. More...
	addPoolQuestion ($pos, $node)

Protected Member Functions
	appendNewQuestionToSurvey ($a_new_id, $a_duplicate=true, $a_force_duplicate=false)
	Add new question to survey (database part) More...
	addQuestion ($a_type, $a_use_pool, $a_pos, $a_special_position)
	Call add question to survey form. More...
	cutQuestion ($a_id)
	Add question to be cut to clipboard. More...
	copyQuestion ($a_id)
	Add question to be copied to clipboard. More...
	multiCut ($a_id)
	Add questions to be cut to clipboard. More...
	multiCopy ($a_id)
	Add questions to be copied to clipboard. More...
	clearClipboard ()
	Empty clipboard. More...
	paste ($a_id)
	Paste from clipboard. More...
	dnd ()
	Move questions in page. More...
	deleteBlock ()
	Confirm removing question block. More...
	deleteQuestion ($a_id)
	Confirm removing question(s) from survey. More...
	confirmRemoveQuestions ()
	Remove question(s) from survey. More...
	editBlock ($a_id)
	Edit question block. More...
	addHeading ($a_id)
	Add heading to question. More...
	editHeading ($a_id)
	Edit question heading. More...
	deleteHeading ($a_id)
	Delete question heading. More...
	callEditor ($a_cmd, $a_param, $a_value)
	splitPage ($a_id)
	Split current page in 2 pages. More...
	moveNext ($a_id)
	Move question to next page. More...
	movePrevious ($a_id)
	Move question to previous page. More...
	editQuestion ($a_id)
	Edit question. More...
	addQuestionToolbarForm ()
	Add question to survey form (used in toolbar) More...
	addQuestionToolbar ()
	Add question to survey action (used in toolbar) More...
	movePageForm ()
	Move current page. More...
	movePage ()
	Move current page to new position. More...
	renderToolbar ($a_pages)
	Render toolbar form. More...
	renderPage ()
	render questions per page More...

Protected Attributes
	$ctrl
	$rbacsystem
	$db
	$tabs
	$tpl
	$toolbar
	$user
	$ref_id
	$lng
	$object
	$editor_gui
	$current_page
	$has_previous_page
	$has_next_page
	$has_datasets
	$use_pool
	$log

Detailed Description

Survey per page view.

Author

Jörg Lützenkirchen <luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id

class.ilObjSurveyGUI.php 26720 2010-11-25 17:06:26Z jluetzen

ilSurveyPageGUI:

Definition at line 14 of file class.ilSurveyPageGUI.php.

Constructor & Destructor Documentation

__construct()

ilSurveyPageGUI::__construct	(	ilObjSurvey	$a_survey,
		ilSurveyEditorGUI	$a_survey_editor_gui
	)

Constructor.

Parameters

ilObjSurvey	$a_survey
ilSurveyEditorGUI	$a_survey_editor_gui

Definition at line 72 of file class.ilSurveyPageGUI.php.

References $DIC, ilLoggerFactory\getLogger(), ilObject\getRefId(), and user().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->db = $DIC->database();
        $this->tabs = $DIC->tabs();
        $this->tpl = $DIC["tpl"];
        $this->toolbar = $DIC->toolbar();
        $this->user = $DIC->user();
        $this->editor_gui = $a_survey_editor_gui;
        $this->ref_id = $a_survey->getRefId();
        $this->object = $a_survey;
        $this->log = ilLoggerFactory::getLogger("svy");
    }

Here is the call graph for this function:

Member Function Documentation

addHeading()

ilSurveyPageGUI::addHeading (   $a_id )

protected

Add heading to question.

Parameters

int

$a_id

Definition at line 827 of file class.ilSurveyPageGUI.php.

References callEditor().

    {
        $this->callEditor("addHeadingObject", "q_id", $a_id);
        return true;
    }

Here is the call graph for this function:

addPoolQuestion()

ilSurveyPageGUI::addPoolQuestion	(		$pos,
			$node
	)

Definition at line 1746 of file class.ilSurveyPageGUI.php.

References $ctrl, $ilCtrl, $ilUser, and $user.

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        
        if ($node == "page_end") {
            $pos = $this->object->getSurveyPages();
            $pos = array_pop($pos[$this->current_page-1]);
            $pos = $pos["question_id"] . "a";
        } else {
            $pos = $pos . "b";
        }
        
        $ilCtrl->setParameter($this->editor_gui, "pgov", $this->current_page);
        $ilCtrl->setParameter($this->editor_gui, "pgov_pos", $pos);
        
        $cmd = ($ilUser->getPref('svy_insert_type') == 1 || strlen($ilUser->getPref('svy_insert_type')) == 0) ? 'browseForQuestions' : 'browseForQuestionblocks';
        $ilCtrl->redirect($this->editor_gui, $cmd);
    }

addQuestion()

ilSurveyPageGUI::addQuestion (   $a_type,   $a_use_pool,   $a_pos,   $a_special_position  )

protected

Call add question to survey form.

Parameters

int	$a_type	question type
bool	$a_use_pool	add question to pool
int	$a_pos	target position
string	$a_special_position	special positions (toolbar | page_end)

Definition at line 385 of file class.ilSurveyPageGUI.php.

References $_GET, $_POST, $a_type, $ctrl, $id, $ilCtrl, $tabs, SurveyQuestionGUI\_getQuestionGUI(), ilObjSurveyQuestionPool\_getQuestiontypes(), and object.

Referenced by addQuestionToolbar(), and executeCommand().

    {
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        
        // get translated type
        include_once "./Modules/SurveyQuestionPool/classes/class.ilObjSurveyQuestionPool.php";
        $questiontypes = ilObjSurveyQuestionPool::_getQuestiontypes();
        foreach ($questiontypes as $item) {
            if ($item["questiontype_id"] == $a_type) {
                $type_trans = $item["type_tag"];
            }
        }

        $id = $a_pos;

        // new page behind current (from toolbar)
        if ($a_special_position == "toolbar") {
            $id = $this->object->getSurveyPages();
            if ($a_pos && $a_pos != "fst") {
                $id = $id[$a_pos-1];
                $id = array_pop($id);
                $id = $id["question_id"] . "c";
            } else {
                $id = "0c";
            }
        }
        // append current page
        elseif ($a_special_position == "page_end") {
            $id = $this->object->getSurveyPages();
            $id = $id[$this->current_page-1];
            $id = array_pop($id);
            $id = $id["question_id"] . "a";
        } else {
            $id .= "b";
        }

        if ($a_use_pool) {
            $_GET["sel_question_types"] = $type_trans;
            $_REQUEST["pgov_pos"] = $id;
            $ilCtrl->setParameter($this->editor_gui, "pgov_pos", $id);
            if (!$_POST["usage"]) {
                $ilTabs->clearSubTabs(); // #17193
                $this->editor_gui->createQuestionObject();
            } else {
                $this->editor_gui->executeCreateQuestionObject();
            }
            return true;
        } else {
            // create question and redirect to question form
        
            include_once "./Modules/SurveyQuestionPool/classes/class.SurveyQuestionGUI.php";
            $q_gui = SurveyQuestionGUI::_getQuestionGUI($type_trans);
            $q_gui->object->setObjId($this->object->getId());
            $q_gui->object->createNewQuestion();
            $q_gui_class = get_class($q_gui);

            // #12531
            $ilCtrl->setParameterByClass($q_gui_class, "pgov", $this->current_page);
            $ilCtrl->setParameterByClass($q_gui_class, "pgov_pos", $id);
            $ilCtrl->setParameterByClass($q_gui_class, "ref_id", $this->ref_id);
            $ilCtrl->setParameterByClass($q_gui_class, "new_for_survey", $this->ref_id);
            $ilCtrl->setParameterByClass($q_gui_class, "q_id", $q_gui->object->getId());
            $ilCtrl->setParameterByClass($q_gui_class, "sel_question_types", $q_gui->getQuestionType());
            $ilCtrl->redirectByClass($q_gui_class, "editQuestion");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addQuestionToolbar()

ilSurveyPageGUI::addQuestionToolbar ( )

protected

Add question to survey action (used in toolbar)

Definition at line 1102 of file class.ilSurveyPageGUI.php.

References $_POST, $ctrl, $ilCtrl, $lng, addQuestion(), addQuestionToolbarForm(), renderPage(), and ilUtil\sendFailure().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $pool_active = $this->object->isPoolActive();

        if (!$_POST["usage"] && $pool_active) {
            ilUtil::sendFailure($lng->txt("select_one"), true);
            return $this->addQuestionToolbarForm();
        }

        // make sure that it is set for current and next requests
        $ilCtrl->setParameter($this->editor_gui, "pgov", $this->current_page);

        if (!$this->addQuestion($_POST["qtype"], $pool_active, $_POST["pgov"], "toolbar")) {
            $this->renderPage();
        }
    }

Here is the call graph for this function:

addQuestionToolbarForm()

ilSurveyPageGUI::addQuestionToolbarForm ( )

protected

Add question to survey form (used in toolbar)

Definition at line 1043 of file class.ilSurveyPageGUI.php.

References $ctrl, $form, $ilCtrl, $lng, $si, $tpl, ilObjSurveyQuestionPool\_getQuestiontypes(), array, object, and ilSelectInputGUI\setOptions().

Referenced by addQuestionToolbar().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;

        include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this, "addQuestionToolbar"));
        $form->setTitle($lng->txt("survey_add_new_question"));

        // question types
        include_once "./Modules/SurveyQuestionPool/classes/class.ilObjSurveyQuestionPool.php";
        $questiontypes = ilObjSurveyQuestionPool::_getQuestiontypes();
        $type_map = array();
        foreach ($questiontypes as $trans => $item) {
            $type_map[$item["questiontype_id"]] = $trans;
        }
        include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
        $si = new ilSelectInputGUI($lng->txt("question_type"), "qtype");
        $si->setOptions($type_map);
        $form->addItem($si);

        $pages = $this->object->getSurveyPages();
        if ($pages) {
            $pages_drop = array("fst"=>$lng->txt("survey_at_beginning"));
            foreach ($pages as $idx => $questions) {
                $question = array_shift($questions);
                if ($question["questionblock_id"]) {
                    $pages_drop[$idx+1] = $lng->txt("survey_behind_page") . " " . $question["questionblock_title"];
                } else {
                    $pages_drop[$idx+1] = $lng->txt("survey_behind_page") . " " . strip_tags($question["title"]);
                }
            }
            $pos = new ilSelectInputGUI($lng->txt("position"), "pgov");
            $pos->setOptions($pages_drop);
            $form->addItem($pos);

            $pos->setValue($this->current_page);
        } else {
            // #9089: 1st page
            $pos = new ilHiddenInputGUI("pgov");
            $pos->setValue("fst");
            $form->addItem($pos);
        }

        if ($this->object->isPoolActive()) {
            $this->editor_gui->createQuestionObject($form);
        }

        $form->addCommandButton("addQuestionToolbar", $lng->txt("create"));
        $form->addCommandButton("renderPage", $lng->txt("cancel"));

        return $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

appendNewQuestionToSurvey()

ilSurveyPageGUI::appendNewQuestionToSurvey (   $a_new_id,   $a_duplicate = true,   $a_force_duplicate = false  )

protected

Add new question to survey (database part)

Parameters

int	$a_new_id
bool	$a_duplicate

Todo:

: move out of GUI class, see also ilObjSurvey->insertQuestion

Definition at line 190 of file class.ilSurveyPageGUI.php.

References $db, $ilDB, $result, array, object, and time.

Referenced by insertNewQuestion(), insertQuestionBlock(), and paste().

    {
        $ilDB = $this->db;

        $this->log->debug("append question, id: " . $a_new_id . ", duplicate: " . $a_duplicate . ", force: " . $a_force_duplicate);

        // get maximum sequence index in test
        $result = $ilDB->queryF(
            "SELECT survey_question_id FROM svy_svy_qst WHERE survey_fi = %s",
            array('integer'),
            array($this->object->getSurveyId())
        );
        $sequence = $result->numRows();

        // create duplicate if pool question (or forced for question blocks copy)
        if ($a_duplicate) {
            // this does nothing if this is not a pool question and $a_force_duplicate is false
            $survey_question_id = $this->object->duplicateQuestionForSurvey($a_new_id, $a_force_duplicate);
        }
        // used by copy & paste
        else {
            $survey_question_id = $a_new_id;
        }

        // check if question is not already in the survey, see #22018
        if ($this->object->isQuestionInSurvey($survey_question_id)) {
            return $survey_question_id;
        }

        // append to survey
        $next_id = $ilDB->nextId('svy_svy_qst');
        $affectedRows = $ilDB->manipulateF(
            "INSERT INTO svy_svy_qst (survey_question_id, survey_fi," .
            "question_fi, sequence, tstamp) VALUES (%s, %s, %s, %s, %s)",
            array('integer', 'integer', 'integer', 'integer', 'integer'),
            array($next_id, $this->object->getSurveyId(), $survey_question_id, $sequence, time())
        );

        $this->log->debug("insert svy_svy_qst, id: " . $next_id . ", qfi: " . $survey_question_id . ", seq: " . $sequence);

        return $survey_question_id;
    }

Here is the caller graph for this function:

callEditor()

ilSurveyPageGUI::callEditor (   $a_cmd,   $a_param,   $a_value  )

protected

Definition at line 855 of file class.ilSurveyPageGUI.php.

References $tabs, and array.

Referenced by addHeading(), deleteHeading(), editBlock(), and editHeading().

    {
        $ilTabs = $this->tabs;
        
        $ilTabs->clearSubTabs();
        $_REQUEST[$a_param] = $a_value;
        
        call_user_func(array($this->editor_gui, $a_cmd));
    }

Here is the caller graph for this function:

clearClipboard()

ilSurveyPageGUI::clearClipboard ( )

protected

Empty clipboard.

Definition at line 532 of file class.ilSurveyPageGUI.php.

References $_SESSION, and $ref_id.

Referenced by paste().

    {
        $_SESSION["survey_page_view"][$this->ref_id]["clipboard"] = null;
    }

Here is the caller graph for this function:

confirmRemoveQuestions()

ilSurveyPageGUI::confirmRemoveQuestions ( )

protected

Remove question(s) from survey.

Definition at line 753 of file class.ilSurveyPageGUI.php.

References $_POST, $ctrl, $ilCtrl, $key, $source, and array.

    {
        $ilCtrl = $this->ctrl;
        
        // gather ids
        $ids = array();
        foreach ($_POST as $key => $value) {
            if (preg_match("/id_(\d+)/", $key, $matches)) {
                array_push($ids, $matches[1]);
            }
        }


        $pages = $this->object->getSurveyPages();
        $source = $pages[$this->current_page-1];

        $block_id = $source;
        $block_id = array_shift($block_id);
        $block_id = $block_id["questionblock_id"];

        if (sizeof($ids) && sizeof($source) > sizeof($ids)) {
            // block is obsolete
            if (sizeof($source)-sizeof($ids) == 1) {
                $this->object->unfoldQuestionblocks(array($block_id));
            }
            // block will remain, remove question(s) from block
            else {
                foreach ($ids as $qid) {
                    $this->object->removeQuestionFromBlock($qid, $block_id);
                }
            }

            $this->object->removeQuestions($ids, array());
        }
        // all items on page
        else {
            // remove complete block
            if ($block_id) {
                $this->object->removeQuestions(array(), array($block_id));
            }
            // remove single question
            else {
                $this->object->removeQuestions($ids, array());
            }

            // render previous page
            if ($this->current_page > 1) {
                $this->current_page--;
            }
        }

        $this->object->saveCompletionStatus();
            
        // #10567
        $ilCtrl->setParameter($this, "pgov", $this->current_page);
        $ilCtrl->redirect($this, "renderPage");
    }

copyQuestion()

ilSurveyPageGUI::copyQuestion (   $a_id )

protected

Add question to be copied to clipboard.

Parameters

int

$a_id

question id

Definition at line 476 of file class.ilSurveyPageGUI.php.

References $_SESSION, $lng, $ref_id, array, and ilUtil\sendSuccess().

    {
        $lng = $this->lng;
        
        ilUtil::sendSuccess($lng->txt("survey_questions_to_clipboard_copy"));
        $this->suppress_clipboard_msg = true;
        
        $_SESSION["survey_page_view"][$this->ref_id]["clipboard"] = array(
                        "source" => $this->current_page,
                        "nodes" => array($a_id),
                        "mode" => "copy");
    }

Here is the call graph for this function:

cutQuestion()

ilSurveyPageGUI::cutQuestion (   $a_id )

protected

Add question to be cut to clipboard.

Parameters

int

$a_id

question id

Definition at line 458 of file class.ilSurveyPageGUI.php.

References $_SESSION, $lng, $ref_id, array, and ilUtil\sendSuccess().

    {
        $lng = $this->lng;
        
        ilUtil::sendSuccess($lng->txt("survey_questions_to_clipboard_cut"));
        $this->suppress_clipboard_msg = true;
        
        $_SESSION["survey_page_view"][$this->ref_id]["clipboard"] = array(
                        "source" => $this->current_page,
                        "nodes" => array($a_id),
                        "mode" => "cut");
    }

Here is the call graph for this function:

deleteBlock()

ilSurveyPageGUI::deleteBlock ( )

protected

Confirm removing question block.

Parameters

int

$a_id

Definition at line 707 of file class.ilSurveyPageGUI.php.

References $ctrl, $ilCtrl, $lng, array, and ilUtil\sendQuestion().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        $ilCtrl->setParameter($this->editor_gui, "pgov", $this->current_page);
        ilUtil::sendQuestion($lng->txt("remove_questions"));
        
        $page = $this->object->getSurveyPages();
        $page = $page[$this->current_page-1];
        
        // #10567
        if ($_REQUEST["csum"] != md5(print_r($page, true))) {
            $ilCtrl->redirect($this, "renderPage");
        }
        
        $page = array_shift($page);
        $block_id = $page["questionblock_id"];
        if ($block_id) {
            $this->editor_gui->removeQuestionsForm(array($block_id), array(), array());
        } else {
            $this->editor_gui->removeQuestionsForm(array(), array($page["question_id"]), array());
        }
    }

Here is the call graph for this function:

deleteHeading()

ilSurveyPageGUI::deleteHeading (   $a_id )

protected

Delete question heading.

Parameters

int

$a_id

Definition at line 849 of file class.ilSurveyPageGUI.php.

References callEditor().

    {
        $this->callEditor("removeHeadingObject", "q_id", $a_id);
        return true;
    }

Here is the call graph for this function:

deleteQuestion()

ilSurveyPageGUI::deleteQuestion (   $a_id )

protected

Confirm removing question(s) from survey.

Parameters

int | array

$a_id

Definition at line 737 of file class.ilSurveyPageGUI.php.

References $ctrl, $ilCtrl, and array.

    {
        $ilCtrl = $this->ctrl;
        
        if (!is_array($a_id)) {
            $a_id = array($a_id);
        }
        
        $ilCtrl->setParameter($this->editor_gui, "pgov", $this->current_page);
        $this->editor_gui->removeQuestionsForm(array(), $a_id, array());
        return true;
    }

determineCurrentPage()

ilSurveyPageGUI::determineCurrentPage

(

)

determine current page

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

References $current_page.

Referenced by executeCommand().

    {
        $current_page = (int) $_REQUEST["jump"];
        if (!$current_page) {
            $current_page = (int) $_REQUEST["pgov"];
        }
        if (!$current_page) {
            $current_page = (int) $_REQUEST["pg"];
        }
        if (!$current_page) {
            $current_page = 1;
        }
        $this->current_page = $current_page;
    }

Here is the caller graph for this function:

dnd()

ilSurveyPageGUI::dnd ( )

protected

Move questions in page.

Definition at line 685 of file class.ilSurveyPageGUI.php.

References $target_id, and array.

    {
        $source_id = (int) array_pop(explode("_", $_REQUEST["il_hform_source"]));
        if ($_REQUEST["il_hform_target"] != "droparea_end") {
            $target_id = (int) array_pop(explode("_", $_REQUEST["il_hform_target"]));
            $pos = 0;
        } else {
            $page = $this->object->getSurveyPages();
            $page = $page[$this->current_page-1];
            $last = array_pop($page);
            $target_id = (int) $last["question_id"];
            $pos = 1;
        }
        if ($source_id != $target_id) {
            $this->object->moveQuestions(array($source_id), $target_id, $pos);
        }
    }

editBlock()

ilSurveyPageGUI::editBlock (   $a_id )

protected

Edit question block.

Parameters

int

$a_id

Definition at line 816 of file class.ilSurveyPageGUI.php.

References callEditor().

    {
        $this->callEditor("editQuestionblockObject", "bl_id", $a_id);
        return true;
    }

Here is the call graph for this function:

editHeading()

ilSurveyPageGUI::editHeading (   $a_id )

protected

Edit question heading.

Parameters

int

$a_id

Definition at line 838 of file class.ilSurveyPageGUI.php.

References callEditor().

    {
        $this->callEditor("editHeadingObject", "q_id", $a_id);
        return true;
    }

Here is the call graph for this function:

editQuestion()

ilSurveyPageGUI::editQuestion (   $a_id )

protected

Edit question.

Parameters

int

$a_id

Definition at line 1026 of file class.ilSurveyPageGUI.php.

References $ctrl, $data, and $ilCtrl.

    {
        $ilCtrl = $this->ctrl;
        
        $data = $this->object->getSurveyQuestions();
        $data = $data[$a_id];
                    
        $q_gui = $data["type_tag"] . "GUI";
        $ilCtrl->setParameterByClass($q_gui, "pgov", $this->current_page);
        $ilCtrl->setParameterByClass($q_gui, "q_id", $a_id);
        
        $ilCtrl->redirectByClass($q_gui, "editQuestion");
    }

executeCommand()

ilSurveyPageGUI::executeCommand

(

)

Routing.

Definition at line 93 of file class.ilSurveyPageGUI.php.

References $ctrl, $current_page, $id, $ilCtrl, $lng, $rbacsystem, $type, addQuestion(), array, determineCurrentPage(), insertNewQuestion(), object, and ilUtil\sendFailure().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $rbacsystem = $this->rbacsystem;

        $cmd = $ilCtrl->getCmd("renderPage");
        $next_class = $ilCtrl->getNextClass($this);

        switch ($next_class) {
            default:
                $this->determineCurrentPage();

                $has_content = false;
                
                if ($rbacsystem->checkAccess("write", $this->ref_id)) {
                    // add page?
                    if ($_REQUEST["new_id"]) {
                        $this->insertNewQuestion($_REQUEST["new_id"]);
                    }

                    // subcommands
                    if ($_REQUEST["il_hform_subcmd"]) {
                        $subcmd = $_REQUEST["il_hform_subcmd"];

                        // make sure that it is set for current and next requests
                        $ilCtrl->setParameter($this->editor_gui, "pgov", $this->current_page);
                        $_REQUEST["pgov"] = $this->current_page;

                        $id = explode("_", $_REQUEST["il_hform_node"]);
                        $id = (int) $id[1];

                        // multi operation
                        if (substr($_REQUEST["il_hform_subcmd"], 0, 5) == "multi") {
                            if ($_REQUEST["il_hform_multi"]) {
                                // removing types as we only allow questions anyway
                                $id = array();
                                foreach (explode(";", $_REQUEST["il_hform_multi"]) as $item) {
                                    $id[] = (int) array_pop(explode("_", $item));
                                }

                                if ($subcmd == "multiDelete") {
                                    $subcmd = "deleteQuestion";
                                }
                            } else {
                                // #9525
                                if ($subcmd == "multiDelete") {
                                    ilUtil::sendFailure($lng->txt("no_checkbox"), true);
                                    $ilCtrl->redirect($this, "renderPage");
                                } else {
                                    ilUtil::sendFailure($lng->txt("no_checkbox"));
                                }
                            }
                        }

                        if (substr($subcmd, 0, 11) == "addQuestion") {
                            $type = explode("_", $subcmd);
                            $type = (int) $type[1];
                            $has_content = $this->addQuestion($type, $this->object->isPoolActive(), $id, $_REQUEST["il_hform_node"]);
                        } else {
                            $has_content = $this->$subcmd($id, $_REQUEST["il_hform_node"]);
                        }
                    }
                }

                if (!$has_content) {
                    $this->$cmd();
                }
                break;
        }
    }

Here is the call graph for this function:

getAutoBlockTitle()

ilSurveyPageGUI::getAutoBlockTitle

(

)

Get name for newly created blocks.

Returns

string

Definition at line 1739 of file class.ilSurveyPageGUI.php.

References $lng.

Referenced by insertNewQuestion(), insertQuestionBlock(), moveNext(), movePrevious(), paste(), and splitPage().

    {
        $lng = $this->lng;

        return $lng->txt("survey_auto_block_title");
    }

Here is the caller graph for this function:

getPageNodes()

ilSurveyPageGUI::getPageNodes	(	array	$a_questions,
			$a_has_previous_page = false,
			$a_has_next_page = false,
			$a_readonly = false
	)

Get Form HTML.

Parameters

array	$questions
bool	$a_has_previous_page
bool	$a_has_next_page
bool	$a_readonly

Returns

string

Definition at line 1468 of file class.ilSurveyPageGUI.php.

References $_SESSION, $counter, $ctrl, $ilCtrl, $lng, ilObjSurveyQuestionPool\_getQuestiontypes(), array, object, and renderPageNode().

Referenced by renderPage().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $ttpl = new ilTemplate("tpl.il_svy_svy_page_view_nodes.html", true, true, "Modules/Survey");

        $has_clipboard = (bool) $_SESSION["survey_page_view"][$this->ref_id]["clipboard"];

        // question block ?

        $first_question = $a_questions;
        $first_question = array_shift($first_question);

        if ($first_question["questionblock_id"]) {
            $menu = array();

            if (!$a_readonly && !$has_clipboard) {
                $menu[] = array("cmd" => "editBlock", "text" => $lng->txt("edit"));
            }

            if ($first_question["questionblock_show_blocktitle"]) {
                $block_status = $lng->txt("survey_block_visible");
            } else {
                $block_status = $lng->txt("survey_block_hidden");
            }

            $this->renderPageNode(
                $ttpl,
                "block",
                $first_question["questionblock_id"],
                $first_question["questionblock_title"] . " (" . $block_status . ")",
                $menu,
                false,
                false,
                $block_status
            );
        }


        // questions/headings

        include_once "./Modules/SurveyQuestionPool/classes/class.ilObjSurveyQuestionPool.php";
        $questiontypes = ilObjSurveyQuestionPool::_getQuestiontypes();
        $questionpools = array_keys($this->object->getQuestionpoolTitles(true));
        
        $counter = $question_count;
        $block_done = null;
        foreach ($a_questions as $idx => $question) {
            // drop area

            $menu = array();

            if (!$a_readonly) {
                if (!$has_clipboard) {
                    foreach ($questiontypes as $trans => $item) {
                        $menu[] = array("cmd"=> "addQuestion_" . $item["questiontype_id"],
                            "text"=> sprintf($lng->txt("svy_page_add_question"), $trans));
                    }
                    
                    if ($this->object->isPoolActive()) {
                        $menu[] = array("cmd"=> "addPoolQuestion",
                            "text"=> $lng->txt("browse_for_questions"));
                    }
                } else {
                    $menu[] = array("cmd" => "paste", "text" => $lng->txt("survey_dnd_paste"));
                }
            }

            $this->renderPageNode($ttpl, "droparea", $question["question_id"], null, $menu, true);

            // question
            $question_gui = $this->object->getQuestionGUI($question["type_tag"], $question["question_id"]);
            $question_form = $question_gui->getWorkingForm(
                array(),
                $this->object->getShowQuestionTitles(),
                $question["questionblock_show_questiontext"],
                null,
                $this->object->getSurveyId()
            );

            $menu = array();

            if (!$a_readonly && !$has_clipboard) {
                $menu[] = array("cmd" => "editQuestion", "text" => $lng->txt("edit"));
                $menu[] = array("cmd" => "cutQuestion", "text" => $lng->txt("cut"));
                $menu[] = array("cmd" => "copyQuestion", "text" => $lng->txt("copy"));

                if (sizeof($a_questions) > 1 && $idx > 0) {
                    $menu[] = array("cmd" => "splitPage", "text" => $lng->txt("survey_dnd_split_page"));
                }
                if ($a_has_next_page) {
                    $menu[] = array("cmd" => "moveNext", "text" => $lng->txt("survey_dnd_move_next"));
                }
                if ($a_has_previous_page) {
                    $menu[] = array("cmd" => "movePrevious", "text" => $lng->txt("survey_dnd_move_previous"));
                }
                
                $menu[] = array("cmd" => "deleteQuestion", "text" => $lng->txt("delete"));
                
                // heading
                if ($question["heading"]) {
                    $menu[] = array("cmd" => "editHeading", "text" => $lng->txt("survey_edit_heading"));
                    $menu[] = array("cmd" => "deleteHeading", "text" => $lng->txt("survey_delete_heading"));
                } else {
                    $menu[] = array("cmd" => "addHeading", "text" => $lng->txt("add_heading"));
                }
            }

            if ($first_question["questionblock_show_questiontext"]) {
                $question_title_status = $lng->txt("survey_question_text_visible");
            } else {
                $question_title_status = $lng->txt("survey_question_text_hidden");
            }

            $this->renderPageNode(
                $ttpl,
                "question",
                $question["question_id"],
                $question_form,
                $menu,
                false,
                $question["title"],
                $question_title_status,
                $question["heading"]
            );

            $ilCtrl->setParameter($this, "eqid", "");
        }


        // last position (no question id)

        $menu = array();

        if (!$a_readonly) {
            if (!$has_clipboard) {
                foreach ($questiontypes as $trans => $item) {
                    $menu[] = array("cmd"=> "addQuestion_" . $item["questiontype_id"],
                        "text"=> sprintf($lng->txt("svy_page_add_question"), $trans));
                }
                
                if ($this->object->isPoolActive()) {
                    $menu[] = array("cmd"=> "addPoolQuestion",
                        "text"=> $lng->txt("browse_for_questions"));
                }
            } else {
                $menu[] = array("cmd" => "paste", "text" => $lng->txt("survey_dnd_paste"));
            }
        }

        $this->renderPageNode($ttpl, "page", "end", null, $menu, true);

        return $ttpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertNewQuestion()

ilSurveyPageGUI::insertNewQuestion

(

$a_new_id

)

Add new question to survey.

Parameters

int

$a_new_id

Definition at line 238 of file class.ilSurveyPageGUI.php.

References $current, $db, $ilDB, $lng, $rbacsystem, SurveyQuestion\_isComplete(), appendNewQuestionToSurvey(), array, getAutoBlockTitle(), and ilUtil\sendFailure().

Referenced by executeCommand().

    {
        $rbacsystem = $this->rbacsystem;
        $ilDB = $this->db;
        $lng = $this->lng;

        include_once "./Modules/SurveyQuestionPool/classes/class.SurveyQuestion.php";
        if (!SurveyQuestion::_isComplete($a_new_id)) {
            ilUtil::sendFailure($lng->txt("survey_error_insert_incomplete_question"));
        } else {
            $a_new_id = $this->appendNewQuestionToSurvey($a_new_id);
            $this->object->loadQuestionsFromDb();

            $pos = $_REQUEST["pgov_pos"];

            // a[fter]/b[efore] on same page
            if (substr($pos, -1) != "c") {
                // block handling
                $current = $this->object->getSurveyPages();
                $current = $current[$this->current_page-1];
                if (sizeof($current) == 1) {
                    // as questions are moved to first block question
                    // always use existing as first
                    // the new question is moved later on (see below)
                    $this->object->createQuestionblock(
                        $this->getAutoBlockTitle(),
                        true,
                        false,
                        array((int) $pos, $a_new_id)
                    );
                } else {
                    $block_id = array_pop($current);
                    $block_id = $block_id["questionblock_id"];

                    $this->object->addQuestionToBlock($a_new_id, $block_id);
                }
            }
            // c: as new page (from toolbar/pool)
            else {
                // after given question
                if ((int) $pos) {
                    $pos = (int) $pos . "a";
                    $this->current_page++;
                }
                // at the beginning
                else {
                    $first = $this->object->getSurveyPages();
                    $first = $first[0];
                    $first = array_shift($first);
                    $pos = $first["question_id"] . "b";
                    $this->current_page = 1;
                }
            }

            // move to target position
            $this->object->moveQuestions(
                array($a_new_id),
                (int) $pos,
                ((substr($pos, -1) == "a") ? 1 : 0)
            );

            $this->object->fixSequenceStructure();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertQuestionBlock()

ilSurveyPageGUI::insertQuestionBlock

(

$a_block_id

)

Copy and insert questions from block.

Parameters

int

$a_block_id

Definition at line 308 of file class.ilSurveyPageGUI.php.

References $current, appendNewQuestionToSurvey(), array, and getAutoBlockTitle().

    {
        $new_ids = array();
        $question_ids = $this->object->getQuestionblockQuestionIds($a_block_id);
        foreach ($question_ids as $qid) {
            $new_ids[] = $this->appendNewQuestionToSurvey($qid, true, true);
        }
        
        if (sizeof($new_ids)) {
            $this->object->loadQuestionsFromDb();
            
            $pos = $_REQUEST["pgov_pos"];
        
            // a[fter]/b[efore] on same page
            if (substr($pos, -1) != "c") {
                // block handling
                $current = $this->object->getSurveyPages();
                $current = $current[$this->current_page-1];
                if (sizeof($current) == 1) {
                    // as questions are moved to first block question
                    // always use existing as first
                    // the new question is moved later on (see below)
                    $this->object->createQuestionblock(
                        $this->getAutoBlockTitle(),
                        true,
                        false,
                        array((int) $pos)+$new_ids
                    );
                } else {
                    $block_id = array_pop($current);
                    $block_id = $block_id["questionblock_id"];

                    foreach ($new_ids as $qid) {
                        $this->object->addQuestionToBlock($qid, $block_id);
                    }
                }
            }
            // c: as new page (from toolbar/pool)
            else {
                // re-create block
                $this->object->createQuestionblock(
                    $this->getAutoBlockTitle(),
                    true,
                    false,
                    $new_ids
                );
                
                // after given question
                if ((int) $pos) {
                    $pos = (int) $pos . "a";
                }
                // at the beginning
                else {
                    $first = $this->object->getSurveyPages();
                    $first = $first[0];
                    $first = array_shift($first);
                    $pos = $first["question_id"] . "b";
                }
            }

            // move to target position
            $this->object->moveQuestions(
                $new_ids,
                (int) $pos,
                ((substr($pos, -1) == "a") ? 1 : 0)
            );
        }
    }

Here is the call graph for this function:

moveNext()

ilSurveyPageGUI::moveNext (   $a_id )

protected

Move question to next page.

Parameters

int

$a_id

Definition at line 917 of file class.ilSurveyPageGUI.php.

References $current_page, $source, $target, $target_id, array, and getAutoBlockTitle().

    {
        $pages = $this->object->getSurveyPages();
        $source = $pages[$this->current_page-1];
        $target = $pages[$this->current_page];
        if (sizeof($target)) {
            $target_id = $target;
            $target_id = array_shift($target_id);
            $target_block_id = $target_id["questionblock_id"];
            $target_id = $target_id["question_id"];

            // nothing to do if no block
            if (sizeof($source) > 1) {
                $block_id = $source;
                $block_id = array_shift($block_id);
                $block_id = $block_id["questionblock_id"];

                // source pages block is obsolete
                if (sizeof($source) == 2) {
                    // delete block
                    $this->object->unfoldQuestionblocks(array($block_id));
                } else {
                    // remove question from block
                    $this->object->removeQuestionFromBlock($a_id, $block_id);
                }
            }

            // move source question to target
            $this->object->moveQuestions(array($a_id), $target_id, 0);

            // new page has no block yet
            if (sizeof($target) < 2) {
                // create block and  move target question and source into block
                $this->object->createQuestionblock(
                    $this->getAutoBlockTitle(),
                    true,
                    false,
                    array($a_id, $target_id)
                );
            } else {
                // add source question to block
                $this->object->addQuestionToBlock($a_id, $target_block_id);
            }

            // only if current page is not "deleted"
            if (sizeof($source) > 1) {
                $this->current_page++;
            }
        }
    }

Here is the call graph for this function:

movePage()

ilSurveyPageGUI::movePage ( )

protected

Move current page to new position.

Todo:

this needs to be refactored outside of a GUI class, same with ilSurveyEditorGUI->insertQuestions

Definition at line 1171 of file class.ilSurveyPageGUI.php.

References $ctrl, $ilCtrl, $lng, $target, and ilUtil\sendSuccess().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        // current_page is already set to new position
        $target_page = $this->current_page-1;
        $source_page = $_REQUEST["old_pos"]-1;

        $pages = $this->object->getSurveyPages();
        foreach ($pages[$source_page] as $question) {
            $questions[] = $question["question_id"];
        }

        // move to first position
        $position = 0;
        if ($_REQUEST["pgov"] != "fst") {
            $position = 1;
        }

        $target = $pages[$target_page];
        if ($position == 0) {                                                           // before
            $target = array_shift($target);             // ... use always the first question of the page
        } else {                                                                                        // after
            $target = array_pop($target);             // ... use always the last question of the page
        }
        $this->object->moveQuestions($questions, $target["question_id"], $position);

        if ($target_page < $source_page && $position) {
            $this->current_page++;
        }

        ilUtil::sendSuccess($lng->txt("survey_page_moved"), true);
        $ilCtrl->setParameter($this, "pgov", $this->current_page);
        $ilCtrl->redirect($this, "renderPage");
    }

Here is the call graph for this function:

movePageForm()

ilSurveyPageGUI::movePageForm ( )

protected

Move current page.

Definition at line 1125 of file class.ilSurveyPageGUI.php.

References $ctrl, $form, $ilCtrl, $lng, $tpl, array, and ilSelectInputGUI\setOptions().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;

        include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this, "movePage"));
        $form->setTitle($lng->txt("survey_move_page"));
        
        $old_pos = new ilHiddenInputGUI("old_pos");
        $old_pos->setValue($this->current_page);
        $form->addItem($old_pos);

        $pages = $this->object->getSurveyPages();
        if ($pages) {
            $pages_drop = array();
            if ($this->current_page != 1) {
                $pages_drop["fst"] = $lng->txt("survey_at_beginning");
            }
            foreach ($pages as $idx => $questions) {
                if (($idx+1) != $this->current_page && ($idx+2) != $this->current_page) {
                    $question = array_shift($questions);
                    if ($question["questionblock_id"]) {
                        $pages_drop[$idx+1] = $lng->txt("survey_behind_page") . " " . $question["questionblock_title"];
                    } else {
                        $pages_drop[$idx+1] = $lng->txt("survey_behind_page") . " " . strip_tags($question["title"]);
                    }
                }
            }
            $pos = new ilSelectInputGUI($lng->txt("position"), "pgov");
            $pos->setOptions($pages_drop);
            $form->addItem($pos);
        }

        $form->addCommandButton("movePage", $lng->txt("submit"));
        $form->addCommandButton("renderPage", $lng->txt("cancel"));

        return $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

movePrevious()

ilSurveyPageGUI::movePrevious (   $a_id )

protected

Move question to previous page.

Parameters

int

$a_id

Definition at line 973 of file class.ilSurveyPageGUI.php.

References $source, $target, $target_id, array, and getAutoBlockTitle().

    {
        $pages = $this->object->getSurveyPages();
        $source = $pages[$this->current_page-1];
        $target = $pages[$this->current_page-2];
        if (sizeof($target)) {
            $target_id = $target;
            $target_id = array_pop($target_id);
            $target_block_id = $target_id["questionblock_id"];
            $target_id = $target_id["question_id"];

            // nothing to do if no block
            if (sizeof($source) > 1) {
                $block_id = $source;
                $block_id = array_shift($block_id);
                $block_id = $block_id["questionblock_id"];

                // source pages block is obsolete
                if (sizeof($source) == 2) {
                    // delete block
                    $this->object->unfoldQuestionblocks(array($block_id));
                } else {
                    // remove question from block
                    $this->object->removeQuestionFromBlock($a_id, $block_id);
                }
            }

            // move source question to target
            $this->object->moveQuestions(array($a_id), $target_id, 1);

            // new page has no block yet
            if (sizeof($target) < 2) {
                // create block and  move target question and source into block
                $this->object->createQuestionblock(
                    $this->getAutoBlockTitle(),
                    true,
                    false,
                    array($target_id, $a_id)
                );
            } else {
                // add source question to block
                $this->object->addQuestionToBlock($a_id, $target_block_id);
            }

            $this->current_page--;
        }
    }

Here is the call graph for this function:

multiCopy()

ilSurveyPageGUI::multiCopy (   $a_id )

protected

Add questions to be copied to clipboard.

Parameters

array

$a_id

question ids

Definition at line 514 of file class.ilSurveyPageGUI.php.

References $_SESSION, $lng, $ref_id, array, and ilUtil\sendSuccess().

    {
        $lng = $this->lng;

        if (is_array($a_id)) {
            ilUtil::sendSuccess($lng->txt("survey_questions_to_clipboard_copy"));
            $this->suppress_clipboard_msg = true;

            $_SESSION["survey_page_view"][$this->ref_id]["clipboard"] = array(
                "source" => $this->current_page,
                "nodes" => $a_id,
                "mode" => "copy");
        }
    }

Here is the call graph for this function:

multiCut()

ilSurveyPageGUI::multiCut (   $a_id )

protected

Add questions to be cut to clipboard.

Parameters

array

$a_id

question ids

Definition at line 494 of file class.ilSurveyPageGUI.php.

References $_SESSION, $lng, $ref_id, array, and ilUtil\sendSuccess().

    {
        $lng = $this->lng;

        if (is_array($a_id)) {
            ilUtil::sendSuccess($lng->txt("survey_questions_to_clipboard_cut"));
            $this->suppress_clipboard_msg = true;

            $_SESSION["survey_page_view"][$this->ref_id]["clipboard"] = array(
                "source" => $this->current_page,
                "nodes" => $a_id,
                "mode" => "cut");
        }
    }

Here is the call graph for this function:

paste()

ilSurveyPageGUI::paste (   $a_id )

protected

Paste from clipboard.

Parameters

int

$a_id

target position

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

References $_SESSION, $data, $ref_id, $source, $target, $title, ilObjSurvey\_instanciateQuestion(), appendNewQuestionToSurvey(), array, clearClipboard(), getAutoBlockTitle(), and object.

    {
        $data = $_SESSION["survey_page_view"][$this->ref_id]["clipboard"];
        $pages = $this->object->getSurveyPages();
        $source = $pages[$data["source"]-1];
        $target = $pages[$this->current_page-1];
                
        // #12558 - use order of source page
        $nodes = array();
        foreach ($source as $src_qst) {
            if (in_array($src_qst["question_id"], $data["nodes"])) {
                $nodes[] = $src_qst["question_id"];
            }
        }
        
        // append to last position?
        $pos = 0;
        if ($_REQUEST["il_hform_node"] == "page_end") {
            $a_id = $target;
            $a_id = array_pop($a_id);
            $a_id = $a_id["question_id"];
            $pos = 1;
        }
        
        // cut
        if ($data["mode"] == "cut") {
            // special case: paste cut on same page (no block handling needed)
            if ($data["source"] == $this->current_page) {
                // re-order nodes in page
                if (sizeof($nodes) <= sizeof($source)) {
                    $this->object->moveQuestions($nodes, $a_id, $pos);
                }
                $this->clearClipboard();
                return;
            } else {
                // only if source has block
                $source_block_id = false;
                if (sizeof($source) > 1) {
                    $source_block_id = $source;
                    $source_block_id = array_shift($source_block_id);
                    $source_block_id = $source_block_id["questionblock_id"];

                    // remove from block
                    if (sizeof($source) > sizeof($nodes)) {
                        foreach ($nodes as $qid) {
                            $this->object->removeQuestionFromBlock($qid, $source_block_id);
                        }
                    }
                    // remove complete block
                    else {
                        $this->object->unfoldQuestionblocks(array($source_block_id));
                    }
                }

                // page will be "deleted" by operation
                if (sizeof($source) == sizeof($nodes) && $data["source"] < $this->current_page) {
                    $this->current_page--;
                }
            }
        }
        
        // copy
        elseif ($data["mode"] == "copy") {
            $titles = array();
            foreach ($this->object->getSurveyPages() as $page) {
                foreach ($page as $question) {
                    $titles[] = $question["title"];
                }
            }

            // copy questions
            $question_pointer = array();
            foreach ($nodes as $qid) {
                // create new questions
                $question = ilObjSurvey::_instanciateQuestion($qid);

                // handle exisiting copies
                $title = $question->getTitle();
                $max = 0;
                foreach ($titles as $existing_title) {
                    #21278 preg_quote with delimiter
                    if (preg_match("/" . preg_quote($title, "/") . " \(([0-9]+)\)$/", $existing_title, $match)) {
                        $max = max($match[1], $max);
                    }
                }
                if ($max) {
                    $title .= " (" . ($max+1) . ")";
                } else {
                    $title .= " (2)";
                }
                $titles[] = $title;
                $question->setTitle($title);

                $question->id = -1;
                $question->saveToDb();

                $question_pointer[$qid] = $question->getId();
                $this->appendNewQuestionToSurvey($question->getId(), false);
            }

            // copy textblocks
            $this->object->cloneTextblocks($question_pointer);

            $this->object->loadQuestionsFromDb();

            $nodes = array_values($question_pointer);
        }

            
        // paste

        // create new block
        if (sizeof($target) == 1) {
            $nodes = array_merge(array($a_id), $nodes);

            // moveQuestions() is called within
            $this->object->createQuestionblock(
                $this->getAutoBlockTitle(),
                true,
                false,
                $nodes
            );
        }
        // add to existing block
        else {
            $target_block_id = $target;
            $target_block_id = array_shift($target_block_id);
            $target_block_id = $target_block_id["questionblock_id"];

            foreach ($nodes as $qid) {
                $this->object->addQuestionToBlock($qid, $target_block_id);
            }

            // move to new position
            $this->object->moveQuestions($nodes, $a_id, $pos);
        }

        $this->clearClipboard();
    }

Here is the call graph for this function:

renderPage()

ilSurveyPageGUI::renderPage ( )

protected

render questions per page

Definition at line 1345 of file class.ilSurveyPageGUI.php.

References $_SESSION, $ctrl, $ilCtrl, $lng, $rbacsystem, $tags, $tpl, ilObjAdvancedEditing\_getUsedHTMLTags(), ilObjSurvey\_hasDatasets(), ilGlyphGUI\ADD, array, ilGlyphGUI\DRAG, ilGlyphGUI\get(), ilUtil\getImagePath(), getPageNodes(), ilYuiUtil\initDragDrop(), object, ilTinyMCE\removeRedundantSeparators(), renderToolbar(), and ilUtil\sendInfo().

Referenced by addQuestionToolbar().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $rbacsystem = $this->rbacsystem;

        $pages = $this->object->getSurveyPages();
        $this->has_next_page = ($this->current_page < sizeof($pages));
        $this->has_previous_page = ($this->current_page > 1);
        $this->has_datasets = ilObjSurvey::_hasDatasets($this->object->getSurveyId());
        
        if ($this->has_datasets) {
            $link = $ilCtrl->getLinkTargetByClass(array("ilobjsurveygui", "ilsurveyparticipantsgui"), "maintenance");
            $link = "<a href=\"" . $link . "\">" . $lng->txt("survey_has_datasets_warning_page_view_link") . "</a>";
            ilUtil::sendInfo($lng->txt("survey_has_datasets_warning_page_view") . " " . $link);
        }

        $ilCtrl->setParameter($this, "pg", $this->current_page);
        $ilCtrl->setParameter($this, "pgov", "");

        $this->renderToolbar($pages);

        if ($pages) {
            $ttpl = new ilTemplate("tpl.il_svy_svy_page_view.html", true, true, "Modules/Survey");
            $ttpl->setVariable("FORM_ACTION", $ilCtrl->getFormAction($this));
            $lng->loadLanguageModule("form");

            $read_only = ($this->has_datasets || !$rbacsystem->checkAccess("write", $this->ref_id));

            $commands = $multi_commands = array();

            if (!$read_only) {
                // clipboard is empty
                if (!$_SESSION["survey_page_view"][$this->ref_id]["clipboard"]) {
                    $multi_commands[] = array("cmd"=>"multiDelete", "text"=>$lng->txt("delete"));
                    $multi_commands[] = array("cmd"=>"multiCut", "text"=>$lng->txt("cut"));
                    $multi_commands[] = array("cmd"=>"multiCopy", "text"=>$lng->txt("copy"));
                    $multi_commands[] = array("cmd"=>"selectAll", "text"=>$lng->txt("select_all"));
                } else {
                    if (!$this->suppress_clipboard_msg) {
                        ilUtil::sendInfo($lng->txt("survey_clipboard_notice"));
                    }
                    $multi_commands[] = array("cmd"=>"clearClipboard", "text"=>$lng->txt("survey_dnd_clear_clipboard"));
                }

                // help - see ilPageObjectGUI::insertHelp()
                $lng->loadLanguageModule("content");
                $ttpl->setCurrentBlock("help_section");
                $ttpl->setVariable("TXT_ADD_EL", $lng->txt("cont_add_elements"));
                include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                $ttpl->setVariable("PLUS", ilGlyphGUI::get(ilGlyphGUI::ADD));
                $ttpl->setVariable("DRAG_ARROW", ilGlyphGUI::get(ilGlyphGUI::DRAG));
                $ttpl->setVariable("TXT_DRAG", $lng->txt("cont_drag_and_drop_elements"));
                $ttpl->setVariable("TXT_SEL", $lng->txt("cont_double_click_to_delete"));
                $ttpl->parseCurrentBlock();

                $ttpl->setVariable("DND_INIT_JS", "initDragElements();");


                // tiny mce
                
                include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
                $tags = ilObjAdvancedEditing::_getUsedHTMLTags("survey");

                include_once "./Services/RTE/classes/class.ilTinyMCE.php";
                $tiny = new ilTinyMCE();
                $ttpl->setVariable("WYSIWYG_BLOCKFORMATS", $tiny->_buildAdvancedBlockformatsFromHTMLTags($tags));
                $ttpl->setVariable("WYSIWYG_VALID_ELEMENTS", $tiny->_getValidElementsFromHTMLTags($tags));

                $buttons_1 = $tiny->_buildAdvancedButtonsFromHTMLTags(1, $tags);
                $buttons_2 = $tiny->_buildAdvancedButtonsFromHTMLTags(2, $tags) . ',' .
                            $tiny->_buildAdvancedTableButtonsFromHTMLTags($tags) .
                            ($tiny->getStyleSelect() ? ',styleselect' : '');
                $buttons_3 = $tiny->_buildAdvancedButtonsFromHTMLTags(3, $tags);
                $ttpl->setVariable('WYSIWYG_BUTTONS_1', ilTinyMCE::removeRedundantSeparators($buttons_1));
                $ttpl->setVariable('WYSIWYG_BUTTONS_2', ilTinyMCE::removeRedundantSeparators($buttons_2));
                $ttpl->setVariable('WYSIWYG_BUTTONS_3', ilTinyMCE::removeRedundantSeparators($buttons_3));
            }

            // commands
            if (count($multi_commands) > 0) {
                foreach ($multi_commands as $cmd) {
                    $ttpl->setCurrentBlock("multi_cmd");
                    $ttpl->setVariable("ORG_CMD_MULTI", "renderPage");
                    $ttpl->setVariable("MULTI_CMD", $cmd["cmd"]);
                    $ttpl->setVariable("MULTI_CMD_TXT", $cmd["text"]);
                    $ttpl->parseCurrentBlock();
                }
                
                $ttpl->setCurrentBlock("multi_cmds");
                $ttpl->setVariable("MCMD_ALT", $lng->txt("commands"));
                $ttpl->setVariable("MCMD_IMG", ilUtil::getImagePath("arrow_downright.svg"));
                $ttpl->parseCurrentBlock();
            }

            // nodes
            $ttpl->setVariable("NODES", $this->getPageNodes(
                $pages[$this->current_page-1],
                $this->has_previous_page,
                $this->has_next_page,
                $read_only
            ));

            $tpl->setContent($ttpl->get());

            // add js to template
            include_once("./Services/YUI/classes/class.ilYuiUtil.php");
            ilYuiUtil::initDragDrop();
            $tpl->addJavascript("./Modules/Survey/js/SurveyPageView.js");
            $tpl->addJavascript("./Services/RTE/tiny_mce_3_5_11/tiny_mce_src.js");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderPageNode()

ilSurveyPageGUI::renderPageNode	(	ilTemplate	$a_tpl,
			$a_type,
			$a_id,
			$a_content = null,
		array	$a_menu = null,
			$a_spacer = false,
			$a_subtitle = false,
			$a_status = false,
			$a_heading = false
	)

Render single of dnd page view.

Parameters

ilTemplate	$a_tpl
string	$a_type
int	$a_id
string	$a_content
array	$a_menu
bool	$a_spacer
string	$a_subtitle
string	$a_heading

Definition at line 1636 of file class.ilSurveyPageGUI.php.

References $a_content, $a_type, $ctrl, $ilCtrl, $lng, $url, ilGlyphGUI\ADD, ilGlyphGUI\get(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilTemplate\touchBlock().

Referenced by getPageNodes().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $node_id = $a_type . "_" . $a_id;
        
        if ($a_spacer) {
            if ($a_menu) {
                // drop area menu
                foreach ($a_menu as $mcnt => $menu_item) {
                    $ilCtrl->setParameter($this, "il_hform_node", $node_id);
                    $ilCtrl->setParameter($this, "il_hform_subcmd", $menu_item["cmd"]);
                    $url = $ilCtrl->getLinkTarget($this, "renderPage");
                    $ilCtrl->setParameter($this, "il_hform_subcmd", "");
                    $ilCtrl->setParameter($this, "il_hform_node", "");

                    $a_tpl->setCurrentBlock("menu_cmd");
                    $a_tpl->setVariable("TXT_MENU_CMD", $menu_item["text"]);
                    $a_tpl->setVariable("URL_MENU_CMD", $url);
                    $a_tpl->parseCurrentBlock();
                }
            }

            $a_tpl->setCurrentBlock("drop_area");
            include_once "Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php";
            $a_tpl->setVariable("ICON_ADD", ilGlyphGUI::get(ilGlyphGUI::ADD));
            $a_tpl->setVariable("DROP_ID", $a_id);
            $a_tpl->parseCurrentBlock();
        } elseif ($a_menu) {
            // question action menu
            foreach ($a_menu as $mcnt => $menu_item) {
                $ilCtrl->setParameter($this, "il_hform_node", $node_id);
                $ilCtrl->setParameter($this, "il_hform_subcmd", $menu_item["cmd"]);
                $url = $ilCtrl->getLinkTarget($this, "renderPage");
                $ilCtrl->setParameter($this, "il_hform_subcmd", "");
                $ilCtrl->setParameter($this, "il_hform_node", "");

                $a_tpl->setCurrentBlock("action_cmd");
                $a_tpl->setVariable("TXT_ACTION_CMD", $menu_item["text"]);
                $a_tpl->setVariable("URL_ACTION_CMD", $url);
                $a_tpl->parseCurrentBlock();
            }
        }
        
        // add heading to content
        if ($a_content !== null &&
            $a_type == "question" &&
            $a_heading) {
            $a_content = "<div class=\"questionheading\">" . $a_heading . "</div>" .
                $a_content;
        }
        
        if ($a_menu) {
            $a_tpl->setVariable("TXT_NODE_CONTENT_ACTIONS", $a_content);
        } else {
            $a_tpl->setVariable("TXT_NODE_CONTENT_NO_ACTIONS", $a_content);
        }

        if ($a_content !== null) {
            $drag = "";
            $selectable = false;
            switch ($a_type) {
                case "block":
                    $caption = $lng->txt("questionblock");
                    break;

                case "question":
                    $caption = $lng->txt("question") . ": " . $a_subtitle;
                    $drag = "_drag";
                    $selectable = true;
                    break;

                case "heading":
                    $caption = $lng->txt("heading");
                    break;

                default:
                    return;
            }

            if ($a_status) {
                $caption .= " (" . $a_status . ")";
            }

            $a_tpl->setCurrentBlock("list_item");
            $a_tpl->setVariable("NODE_ID", $node_id);
            $a_tpl->setVariable("NODE_DRAG", $drag);
            $a_tpl->setVariable("TXT_NODE_TYPE", $caption);
            if ($selectable) {
                $a_tpl->setVariable("SELECTABLE", " selectable");
            }
            $a_tpl->parseCurrentBlock();
        }
        
        $a_tpl->touchBlock("element");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderToolbar()

ilSurveyPageGUI::renderToolbar (   $a_pages )

protected

Render toolbar form.

Parameters

array

$a_pages

Definition at line 1213 of file class.ilSurveyPageGUI.php.

References $ctrl, $ilCtrl, $ilUser, $lng, $si, $toolbar, $url, $user, ilLinkButton\getInstance(), and object.

Referenced by renderPage().

    {
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
        
        include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";

        if (!$this->has_datasets) {
            $button = ilLinkButton::getInstance();
            $button->setCaption("survey_add_new_question");
            $button->setUrl($ilCtrl->getLinkTarget($this, "addQuestionToolbarForm"));
            $ilToolbar->addStickyItem($button);

            if ($this->object->isPoolActive()) {
                //$ilToolbar->addSeparator();

                $last_on_page = 0;
                if ($a_pages &&
                    is_array($a_pages[$this->current_page-1])) {
                    $last_on_page = $a_pages[$this->current_page-1];
                    $last_on_page = array_pop($last_on_page);
                    $last_on_page = $last_on_page["question_id"];
                }

                $ilCtrl->setParameter($this->editor_gui, "pgov", $this->current_page);
                $ilCtrl->setParameter($this->editor_gui, "pgov_pos", $last_on_page . "c");

                $cmd = ($ilUser->getPref('svy_insert_type') == 1 ||
                    strlen($ilUser->getPref('svy_insert_type')) == 0)
                    ? 'browseForQuestions'
                    : 'browseForQuestionblocks';
                                
                $button = ilLinkButton::getInstance();
                $button->setCaption("browse_for_questions");
                $button->setUrl($ilCtrl->getLinkTarget($this->editor_gui, $cmd));
                $ilToolbar->addStickyItem($button);
                
                $ilCtrl->setParameter($this->editor_gui, "pgov", "");
                $ilCtrl->setParameter($this->editor_gui, "pgov_pos", "");
            }
            
            if ($a_pages) {
                $ilToolbar->addSeparator();
            }
        }
        
        // parse data for pages drop-down
        if ($a_pages) {
            // previous/next
            
            $ilCtrl->setParameter($this, "pg", $this->current_page-1);
            $button = ilLinkButton::getInstance();
            $button->setCaption("survey_prev_question");
            if ($this->has_previous_page) {
                $button->setUrl($ilCtrl->getLinkTarget($this, "renderPage"));
            }
            $button->setDisabled(!$this->has_previous_page);
            $ilToolbar->addStickyItem($button);
            
            $ilCtrl->setParameter($this, "pg", $this->current_page+1);
            $button = ilLinkButton::getInstance();
            $button->setCaption("survey_next_question");
            if ($this->has_next_page) {
                $button->setUrl($ilCtrl->getLinkTarget($this, "renderPage"));
            }
            $button->setDisabled(!$this->has_next_page);
            $ilToolbar->addStickyItem($button);
            
            $ilCtrl->setParameter($this, "pg", $this->current_page); // #14615
            
            foreach ($a_pages as $idx => $questions) {
                $page = $questions;
                $page = array_shift($page);
                if ($page["questionblock_id"]) {
                    $pages_drop[$idx+1] = $page["questionblock_title"];

                    if (sizeof($questions) > 1) {
                        foreach ($questions as $question) {
                            $pages_drop[($idx+1) . "__" . $question["question_id"]] = "- " . $question["title"];
                        }
                    }
                } else {
                    $pages_drop[$idx+1] = strip_tags($page["title"]);
                }
            }
        }

        // jump to page
        if (is_array($pages_drop) && count($pages_drop) > 1) {
            //$ilToolbar->addSeparator();

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

            include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
            $si = new ilSelectInputGUI($lng->txt("survey_jump_to"), "jump");
            $si->addCustomAttribute("onChange=\"forms['ilToolbar'].submit();\"");
            $si->setOptions($pages_drop);
            $si->setValue($this->current_page);
            $ilToolbar->addInputItem($si, true);

            // we need this to have to right cmd
            $cmd = new ilHiddenInputGUI("cmd[renderPage]");
            $cmd->setValue("1");
            $ilToolbar->addInputItem($cmd);
        
            if (!$this->has_datasets) {
                $ilToolbar->addSeparator();
                
                $ilCtrl->setParameter($this, "csum", md5(print_r($a_pages[$this->current_page-1], true)));
                $url = $ilCtrl->getLinkTarget($this, "deleteBlock");
                $ilCtrl->setParameter($this, "csum", "");
                
                $button = ilLinkButton::getInstance();
                $button->setCaption("survey_delete_page");
                $button->setUrl($url);
                $ilToolbar->addButtonInstance($button);
                
                $ilToolbar->addSeparator();
                
                $button = ilLinkButton::getInstance();
                $button->setCaption("survey_move_page");
                $button->setUrl($ilCtrl->getLinkTarget($this, "movePageForm"));
                $ilToolbar->addButtonInstance($button);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

splitPage()

ilSurveyPageGUI::splitPage (   $a_id )

protected

Split current page in 2 pages.

Parameters

int

$a_id

Definition at line 870 of file class.ilSurveyPageGUI.php.

References $source, array, and getAutoBlockTitle().

    {
        $pages = $this->object->getSurveyPages();
        $source = $pages[$this->current_page-1];

        $block_questions = array();
        $add = $block_id = false;
        foreach ($source as $idx => $item) {
            if ($item["question_id"] == $a_id) {
                $block_id = $item["questionblock_id"];
                $add = $idx;
            }
            if ($add) {
                $block_questions[] = $item["question_id"];
            }
        }

        // just 1 question left: block is obsolete
        if ($add == 1) {
            $this->object->unfoldQuestionblocks(array($block_id));
        }
        // remove questions from block
        else {
            foreach ($block_questions as $qid) {
                $this->object->removeQuestionFromBlock($qid, $block_id);
            }
        }

        // more than 1 moved?
        if (sizeof($block_questions) > 1) {
            // create new block and move target questions
            $this->object->createQuestionblock(
                $this->getAutoBlockTitle(),
                true,
                false,
                $block_questions
            );
        }
        
        $this->current_page++;
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilSurveyPageGUI::$ctrl

protected

Definition at line 19 of file class.ilSurveyPageGUI.php.

Referenced by addPoolQuestion(), addQuestion(), addQuestionToolbar(), addQuestionToolbarForm(), confirmRemoveQuestions(), deleteBlock(), deleteQuestion(), editQuestion(), executeCommand(), getPageNodes(), movePage(), movePageForm(), renderPage(), renderPageNode(), and renderToolbar().

$current_page

ilSurveyPageGUI::$current_page

protected

Definition at line 55 of file class.ilSurveyPageGUI.php.

Referenced by determineCurrentPage(), executeCommand(), and moveNext().

$db

ilSurveyPageGUI::$db

protected

Definition at line 29 of file class.ilSurveyPageGUI.php.

Referenced by appendNewQuestionToSurvey(), and insertNewQuestion().

$editor_gui

ilSurveyPageGUI::$editor_gui

protected

Definition at line 54 of file class.ilSurveyPageGUI.php.

$has_datasets

ilSurveyPageGUI::$has_datasets

protected

Definition at line 58 of file class.ilSurveyPageGUI.php.

$has_next_page

ilSurveyPageGUI::$has_next_page

protected

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

$has_previous_page

ilSurveyPageGUI::$has_previous_page

protected

Definition at line 56 of file class.ilSurveyPageGUI.php.

$lng

ilSurveyPageGUI::$lng

protected

Definition at line 52 of file class.ilSurveyPageGUI.php.

Referenced by addQuestionToolbar(), addQuestionToolbarForm(), copyQuestion(), cutQuestion(), deleteBlock(), executeCommand(), getAutoBlockTitle(), getPageNodes(), insertNewQuestion(), movePage(), movePageForm(), multiCopy(), multiCut(), renderPage(), renderPageNode(), and renderToolbar().

$log

ilSurveyPageGUI::$log

protected

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

$object

ilSurveyPageGUI::$object

protected

Definition at line 53 of file class.ilSurveyPageGUI.php.

$rbacsystem

ilSurveyPageGUI::$rbacsystem

protected

Definition at line 24 of file class.ilSurveyPageGUI.php.

Referenced by executeCommand(), insertNewQuestion(), and renderPage().

$ref_id

ilSurveyPageGUI::$ref_id

protected

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

Referenced by clearClipboard(), copyQuestion(), cutQuestion(), multiCopy(), multiCut(), and paste().

$tabs

ilSurveyPageGUI::$tabs

protected

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

Referenced by addQuestion(), and callEditor().

$toolbar

ilSurveyPageGUI::$toolbar

protected

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

Referenced by renderToolbar().

$tpl

ilSurveyPageGUI::$tpl

protected

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

Referenced by addQuestionToolbarForm(), movePageForm(), and renderPage().

$use_pool

ilSurveyPageGUI::$use_pool

protected

Definition at line 59 of file class.ilSurveyPageGUI.php.

$user

ilSurveyPageGUI::$user

protected

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

Referenced by addPoolQuestion(), and renderToolbar().

---

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

• Modules/Survey/classes/class.ilSurveyPageGUI.php