ilStructureObjectGUI Class Reference

User Interface for Structure Objects Editing. More...

Inheritance diagram for ilStructureObjectGUI:

Collaboration diagram for ilStructureObjectGUI:

Public Member Functions
	__construct (ilObjLearningModule $a_content_obj, ilLMTree $a_tree)
	setStructureObject (ilStructureObject $a_st_object)
	getType ()
	executeCommand ()
	create ()
	structure / page object creation form More...
	edit ()
	view ()
	showHierarchy ()
	cutItems (string $a_return="view")
	Copy items to clipboard, then cut them from the current tree. More...
	copyItems (string $a_return="view")
	Copy items to clipboard. More...
	saveAllTitles ()
	Save all titles of chapters/pages. More...
	subchap ()
	display subchapters of structure object More...
	save ()
	putInTree (?int $target=null)
	put chapter into tree More...
	cutPage ()
	copyPage ()
	pastePage ()
	cutChapter ()
	copyChapter ()
	copy a single chapter (selection) More...
	pasteChapter ()
	activatePages ()
	initConditionHandlerInterface ()
	cancel ()
	cancel creation of new page or chapter More...
	setTabs ()
	insertChapter (bool $a_as_sub=false)
	Insert (multiple) chapters at node. More...
	insertSubchapter ()
	Insert (multiple) subchapters at node. More...
	insertChapterClip (bool $a_as_sub=false, string $a_return="view")
	Insert Chapter from clipboard. More...
	insertSubchapterClip ()
	insertPage ()
	insertPageClip ()
	proceedDragDrop ()
	setPageLayout ()
	Set layout for multipl pages. More...
	initSetPageLayoutForm ()
	Init set page layout form. More...
	savePageLayout ()
	Save page layout. More...
	editMasterLanguage ()
	switchToLanguage ()
	insertTemplate ()
	Displays GUI to select template for page. More...
	initInsertTemplateForm ()
	insertPageFromTemplate ()
	Insert (multiple) pages templates at node. More...
Public Member Functions inherited from ilLMObjectGUI
	__construct (ilObjLearningModule $a_content_obj)
	constructor More...
	setActions (?array $a_actions=null)
	getTargetFrame (string $a_cmd, string $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	create ()
	structure / page object creation form More...
	getCreateForm ()
	putInTree (?int $target=0)
	put this object into content object tree More...
	delete ()
	Confirm deletion screen (delete page or structure objects) More...
	cancelDelete ()
	cancel deletion of page/structure objects More...
	confirmedDelete ()
	page and structure object deletion More...
	showActions (array $a_actions)
	show possible action (form buttons) More...
	checkTree ()
	check the content object tree More...

Static Public Member Functions
static	_goto (string $a_target, int $a_target_ref_id=0)

Data Fields
ilLMTree	$tree
Data Fields inherited from ilLMObjectGUI
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilLMObject	$obj
ilCtrl	$ctrl
ilObjLearningModule	$content_object
array	$actions

Protected Attributes
ilPropertyFormGUI	$form
ilConditionHandlerGUI	$condHI
ilObjUser	$user
ilTabsGUI	$tabs
ilLogger	$log
Protected Attributes inherited from ilLMObjectGUI
int	$requested_ref_id
ILIAS DI UIServices	$ui
int	$requested_obj_id
string	$requested_totransl = ""
string	$requested_transl = ""
string	$requested_target
string	$requested_new_type
array	$target_frame
EditingGUIRequest	$request

Detailed Description

User Interface for Structure Objects Editing.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilStructureObjectGUI: ilConditionHandlerGUI, ilObjectMetaDataGUI

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

Constructor & Destructor Documentation

__construct()

ilStructureObjectGUI::__construct	(	ilObjLearningModule	$a_content_obj,
		ilLMTree	$a_tree
	)

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

      {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->tabs = $DIC->tabs();
        $this->log = $DIC["ilLog"];
        $this->tpl = $DIC->ui()->mainTemplate();
        parent::__construct($a_content_obj);
        $this->tree = $a_tree;
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilStructureObjectGUI::_goto ( string  $a_target, int  $a_target_ref_id = 0  )

static

Exceptions

ilPermissionException

Definition at line 560 of file class.ilStructureObjectGUI.php.

     : void {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
 
        $lng = $DIC->language();
        $ilAccess = $DIC->access();
        $ctrl = $DIC->ctrl();
 
        // determine learning object
        $lm_id = ilLMObject::_lookupContObjID($a_target);
 
        // get all references
        $ref_ids = ilObject::_getAllReferences($lm_id);
 
        // always try passed ref id first
        if (in_array($a_target_ref_id, $ref_ids)) {
            $ref_ids = array_merge(array($a_target_ref_id), $ref_ids);
        }
 
        // check read permissions
        foreach ($ref_ids as $ref_id) {
            // Permission check
            if ($ilAccess->checkAccess("read", "", $ref_id)) {
                $ctrl->setParameterByClass("ilLMPresentationGUI", "obj_id", $a_target);
                $ctrl->setParameterByClass("ilLMPresentationGUI", "ref_id", $ref_id);
                $ctrl->redirectByClass("ilLMPresentationGUI", "");
            }
        }
 
        if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage('failure', sprintf(
                $lng->txt("msg_no_perm_read_item"),
                ilObject::_lookupTitle($lm_id)
            ), true);
            ilObjectGUI::_gotoRepositoryRoot();
        }
 
        throw new ilPermissionException($lng->txt("msg_no_perm_read_lm"));
    }

activatePages()

ilStructureObjectGUI::activatePages

(

)

Definition at line 428 of file class.ilStructureObjectGUI.php.

                                   : void
    {
        $lng = $this->lng;
 
        $ids = $this->request->getIds();
        if (count($ids) > 0) {
            $act_items = array();
            // get all "top" ids, i.e. remove ids, that have a selected parent
            foreach ($ids as $id) {
                $path = $this->tree->getPathId($id);
                $take = true;
                foreach ($path as $path_id) {
                    if ($path_id != $id && in_array($path_id, $ids)) {
                        $take = false;
                    }
                }
                if ($take) {
                    $act_items[] = $id;
                }
            }
 
 
            foreach ($act_items as $id) {
                $childs = $this->tree->getChilds($id);
                foreach ($childs as $child) {
                    if (ilLMObject::_lookupType($child["child"]) == "pg") {
                        $act = ilLMPage::_lookupActive(
                            $child["child"],
                            $this->content_object->getType()
                        );
                        ilLMPage::_writeActive(
                            $child["child"],
                            $this->content_object->getType(),
                            !$act
                        );
                    }
                }
                if (ilLMObject::_lookupType($id) == "pg") {
                    $act = ilLMPage::_lookupActive(
                        $id,
                        $this->content_object->getType()
                    );
                    ilLMPage::_writeActive(
                        $id,
                        $this->content_object->getType(),
                        !$act
                    );
                }
            }
        } else {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
        }
 
        $this->ctrl->redirect($this, "view");
    }

References $id, $lng, $path, ilPageObject\_lookupActive(), ilLMObject\_lookupType(), ilPageObject\_writeActive(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

cancel()

ilStructureObjectGUI::cancel

(

)

cancel creation of new page or chapter

Definition at line 499 of file class.ilStructureObjectGUI.php.

                            : void
    {
        if ($this->requested_obj_id != 0) {
            if ($this->requested_new_type == "pg") {
                $this->ctrl->redirect($this, "view");
            } else {
                $this->ctrl->redirect($this, "subchap");
            }
        }
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

copyChapter()

ilStructureObjectGUI::copyChapter

(

)

copy a single chapter (selection)

Definition at line 418 of file class.ilStructureObjectGUI.php.

                                 : void
    {
        $this->copyItems("subchap");
    }

copyItems()

ilStructureObjectGUI::copyItems

(

string

$a_return = "view"

)

Copy items to clipboard.

Definition at line 201 of file class.ilStructureObjectGUI.php.

     : void {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $items = $this->request->getIds();
        if (count($items) == 0) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "showHierarchy");
        }
 
        $todel = array();                               // delete IDs < 0 (needed for non-js editing)
        foreach ($items as $k => $item) {
            if ($item < 0) {
                $todel[] = $k;
            }
        }
        foreach ($todel as $k) {
            unset($items[$k]);
        }
 
        if (!ilLMObject::uniqueTypesCheck($items)) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("cont_choose_pages_or_chapters_only"), true);
            $ilCtrl->redirect($this, "showHierarchy");
        }
 
        ilLMObject::clipboardCopy($this->content_object->getId(), $items);
        ilEditClipboard::setAction("copy");
 
        $this->tpl->setOnScreenMessage('info', $lng->txt("cont_selected_items_have_been_copied"), true);
        $ilCtrl->redirect($this, $a_return);
    }

References $lng.

copyPage()

ilStructureObjectGUI::copyPage

(

)

Definition at line 394 of file class.ilStructureObjectGUI.php.

                              : void
    {
        $this->copyItems();
    }

create()

ilStructureObjectGUI::create

(

)

structure / page object creation form

Reimplemented from ilLMObjectGUI.

Definition at line 104 of file class.ilStructureObjectGUI.php.

                            : void
    {
        if ($this->requested_obj_id != 0) {
            $this->setTabs();
        }
        parent::create();
    }

cutChapter()

ilStructureObjectGUI::cutChapter

(

)

Definition at line 410 of file class.ilStructureObjectGUI.php.

                                : void
    {
        $this->cutItems("subchap");
    }

cutItems()

ilStructureObjectGUI::cutItems

(

string

$a_return = "view"

)

Copy items to clipboard, then cut them from the current tree.

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

     : void {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $items = $this->request->getIds();
        if (count($items) == 0) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "showHierarchy");
        }
 
        $todel = array();                       // delete IDs < 0 (needed for non-js editing)
        foreach ($items as $k => $item) {
            if ($item < 0) {
                $todel[] = $k;
            }
        }
        foreach ($todel as $k) {
            unset($items[$k]);
        }
 
        if (!ilLMObject::uniqueTypesCheck($items)) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("cont_choose_pages_or_chapters_only"), true);
            $ilCtrl->redirect($this, "showHierarchy");
        }
 
        ilLMObject::clipboardCut($this->content_object->getId(), $items);
        ilEditClipboard::setAction("cut");
        $this->tpl->setOnScreenMessage('info', $lng->txt("cont_selected_items_have_been_cut"), true);
 
        $ilCtrl->redirect($this, $a_return);
    }

References $lng.

cutPage()

ilStructureObjectGUI::cutPage

(

)

Definition at line 389 of file class.ilStructureObjectGUI.php.

                             : void
    {
        $this->cutItems();
    }

edit()

ilStructureObjectGUI::edit

(

)

Definition at line 112 of file class.ilStructureObjectGUI.php.

                          : void
    {
        $this->view();
    }

editMasterLanguage()

ilStructureObjectGUI::editMasterLanguage

(

)

Definition at line 894 of file class.ilStructureObjectGUI.php.

                                        : void
    {
        $ilCtrl = $this->ctrl;
 
        $ilCtrl->setParameter($this, "transl", "-");
        $ilCtrl->redirect($this, "showHierarchy");
    }

executeCommand()

ilStructureObjectGUI::executeCommand

(

)

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            case 'ilobjectmetadatagui':
 
                $this->setTabs();
 
                $md_gui = new ilObjectMetaDataGUI($this->content_object, $this->obj->getType(), $this->obj->getId());
                $md_gui->addMDObserver($this->obj, 'MDUpdateListener', 'General');
                $md_gui->addMDObserver($this->obj, 'MDUpdateListener', 'Educational'); // #9510
                $this->ctrl->forwardCommand($md_gui);
                break;
 
            case "ilconditionhandlergui":
                $ilTabs = $this->tabs;
 
                $this->setTabs();
                $this->initConditionHandlerInterface();
                $this->ctrl->forwardCommand($this->condHI);
                $ilTabs->setTabActive('preconditions');
                break;
 
            default:
                if ($cmd == 'listConditions') {
                    $this->setTabs();
                    $this->initConditionHandlerInterface();
                    $this->condHI->executeCommand();
                } elseif (($cmd == "create") && ($this->requested_new_type == "pg")) {
                    $this->setTabs();
                    $pg_gui = new ilLMPageObjectGUI($this->content_object);
                    $pg_gui->executeCommand();
                } else {
                    $this->$cmd();
                }
                break;
        }
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

getType()

ilStructureObjectGUI::getType

(

)

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

                             : string
    {
        return "st";
    }

initConditionHandlerInterface()

ilStructureObjectGUI::initConditionHandlerInterface

(

)

Definition at line 484 of file class.ilStructureObjectGUI.php.

                                                   : void
    {
        $this->condHI = new ilConditionHandlerGUI();
        $this->condHI->setBackButtons(array());
        $this->condHI->setAutomaticValidation(false);
        $this->condHI->setTargetType("st");
        $this->condHI->setTargetRefId($this->content_object->getRefId());
        $this->condHI->setTargetId($this->obj->getId());
        $this->condHI->setTargetTitle($this->obj->getTitle());
    }

initInsertTemplateForm()

ilStructureObjectGUI::initInsertTemplateForm

(

)

Definition at line 932 of file class.ilStructureObjectGUI.php.

                                            : Form\Standard
    {
        $ui = $this->ui;
        $f = $ui->factory();
        $ctrl = $this->ctrl;
        $lng = $this->lng;
 
        $fields["title"] = $f->input()->field()->text($lng->txt("title"), "");
        $ts = ilPageLayoutGUI::getTemplateSelection(ilPageLayout::MODULE_LM);
        if (!is_null($ts)) {
            $fields["layout_id"] = $ts;
        }
 
        // section
        $section1 = $f->input()->field()->section($fields, $lng->txt("cont_insert_pagelayout"));
 
        $form_action = $ctrl->getLinkTarget($this, "insertPageFromTemplate");
        return $f->input()->container()->form()->standard($form_action, ["sec" => $section1]);
    }

References Vendor\Package\$f, $lng, and ilPageLayout\MODULE_LM.

initSetPageLayoutForm()

ilStructureObjectGUI::initSetPageLayoutForm

(

)

Init set page layout form.

Definition at line 845 of file class.ilStructureObjectGUI.php.

                                           : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $this->form = new ilPropertyFormGUI();
 
        $ids = $this->request->getIds();
        foreach ($ids as $id) {
            $hi = new ilHiddenInputGUI("id[]");
            $hi->setValue($id);
            $this->form->addItem($hi);
        }
        $layout = ilObjContentObjectGUI::getLayoutOption(
            $lng->txt("cont_layout"),
            "layout",
            $this->content_object->getLayout()
        );
 
        $this->form->addItem($layout);
 
        $this->form->addCommandButton("savePageLayout", $lng->txt("save"));
        $this->form->addCommandButton("showHierarchy", $lng->txt("cancel"));
 
        $this->form->setTitle($lng->txt("cont_set_layout"));
        $this->form->setFormAction($ilCtrl->getFormAction($this));
    }

References $id, $lng, ILIAS\Repository\form(), and ilObjContentObjectGUI\getLayoutOption().

Here is the call graph for this function:

insertChapter()

ilStructureObjectGUI::insertChapter

(

bool

$a_as_sub = false

)

Insert (multiple) chapters at node.

Definition at line 606 of file class.ilStructureObjectGUI.php.

     : void {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $num = ilChapterHierarchyFormGUI::getPostMulti();
        $node_id = ilChapterHierarchyFormGUI::getPostNodeId();
 
        if ($a_as_sub) {                // as subchapter
            if (!ilChapterHierarchyFormGUI::getPostFirstChild()) {      // insert under parent
                $parent_id = $node_id;
                $target = "";
            } else {                                                                                                    // we shouldnt end up here
                $ilCtrl->redirect($this, "showHierarchy");
                return;
            }
        } else {                                // as chapter
            if (!ilChapterHierarchyFormGUI::getPostFirstChild()) {      // insert after node id
                $parent_id = $this->tree->getParentId($node_id);
                $target = $node_id;
            } else {                                                                                                    // insert as first child
                $parent_id = $node_id;
                $target = ilTree::POS_FIRST_NODE;
            }
        }
        for ($i = 1; $i <= $num; $i++) {
            $chap = new ilStructureObject($this->content_object);
            $chap->setType("st");
            $chap->setTitle($lng->txt("cont_new_chap"));
            $chap->setLMId($this->content_object->getId());
            $chap->create();
            ilLMObject::putInTree($chap, (int) $parent_id, (int) $target);
        }
 
        $ilCtrl->redirect($this, "view");
    }

insertChapterClip()

ilStructureObjectGUI::insertChapterClip	(	bool	$a_as_sub = false,
		string	$a_return = "view"
	)

Insert Chapter from clipboard.

Definition at line 655 of file class.ilStructureObjectGUI.php.

     : void {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $ilLog = $this->log;
 
        $ilLog->write("Insert Chapter From Clipboard");
 
 
        $node_id = ilChapterHierarchyFormGUI::getPostNodeId();
        $first_child = ilChapterHierarchyFormGUI::getPostFirstChild();
 
        if ($a_as_sub) {                // as subchapter
            if (!$first_child) {        // insert under parent
                $parent_id = $node_id;
                $target = "";
            } else {                                                                                                    // we shouldnt end up here
                $ilCtrl->redirect($this, "showHierarchy");
                return;
            }
        } else {        // as chapter
            if (!$first_child) {        // insert after node id
                $parent_id = $this->tree->getParentId($node_id);
                $target = $node_id;
            } else {                                                                                                    // insert as first child
                $parent_id = $node_id;
                $target = ilTree::POS_FIRST_NODE;
 
                // do not move a chapter in front of a page
                $childs = $this->tree->getChildsByType($parent_id, "pg");
                if (count($childs) != 0) {
                    $target = $childs[count($childs) - 1]["obj_id"];
                }
            }
        }
 
        // copy and paste
        $chapters = $ilUser->getClipboardObjects("st", true);
        $copied_nodes = array();
 
        foreach ($chapters as $chap) {
            $ilLog->write("Call pasteTree, Target LM: " . $this->content_object->getId() . ", Chapter ID: " . $chap["id"]
                . ", Parent ID: " . $parent_id . ", Target: " . $target);
            $cid = ilLMObject::pasteTree(
                $this->content_object,
                $chap["id"],
                $parent_id,
                (int) $target,
                (string) ($chap["insert_time"] ?? ""),
                $copied_nodes,
                (ilEditClipboard::getAction() == "copy")
            );
            $target = $cid;
        }
        ilLMObject::updateInternalLinks($copied_nodes);
 
        if (ilEditClipboard::getAction() == "cut") {
            $ilUser->clipboardDeleteObjectsOfType("pg");
            $ilUser->clipboardDeleteObjectsOfType("st");
            ilEditClipboard::clear();
        }
 
        $this->content_object->checkTree();
        $ilCtrl->redirect($this, $a_return);
    }

insertPage()

ilStructureObjectGUI::insertPage

(

)

Definition at line 728 of file class.ilStructureObjectGUI.php.

                                : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $num = ilChapterHierarchyFormGUI::getPostMulti();
        $node_id = ilChapterHierarchyFormGUI::getPostNodeId();
 
        if (!ilChapterHierarchyFormGUI::getPostFirstChild()) {  // insert after node id
            $parent_id = $this->tree->getParentId($node_id);
            $target = $node_id;
        } else {                                                                                                        // insert as first child
            $parent_id = $node_id;
            $target = ilTree::POS_FIRST_NODE;
        }
 
        for ($i = 1; $i <= $num; $i++) {
            $page = new ilLMPageObject($this->content_object);
            $page->setType("pg");
            $page->setTitle($lng->txt("cont_new_page"));
            $page->setLMId($this->content_object->getId());
            $page->create();
            ilLMObject::putInTree($page, $parent_id, $target);
        }
 
        if ($num == 1) {
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("lm_page_added"), true);
        } else {
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("lm_pages_added"), true);
        }
 
        $ilCtrl->redirect($this, "showHierarchy");
    }

References $i, $lng, ilHierarchyFormGUI\getPostFirstChild(), ilHierarchyFormGUI\getPostMulti(), ilHierarchyFormGUI\getPostNodeId(), ILIAS\Repository\lng(), ilTree\POS_FIRST_NODE, and ilLMObject\putInTree().

Here is the call graph for this function:

insertPageClip()

ilStructureObjectGUI::insertPageClip

(

)

Definition at line 762 of file class.ilStructureObjectGUI.php.

                                    : void
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        $node_id = ilChapterHierarchyFormGUI::getPostNodeId();
        $first_child = ilChapterHierarchyFormGUI::getPostFirstChild();
 
        if (!$first_child) {    // insert after node id
            $parent_id = $this->tree->getParentId($node_id);
            $target = $node_id;
        } else {                                                                                                        // insert as first child
            $parent_id = $node_id;
            $target = ilTree::POS_FIRST_NODE;
        }
 
        // cut and paste
        $pages = $ilUser->getClipboardObjects("pg");
        $copied_nodes = array();
        foreach ($pages as $pg) {
            $cid = ilLMObject::pasteTree(
                $this->content_object,
                $pg["id"],
                $parent_id,
                $target,
                (string) ($pg["insert_time"] ?? ""),
                $copied_nodes,
                (ilEditClipboard::getAction() == "copy")
            );
            $target = $cid;
        }
        ilLMObject::updateInternalLinks($copied_nodes);
 
        if (ilEditClipboard::getAction() == "cut") {
            $ilUser->clipboardDeleteObjectsOfType("pg");
            $ilUser->clipboardDeleteObjectsOfType("st");
            ilEditClipboard::clear();
        }
 
        $ilCtrl->redirect($this, "view");
    }

References $ilUser, ilEditClipboard\clear(), ilEditClipboard\getAction(), ilHierarchyFormGUI\getPostFirstChild(), ilHierarchyFormGUI\getPostNodeId(), ilTree\POS_FIRST_NODE, and ilLMObject\updateInternalLinks().

Here is the call graph for this function:

insertPageFromTemplate()

ilStructureObjectGUI::insertPageFromTemplate

(

)

Insert (multiple) pages templates at node.

Definition at line 955 of file class.ilStructureObjectGUI.php.

                                            : void
    {
        global $DIC;
 
        $ilCtrl = $this->ctrl;
 
        $form = $this->initInsertTemplateForm();
        $form = $form->withRequest($DIC->http()->request());
        $data = $form->getData();
        $layout_id = $data["sec"]["layout_id"];
        $node_id = $this->request->getNodeId();
        $page_ids = ilLMPageObject::insertPagesFromTemplate(
            $this->content_object->getId(),
            $this->request->getMulti(),
            $node_id,
            $this->request->getFirstChild(),
            $layout_id,
            $data["sec"]["title"]
        );
 
        if ($this->request->getMulti() <= 1) {
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("lm_page_added"), true);
        } else {
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("lm_pages_added"), true);
        }
 
        //$ilCtrl->setParameter($this, "highlight", $page_ids);
        $ilCtrl->redirect($this, "showHierarchy", "node_" . $node_id);
    }

References $data, $DIC, ilLMPageObject\insertPagesFromTemplate(), and ILIAS\Repository\lng().

Here is the call graph for this function:

insertSubchapter()

ilStructureObjectGUI::insertSubchapter

(

)

Insert (multiple) subchapters at node.

Definition at line 647 of file class.ilStructureObjectGUI.php.

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

insertSubchapterClip()

ilStructureObjectGUI::insertSubchapterClip

(

)

Definition at line 723 of file class.ilStructureObjectGUI.php.

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

insertTemplate()

ilStructureObjectGUI::insertTemplate

(

)

Displays GUI to select template for page.

Definition at line 913 of file class.ilStructureObjectGUI.php.

                                    : void
    {
        $ctrl = $this->ctrl;
        $ui = $this->ui;
        $lng = $this->lng;
 
        $this->setTabs();
        $tabs = $this->tabs;
        $tabs->clearTargets();
        $tabs->setBackTarget($lng->txt("back"), $ctrl->getLinkTarget($this, "showHierarchy"));
 
        $ctrl->setParameter($this, "multi", ilChapterHierarchyFormGUI::getPostMulti());
        $ctrl->setParameter($this, "node_id", ilChapterHierarchyFormGUI::getPostNodeId());
        $ctrl->setParameter($this, "first_child", (int) ilChapterHierarchyFormGUI::getPostFirstChild());
        $ctrl->saveParameter($this, "obj_id");
        $form = $this->initInsertTemplateForm();
        $this->tpl->setContent($ui->renderer()->render($form) . ilLMPageObjectGUI::getLayoutCssFix());
    }

References $lng, ilTabsGUI\clearTargets(), ilLMPageObjectGUI\getLayoutCssFix(), ilHierarchyFormGUI\getPostFirstChild(), ilHierarchyFormGUI\getPostMulti(), ilHierarchyFormGUI\getPostNodeId(), and ilTabsGUI\setBackTarget().

Here is the call graph for this function:

pasteChapter()

ilStructureObjectGUI::pasteChapter

(

)

Definition at line 423 of file class.ilStructureObjectGUI.php.

                                  : void
    {
        $this->insertChapterClip(false, "subchap");
    }

pastePage()

ilStructureObjectGUI::pastePage

(

)

Definition at line 399 of file class.ilStructureObjectGUI.php.

                               : void
    {
        $ilUser = $this->user;
 
        if (!$ilUser->clipboardHasObjectsOfType("pg")) {
            throw new ilLMException($this->lng->txt("no_page_in_clipboard"));
        }
 
        $this->insertPageClip();
    }

References $ilUser, and ILIAS\Repository\lng().

Here is the call graph for this function:

proceedDragDrop()

ilStructureObjectGUI::proceedDragDrop

(

)

Definition at line 804 of file class.ilStructureObjectGUI.php.

                                     : void
    {
        $ilCtrl = $this->ctrl;
 
        $req = $this->request;
        $this->content_object->executeDragDrop(
            $req->getHFormPar("source_id"),
            $req->getHFormPar("target_id"),
            $req->getHFormPar("fc"),
            $req->getHFormPar("as_subitem")
        );
        $ilCtrl->redirect($this, "showHierarchy");
    }

References XapiProxy\$req.

putInTree()

ilStructureObjectGUI::putInTree

(

?int

$target = null

)

put chapter into tree

Reimplemented from ilLMObjectGUI.

Definition at line 359 of file class.ilStructureObjectGUI.php.

     : void {
        $target = $this->requested_target;
        //echo "st:putInTree";
        // chapters should be behind pages in the tree
        // so if target is first node, the target is substituted with
        // the last child of type pg
        if ($target == ilTree::POS_FIRST_NODE) {
            $tree = new ilTree($this->content_object->getId());
            $tree->setTableNames('lm_tree', 'lm_data');
            $tree->setTreeTablePK("lm_id");
 
            // determine parent node id
            $parent_id = ($this->requested_obj_id > 0)
                ? $this->requested_obj_id
                : $tree->getRootId();
            // determine last child of type pg
            $childs = $tree->getChildsByType($parent_id, "pg");
            if (count($childs) != 0) {
                $target = $childs[count($childs) - 1]["obj_id"];
            }
        }
        if ($target == "") {
            $target = ilTree::POS_LAST_NODE;
        }
 
        parent::putInTree($target);
    }

References ilTree\getChildsByType(), ilTree\getRootId(), ilTree\setTableNames(), and ilTree\setTreeTablePK().

Here is the call graph for this function:

save()

ilStructureObjectGUI::save

(

)

Definition at line 333 of file class.ilStructureObjectGUI.php.

                          : void
    {
        $form = $this->getCreateForm();
 
        if ($form->checkInput()) {
            $this->obj = new ilStructureObject($this->content_object);
            $this->obj->setType("st");
            $this->obj->setTitle($form->getInput("title"));
            $this->obj->setDescription($form->getInput("desc"));
            $this->obj->setLMId($this->content_object->getId());
            $this->obj->create();
 
            $this->putInTree();
 
            // check the tree
            $this->checkTree();
        }
 
        if ($this->requested_obj_id > 0) {
            $this->ctrl->redirect($this, "subchap");
        }
    }

References ilPropertyFormGUI\checkInput(), ILIAS\Repository\ctrl(), and ilPropertyFormGUI\getInput().

Here is the call graph for this function:

saveAllTitles()

ilStructureObjectGUI::saveAllTitles

(

)

Save all titles of chapters/pages.

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

                                   : void
    {
        $ilCtrl = $this->ctrl;
 
        $titles = $this->request->getTitles();
        ilLMObject::saveTitles($this->content_object, $titles, $this->requested_transl);
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("lm_save_titles"), true);
        $ilCtrl->redirect($this, "showHierarchy");
    }

References ILIAS\Repository\lng(), and ilLMObject\saveTitles().

Here is the call graph for this function:

savePageLayout()

ilStructureObjectGUI::savePageLayout

(

)

Save page layout.

Definition at line 876 of file class.ilStructureObjectGUI.php.

                                    : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $ids = $this->request->getIds();
        $layout = $this->request->getLayout();
        foreach ($ids as $id) {
            ilLMPageObject::writeLayout(
                $id,
                $layout,
                $this->content_object
            );
        }
        $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        $ilCtrl->redirect($this, "showHierarchy");
    }

References $id, $lng, and ilLMObject\writeLayout().

Here is the call graph for this function:

setPageLayout()

ilStructureObjectGUI::setPageLayout

(

)

Set layout for multipl pages.

Definition at line 825 of file class.ilStructureObjectGUI.php.

                                   : void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $ids = $this->request->getIds();
        if (count($ids) == 0) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "showHierarchy");
        }
 
        $this->initSetPageLayoutForm();
 
        $tpl->setContent($this->form->getHTML());
    }

References $lng, $tpl, and ILIAS\Repository\form().

Here is the call graph for this function:

setStructureObject()

ilStructureObjectGUI::setStructureObject

(

ilStructureObject

$a_st_object

)

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

     : void {
        $this->obj = $a_st_object;
    }

setTabs()

ilStructureObjectGUI::setTabs

(

)

Definition at line 510 of file class.ilStructureObjectGUI.php.

                             : void
    {
        $ilTabs = $this->tabs;
        $lng = $this->lng;
 
        // subelements
        $ilTabs->addTarget(
            "cont_pages_and_subchapters",
            $this->ctrl->getLinkTarget($this, 'showHierarchy'),
            array("view", "showHierarchy"),
            get_class($this)
        );
 
        // preconditions
        $ilTabs->addTarget(
            "preconditions",
            $this->ctrl->getLinkTarget($this, 'listConditions'),
            "listConditions",
            get_class($this)
        );
 
        // metadata
        $mdgui = new ilObjectMetaDataGUI($this->content_object, $this->obj->getType(), $this->obj->getId());
        $mdtab = $mdgui->getTab();
        if ($mdtab) {
            $ilTabs->addTarget(
                "meta_data",
                $mdtab,
                "",
                "ilmdeditorgui"
            );
        }
 
        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_st.svg"));
        $this->tpl->setTitle(
            $this->lng->txt($this->obj->getType()) . ": " . $this->obj->getTitle()
        );
 
        // presentation view
        $ilTabs->addNonTabbedLink(
            "pres_mode",
            $lng->txt("cont_presentation_view"),
            ILIAS_HTTP_PATH . "/goto.php?target=st_" . $this->obj->getId(),
            "_top"
        );
    }

References $lng, ILIAS\Repository\ctrl(), ilUtil\getImagePath(), and ILIAS\Repository\lng().

Here is the call graph for this function:

showHierarchy()

ilStructureObjectGUI::showHierarchy

(

)

Definition at line 122 of file class.ilStructureObjectGUI.php.

                                   : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $this->setTabs();
 
        $ilCtrl->setParameter($this, "backcmd", "showHierarchy");
 
        $form_gui = new ilChapterHierarchyFormGUI($this->content_object->getType(), $this->requested_transl);
        $form_gui->setFormAction($ilCtrl->getFormAction($this));
        $form_gui->setTitle($this->obj->getTitle());
        $form_gui->setIcon(ilUtil::getImagePath("icon_st.svg"));
        $form_gui->setTree($this->tree);
        $form_gui->setCurrentTopNodeId($this->obj->getId());
        $form_gui->addMultiCommand($lng->txt("delete"), "delete");
        $form_gui->addMultiCommand($lng->txt("cut"), "cutItems");
        $form_gui->addMultiCommand($lng->txt("copy"), "copyItems");
        $form_gui->addMultiCommand($lng->txt("cont_de_activate"), "activatePages");
        if ($this->content_object->getLayoutPerPage()) {
            $form_gui->addMultiCommand($lng->txt("cont_set_layout"), "setPageLayout");
        }
        $form_gui->setDragIcon(ilUtil::getImagePath("icon_pg.svg"));
        $form_gui->addCommand($lng->txt("cont_save_all_titles"), "saveAllTitles");
        $form_gui->addHelpItem($lng->txt("cont_chapters_after_pages"));
        $up_gui = "ilobjlearningmodulegui";
        $ilCtrl->setParameterByClass($up_gui, "active_node", $this->obj->getId());
        $ilCtrl->setParameterByClass($up_gui, "active_node", null);
 
        $ctpl = new ilTemplate("tpl.chap_and_pages.html", true, true, "Modules/LearningModule");
        $ctpl->setVariable("HIERARCHY_FORM", $form_gui->getHTML());
        $ilCtrl->setParameter($this, "obj_id", $this->requested_obj_id);
 
        $ml_head = ilObjContentObjectGUI::getMultiLangHeader($this->content_object->getId(), $this);
 
        $this->tpl->setContent($ml_head . $ctpl->get());
        $this->tpl->addOnloadCode("window.setTimeout(() => { $('body').trigger('il-lm-editor-tree'); }, 500);");
    }

References $lng, ilUtil\getImagePath(), and ilObjContentObjectGUI\getMultiLangHeader().

Here is the call graph for this function:

subchap()

ilStructureObjectGUI::subchap

(

)

display subchapters of structure object

Definition at line 252 of file class.ilStructureObjectGUI.php.

                             : void
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        $this->setTabs();
 
        $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.structure_edit.html", "Modules/LearningModule");
        $num = 0;
 
        $this->tpl->setCurrentBlock("form");
        $this->ctrl->setParameter($this, "backcmd", "subchap");
        $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
        $this->tpl->setVariable("HEADER_TEXT", $this->lng->txt("cont_subchapters"));
        $this->tpl->setVariable("CHECKBOX_TOP", ilTree::POS_FIRST_NODE);
 
        $cnt = 0;
        $childs = $this->tree->getChilds($this->obj->getId());
        foreach ($childs as $child) {
            if ($child["type"] != "st") {
                continue;
            }
            $this->tpl->setCurrentBlock("table_row");
 
            // checkbox
            $this->tpl->setVariable("CHECKBOX_ID", $child["obj_id"]);
            $this->tpl->setVariable("IMG_OBJ", ilUtil::getImagePath("icon_st.svg"));
 
            // type
            $this->ctrl->setParameterByClass("ilStructureObjectGUI", "obj_id", $child["obj_id"]);
            $link = $this->ctrl->getLinkTargetByClass("ilStructureObjectGUI", "view");
            $this->tpl->setVariable("LINK_TARGET", $link);
 
            // title
            $this->tpl->setVariable(
                "TEXT_CONTENT",
                ilStructureObject::_getPresentationTitle(
                    $child["obj_id"],
                    ilLMObject::CHAPTER_TITLE,
                    $this->content_object->isActiveNumbering()
                )
            );
 
            $this->tpl->parseCurrentBlock();
            $cnt++;
        }
 
        if ($cnt == 0) {
            $this->tpl->setCurrentBlock("notfound");
            $this->tpl->setVariable("NUM_COLS", 3);
            $this->tpl->setVariable("TXT_OBJECT_NOT_FOUND", $this->lng->txt("obj_not_found"));
            $this->tpl->parseCurrentBlock();
        }
        //else
        //{
        // SHOW VALID ACTIONS
        $this->tpl->setVariable("NUM_COLS", 3);
        $acts = array("delete" => "delete", "cutChapter" => "cut",
                "copyChapter" => "copyChapter");
        if ($ilUser->clipboardHasObjectsOfType("st")) {
            $acts["pasteChapter"] = "pasteChapter";
        }
        $this->showActions($acts);
        //}
 
        // SHOW POSSIBLE SUB OBJECTS
        $this->tpl->setVariable("NUM_COLS", 3);
        $subobj = array("st");
        $opts = ilLegacyFormElementsUtil::formSelect(12, "new_type", $subobj);
        $this->tpl->setCurrentBlock("add_object");
        $this->tpl->setVariable("SELECT_OBJTYPE", $opts);
        $this->tpl->setVariable("BTN_NAME", "create");
        $this->tpl->setVariable("TXT_ADD", $this->lng->txt("insert"));
        $this->tpl->parseCurrentBlock();
 
        $this->tpl->setCurrentBlock("form");
        $this->tpl->parseCurrentBlock();
 
        $ilCtrl->setParameter($this, "obj_id", $this->requested_obj_id);
    }

References $ilUser, ilStructureObject\_getPresentationTitle(), ilLMObject\CHAPTER_TITLE, ILIAS\Repository\ctrl(), ilLegacyFormElementsUtil\formSelect(), ilUtil\getImagePath(), ILIAS\Repository\lng(), and ilTree\POS_FIRST_NODE.

Here is the call graph for this function:

switchToLanguage()

ilStructureObjectGUI::switchToLanguage

(

)

Definition at line 902 of file class.ilStructureObjectGUI.php.

                                      : void
    {
        $ilCtrl = $this->ctrl;
 
        $ilCtrl->setParameter($this, "transl", $this->requested_totransl);
        $ilCtrl->redirect($this, "showHierarchy");
    }

view()

ilStructureObjectGUI::view

(

)

Definition at line 117 of file class.ilStructureObjectGUI.php.

                          : void
    {
        $this->showHierarchy();
    }

Field Documentation

$condHI

ilConditionHandlerGUI ilStructureObjectGUI::$condHI

protected

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

$form

ilPropertyFormGUI ilStructureObjectGUI::$form

protected

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

$log

ilLogger ilStructureObjectGUI::$log

protected

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

$tabs

ilTabsGUI ilStructureObjectGUI::$tabs

protected

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

$tree

ilLMTree ilStructureObjectGUI::$tree

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

$user

ilObjUser ilStructureObjectGUI::$user

protected

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

---

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

• Modules/LearningModule/classes/class.ilStructureObjectGUI.php