ilStructureObjectGUI Class Reference

Class ilStructureObjectGUI. More...

Inheritance diagram for ilStructureObjectGUI:

Collaboration diagram for ilStructureObjectGUI:

Public Member Functions
	__construct (&$a_content_obj, &$a_tree)
	Constructor @access public. More...
	setStructureObject (&$a_st_object)
	set structure object More...
	getType ()
	this function is called by condition handler gui interface More...
	executeCommand ()
	execute command More...
	create ()
	create new page or chapter in chapter More...
	edit ()
	view ()
	showHierarchy ()
	Show subhiearchy of pages and subchapters. More...
	cutItems ($a_return="view")
	Copy items to clipboard, then cut them from the current tree. More...
	copyItems ($a_return="view")
	Copy items to clipboard. More...
	saveAllTitles ()
	Save all titles of chapters/pages. More...
	subchap ()
	add_cell ($val, $link="")
	output a cell in object list More...
	save ()
	save new chapter More...
	putInTree ()
	put chapter into tree More...
	cutPage ()
	cut page More...
	copyPage ()
	copy page More...
	pastePage ()
	paste page More...
	cutChapter ()
	Cut chapter(s) More...
	copyChapter ()
	copy a single chapter (selection) More...
	pasteChapter ()
	paste chapter More...
	activatePages ()
	activates or deactivates pages More...
	initConditionHandlerInterface ()
	cancel ()
	cancel creation of new page or chapter More...
	setTabs ()
	output tabs More...
	insertChapter ($a_as_sub=false)
	Insert (multiple) chapters at node. More...
	insertSubchapter ()
	Insert (multiple) subchapters at node. More...
	insertChapterClip ($a_as_sub=false, $a_return="view")
	Insert Chapter from clipboard. More...
	insertSubchapterClip ()
	Insert Chapter from clipboard. More...
	insertPage ()
	Insert (multiple) pages at node. More...
	insertPageClip ()
	Insert pages from clipboard. More...
	proceedDragDrop ()
	Perform drag and drop action. More...
	setPageLayout ()
	Set layout for multipl pages. More...
	initSetPageLayoutForm ()
	Init set page layout form. More...
	savePageLayout ()
	Save page layout. More...
	editMasterLanguage ()
	Edit master language. More...
	switchToLanguage ()
	Switch to language. More...
	insertTemplate ()
	Displays GUI to select template for page. More...
	initInsertTemplateForm ()
	Init insert template form. More...
	insertPageFromTemplate ()
	Insert (multiple) pages templates at node. More...
Public Member Functions inherited from ilLMObjectGUI
	__construct (&$a_content_obj)
	constructor More...
	setActions ($a_actions="")
	build action array More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	create ()
	structure / page object creation form More...
	putInTree ()
	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...
	add_cell ($val, $link="")
	output a cell in object list More...
	showActions ($a_actions)
	show possible action (form buttons) More...
	checkTree ()
	check the content object tree More...

Static Public Member Functions
static	_goto ($a_target, $a_target_ref_id="")
	redirect script More...

Data Fields
	$obj
	$tree
Data Fields inherited from ilLMObjectGUI
	$tpl
	$lng
	$obj
	$ctrl
	$content_object
	$actions

Protected Attributes
	$user
	$error
	$tabs
	$log
Protected Attributes inherited from ilLMObjectGUI
	$ui

Detailed Description

Class ilStructureObjectGUI.

User Interface for Structure Objects Editing

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

@ilCtrl_Calls ilStructureObjectGUI: ilConditionHandlerGUI, ilObjectMetaDataGUI

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

Constructor & Destructor Documentation

__construct()

ilStructureObjectGUI::__construct	(	&	$a_content_obj,
		&	$a_tree
	)

Constructor @access public.

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), error(), and user().

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilStructureObjectGUI::_goto (   $a_target,   $a_target_ref_id = ""  )

static

redirect script

Parameters

string

$a_target

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

    {
        global $DIC;
 
        $rbacsystem = $DIC->rbac()->system();
        $ilErr = $DIC["ilErr"];
        $lng = $DIC->language();
        $ilAccess = $DIC->access();
 
        // 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)) {
                // don't redirect anymore, just set parameters
                // (goto.php includes  "ilias.php")
                $_GET["baseClass"] = "ilLMPresentationGUI";
                $_GET["obj_id"] = $a_target;
                $_GET["ref_id"] = $ref_id;
                include_once("ilias.php");
                exit;
                ;
            }
        }
        
        if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            ilUtil::sendFailure(sprintf(
                $lng->txt("msg_no_perm_read_item"),
                ilObject::_lookupTitle($lm_id)
            ), true);
            ilObjectGUI::_gotoRepositoryRoot();
        }
 
        $ilErr->raiseError($lng->txt("msg_no_perm_read_lm"), $ilErr->FATAL);
    }

References $_GET, $DIC, $ilErr, ilLMObjectGUI\$lng, ilObject\_getAllReferences(), ilObjectGUI\_gotoRepositoryRoot(), ilLMObject\_lookupContObjID(), ilObject\_lookupTitle(), exit, ROOT_FOLDER_ID, and ilUtil\sendFailure().

Here is the call graph for this function:

activatePages()

ilStructureObjectGUI::activatePages

(

)

activates or deactivates pages

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

    {
        $lng = $this->lng;
        
        if (is_array($_POST["id"])) {
            $act_items = array();
            // get all "top" ids, i.e. remove ids, that have a selected parent
            foreach ($_POST["id"] as $id) {
                $path = $this->tree->getPathId($id);
                $take = true;
                foreach ($path as $path_id) {
                    if ($path_id != $id && in_array($path_id, $_POST["id"])) {
                        $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 {
            ilUtil::sendFailure($lng->txt("no_checkbox"), true);
        }
        
        $this->ctrl->redirect($this, "view");
    }

References $_POST, ilLMObjectGUI\$lng, ilPageObject\_lookupActive(), ilLMObject\_lookupType(), ilPageObject\_writeActive(), and ilUtil\sendFailure().

Here is the call graph for this function:

add_cell()

ilStructureObjectGUI::add_cell	(		$val,
			$link = ""
	)

output a cell in object list

Reimplemented from ilLMObjectGUI.

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

    {
        if (!empty($link)) {
            $this->tpl->setCurrentBlock("begin_link");
            $this->tpl->setVariable("LINK_TARGET", $link);
            $this->tpl->parseCurrentBlock();
            $this->tpl->touchBlock("end_link");
        }
 
        $this->tpl->setCurrentBlock("text");
        $this->tpl->setVariable("TEXT_CONTENT", $val);
        $this->tpl->parseCurrentBlock();
        $this->tpl->setCurrentBlock("table_cell");
        $this->tpl->parseCurrentBlock();
    }

cancel()

ilStructureObjectGUI::cancel

(

)

cancel creation of new page or chapter

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

    {
        if ($_GET["obj_id"] != 0) {
            if ($_GET["new_type"] == "pg") {
                $this->ctrl->redirect($this, "view");
            } else {
                $this->ctrl->redirect($this, "subchap");
            }
        }
    }

References $_GET.

copyChapter()

ilStructureObjectGUI::copyChapter

(

)

copy a single chapter (selection)

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

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

References copyItems().

Here is the call graph for this function:

copyItems()

ilStructureObjectGUI::copyItems

(

$a_return = "view"

)

Copy items to clipboard.

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

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $items = ilUtil::stripSlashesArray($_POST["id"]);
        if (!is_array($items)) {
            ilUtil::sendFailure($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)) {
            ilUtil::sendFailure($lng->txt("cont_choose_pages_or_chapters_only"), true);
            $ilCtrl->redirect($this, "showHierarchy");
        }
 
        ilLMObject::clipboardCopy($this->content_object->getId(), $items);
        ilEditClipboard::setAction("copy");
        
        ilUtil::sendInfo($lng->txt("cont_selected_items_have_been_copied"), true);
        $ilCtrl->redirect($this, $a_return);
    }

References $_POST, ilLMObjectGUI\$ctrl, ilLMObjectGUI\$lng, ilLMObject\clipboardCopy(), ilUtil\sendFailure(), ilUtil\sendInfo(), ilEditClipboard\setAction(), ilUtil\stripSlashesArray(), and ilLMObject\uniqueTypesCheck().

Referenced by copyChapter(), and copyPage().

Here is the call graph for this function:

Here is the caller graph for this function:

copyPage()

ilStructureObjectGUI::copyPage

(

)

copy page

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

    {
        $this->copyItems();
    }

References copyItems().

Here is the call graph for this function:

create()

ilStructureObjectGUI::create

(

)

create new page or chapter in chapter

Reimplemented from ilLMObjectGUI.

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

    {
        if ($_GET["obj_id"] != "") {
            $this->setTabs();
        }
        parent::create();
    }

References $_GET, and setTabs().

Here is the call graph for this function:

cutChapter()

ilStructureObjectGUI::cutChapter

(

)

Cut chapter(s)

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

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

References cutItems().

Here is the call graph for this function:

cutItems()

ilStructureObjectGUI::cutItems

(

$a_return = "view"

)

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

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

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $items = ilUtil::stripSlashesArray($_POST["id"]);
        if (!is_array($items)) {
            ilUtil::sendFailure($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)) {
            ilUtil::sendFailure($lng->txt("cont_choose_pages_or_chapters_only"), true);
            $ilCtrl->redirect($this, "showHierarchy");
        }
 
        ilLMObject::clipboardCut($this->content_object->getId(), $items);
        ilEditClipboard::setAction("cut");
        //ilUtil::sendInfo($this->lng->txt("msg_cut_clipboard"), true);
        ilUtil::sendInfo($lng->txt("cont_selected_items_have_been_cut"), true);
 
        $ilCtrl->redirect($this, $a_return);
    }

References $_POST, ilLMObjectGUI\$ctrl, ilLMObjectGUI\$lng, ilLMObject\clipboardCut(), ilUtil\sendFailure(), ilUtil\sendInfo(), ilEditClipboard\setAction(), ilUtil\stripSlashesArray(), and ilLMObject\uniqueTypesCheck().

Referenced by cutChapter(), and cutPage().

Here is the call graph for this function:

Here is the caller graph for this function:

cutPage()

ilStructureObjectGUI::cutPage

(

)

cut page

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

    {
        $this->cutItems();
    }

References cutItems().

Here is the call graph for this function:

edit()

ilStructureObjectGUI::edit

(

)

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

    {
        $this->view();
    }

References view().

Here is the call graph for this function:

editMasterLanguage()

ilStructureObjectGUI::editMasterLanguage

(

)

Edit master language.

Parameters

return

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

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

References ilLMObjectGUI\$ctrl.

executeCommand()

ilStructureObjectGUI::executeCommand

(

)

execute command

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

    {
        //echo "<br>:cmd:".$this->ctrl->getCmd().":cmdClass:".$this->ctrl->getCmdClass().":";
        $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") && ($_POST["new_type"] == "pg")) {
                    $this->setTabs();
                    $pg_gui = new ilLMPageObjectGUI($this->content_object);
                    $pg_gui->executeCommand();
                } else {
                    $this->$cmd();
                }
                break;
        }
    }

References $_POST, $tabs, initConditionHandlerInterface(), and setTabs().

Here is the call graph for this function:

getType()

ilStructureObjectGUI::getType

(

)

this function is called by condition handler gui interface

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

    {
        return "st";
    }

initConditionHandlerInterface()

ilStructureObjectGUI::initConditionHandlerInterface

(

)

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

    {
        $this->condHI = new ilConditionHandlerGUI($this);
        $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());
    }

Referenced by executeCommand().

Here is the caller graph for this function:

initInsertTemplateForm()

ilStructureObjectGUI::initInsertTemplateForm

(

)

Init insert template form.

Returns

\ILIAS\UI\Component\Input\Container\Form\Standard

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

    {
        $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 ilLMObjectGUI\$ctrl, Vendor\Package\$f, ilLMObjectGUI\$lng, ilLMObjectGUI\$ui, and ilPageLayout\MODULE_LM.

Referenced by insertPageFromTemplate(), and insertTemplate().

Here is the caller graph for this function:

initSetPageLayoutForm()

ilStructureObjectGUI::initSetPageLayoutForm

(

)

Init set page layout form.

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
    
        $this->form = new ilPropertyFormGUI();
        
        if (is_array($_POST["id"])) {
            foreach ($_POST["id"] 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 $_POST, ilLMObjectGUI\$ctrl, ilLMObjectGUI\$lng, and ilObjContentObjectGUI\getLayoutOption().

Referenced by setPageLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

insertChapter()

ilStructureObjectGUI::insertChapter

(

$a_as_sub = false

)

Insert (multiple) chapters at node.

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

    {
        $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 = IL_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, $parent_id, $target);
        }
 
        $ilCtrl->redirect($this, "view");
    }

References ilLMObjectGUI\$ctrl, $i, ilLMObjectGUI\$lng, ilHierarchyFormGUI\getPostFirstChild(), ilHierarchyFormGUI\getPostMulti(), ilHierarchyFormGUI\getPostNodeId(), IL_FIRST_NODE, and ilLMObject\putInTree().

Referenced by insertSubchapter().

Here is the call graph for this function:

Here is the caller graph for this function:

insertChapterClip()

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

Insert Chapter from clipboard.

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

    {
        $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 = IL_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,
                $target,
                $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);
    }

References ilLMObjectGUI\$ctrl, $ilUser, $log, $user, ilEditClipboard\clear(), ilEditClipboard\getAction(), ilHierarchyFormGUI\getPostFirstChild(), ilHierarchyFormGUI\getPostNodeId(), IL_FIRST_NODE, ilLMObject\pasteTree(), and ilLMObject\updateInternalLinks().

Referenced by insertSubchapterClip(), and pasteChapter().

Here is the call graph for this function:

Here is the caller graph for this function:

insertPage()

ilStructureObjectGUI::insertPage

(

)

Insert (multiple) pages at node.

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

    {
        $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 = IL_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);
        }
 
        $ilCtrl->redirect($this, "showHierarchy");
    }

References ilLMObjectGUI\$ctrl, $i, ilLMObjectGUI\$lng, ilHierarchyFormGUI\getPostFirstChild(), ilHierarchyFormGUI\getPostMulti(), ilHierarchyFormGUI\getPostNodeId(), IL_FIRST_NODE, and ilLMObject\putInTree().

Here is the call graph for this function:

insertPageClip()

ilStructureObjectGUI::insertPageClip

(

)

Insert pages from clipboard.

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

    {
        $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 = IL_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,
                $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 ilLMObjectGUI\$ctrl, $ilUser, $user, ilEditClipboard\clear(), ilEditClipboard\getAction(), ilHierarchyFormGUI\getPostFirstChild(), ilHierarchyFormGUI\getPostNodeId(), IL_FIRST_NODE, ilLMObject\pasteTree(), and ilLMObject\updateInternalLinks().

Referenced by pastePage().

Here is the call graph for this function:

Here is the caller graph for this function:

insertPageFromTemplate()

ilStructureObjectGUI::insertPageFromTemplate

(

)

Insert (multiple) pages templates at node.

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

    {
        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 = $_REQUEST["node_id"];
        $page_ids = ilLMPageObject::insertPagesFromTemplate(
            $this->content_object->getId(),
            (int) $_REQUEST["multi"],
            $node_id,
            $_REQUEST["first_child"],
            $layout_id,
            $data["sec"]["title"]
        );
 
        $ilCtrl->setParameter($this, "highlight", $page_ids);
        $ilCtrl->redirect($this, "showHierarchy", "node_" . $node_id);
    }

References ilLMObjectGUI\$ctrl, $data, $DIC, initInsertTemplateForm(), and ilLMPageObject\insertPagesFromTemplate().

Here is the call graph for this function:

insertSubchapter()

ilStructureObjectGUI::insertSubchapter

(

)

Insert (multiple) subchapters at node.

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

    {
        $ilCtrl = $this->ctrl;
        
        $this->insertChapter(true);
    }

References ilLMObjectGUI\$ctrl, and insertChapter().

Here is the call graph for this function:

insertSubchapterClip()

ilStructureObjectGUI::insertSubchapterClip

(

)

Insert Chapter from clipboard.

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

    {
        $this->insertChapterClip(true);
    }

References insertChapterClip().

Here is the call graph for this function:

insertTemplate()

ilStructureObjectGUI::insertTemplate

(

)

Displays GUI to select template for page.

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

    {
        $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", ilChapterHierarchyFormGUI::getPostFirstChild());
        $ctrl->saveParameter($this, "obj_id");
        $form = $this->initInsertTemplateForm();
        $this->tpl->setContent($ui->renderer()->render($form) . ilLMPageObjectGUI::getLayoutCssFix());
    }

References ilLMObjectGUI\$ctrl, ilLMObjectGUI\$lng, $tabs, ilLMObjectGUI\$ui, ilLMPageObjectGUI\getLayoutCssFix(), ilHierarchyFormGUI\getPostFirstChild(), ilHierarchyFormGUI\getPostMulti(), ilHierarchyFormGUI\getPostNodeId(), initInsertTemplateForm(), and setTabs().

Here is the call graph for this function:

pasteChapter()

ilStructureObjectGUI::pasteChapter

(

)

paste chapter

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

    {
        $ilUser = $this->user;
        
        return $this->insertChapterClip(false, "subchap");
    }

References $ilUser, $user, and insertChapterClip().

Here is the call graph for this function:

pastePage()

ilStructureObjectGUI::pastePage

(

)

paste page

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

    {
        $ilUser = $this->user;
        $ilErr = $this->error;
        
        if (!$ilUser->clipboardHasObjectsOfType("pg")) {
            $ilErr->raiseError($this->lng->txt("no_page_in_clipboard"), $ilErr->MESSAGE);
        }
 
        return $this->insertPageClip();
    }

References $error, $ilErr, $ilUser, $user, and insertPageClip().

Here is the call graph for this function:

proceedDragDrop()

ilStructureObjectGUI::proceedDragDrop

(

)

Perform drag and drop action.

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

    {
        $ilCtrl = $this->ctrl;
 
        //echo "-".$_POST["il_hform_source_id"]."-".$_POST["il_hform_target_id"]."-".$_POST["il_hform_fc"]."-";
        $this->content_object->executeDragDrop(
            $_POST["il_hform_source_id"],
            $_POST["il_hform_target_id"],
            $_POST["il_hform_fc"],
            $_POST["il_hform_as_subitem"]
        );
        $ilCtrl->redirect($this, "showHierarchy");
    }

References $_POST, and ilLMObjectGUI\$ctrl.

putInTree()

ilStructureObjectGUI::putInTree

(

)

put chapter into tree

Reimplemented from ilLMObjectGUI.

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

    {
        //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 ($_GET["target"] == IL_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 = (!empty($_GET["obj_id"]))
                ? $_GET["obj_id"]
                : $tree->getRootId();
            // determine last child of type pg
            $childs = $tree->getChildsByType($parent_id, "pg");
            if (count($childs) != 0) {
                $_GET["target"] = $childs[count($childs) - 1]["obj_id"];
            }
        }
        if (empty($_GET["target"])) {
            $_GET["target"] = IL_LAST_NODE;
        }
 
        parent::putInTree();
    }

References $_GET, $tree, IL_FIRST_NODE, and IL_LAST_NODE.

Referenced by save().

Here is the caller graph for this function:

save()

ilStructureObjectGUI::save

(

)

save new chapter

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

    {
        $this->obj = new ilStructureObject($this->content_object);
 
        $this->obj->setType("st");
        $this->obj->setTitle(ilUtil::stripSlashes($_POST["Fobject"]["title"]));
        $this->obj->setDescription(ilUtil::stripSlashes($_POST["Fobject"]["desc"]));
        $this->obj->setLMId($this->content_object->getId());
        $this->obj->create();
 
        $this->putInTree();
 
        // check the tree
        $this->checkTree();
 
        if (!empty($_GET["obj_id"])) {
            $this->ctrl->redirect($this, "subchap");
        }
    }

References $_GET, $_POST, ilLMObjectGUI\checkTree(), putInTree(), and ilUtil\stripSlashes().

Here is the call graph for this function:

saveAllTitles()

ilStructureObjectGUI::saveAllTitles

(

)

Save all titles of chapters/pages.

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

    {
        $ilCtrl = $this->ctrl;
        
        ilLMObject::saveTitles($this->content_object, ilUtil::stripSlashesArray($_POST["title"]), $_GET["transl"]);
 
        ilUtil::sendSuccess($this->lng->txt("lm_save_titles"), true);
        $ilCtrl->redirect($this, "showHierarchy");
    }

References $_GET, $_POST, ilLMObjectGUI\$ctrl, ilLMObject\saveTitles(), and ilUtil\stripSlashesArray().

Here is the call graph for this function:

savePageLayout()

ilStructureObjectGUI::savePageLayout

(

)

Save page layout.

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        foreach ($_POST["id"] as $id) {
            $id = ilUtil::stripSlashes($id);
            ilLMPageObject::writeLayout(
                ilUtil::stripSlashes($id),
                ilUtil::stripSlashes($_POST["layout"]),
                $this->content_object
            );
        }
        ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
        $ilCtrl->redirect($this, "showHierarchy");
    }

References $_POST, ilLMObjectGUI\$ctrl, ilLMObjectGUI\$lng, ilUtil\stripSlashes(), and ilLMObject\writeLayout().

Here is the call graph for this function:

setPageLayout()

ilStructureObjectGUI::setPageLayout

(

)

Set layout for multipl pages.

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

    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        if (!is_array($_POST["id"])) {
            ilUtil::sendFailure($lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "showHierarchy");
        }
        
        $this->initSetPageLayoutForm();
        
        $tpl->setContent($this->form->getHTML());
    }

References $_POST, ilLMObjectGUI\$ctrl, ilLMObjectGUI\$lng, ilLMObjectGUI\$tpl, initSetPageLayoutForm(), and ilUtil\sendFailure().

Here is the call graph for this function:

setStructureObject()

ilStructureObjectGUI::setStructureObject

(

&

$a_st_object

)

set structure object

Parameters

object

$a_st_object

structure object

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

    {
        $this->obj = $a_st_object;
    }

setTabs()

ilStructureObjectGUI::setTabs

(

)

output tabs

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

    {
        $ilTabs = $this->tabs;
        $ilUser = $this->user;
        $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 $ilUser, ilLMObjectGUI\$lng, $tabs, $user, and ilUtil\getImagePath().

Referenced by create(), executeCommand(), insertTemplate(), showHierarchy(), and subchap().

Here is the call graph for this function:

Here is the caller graph for this function:

showHierarchy()

ilStructureObjectGUI::showHierarchy

(

)

Show subhiearchy of pages and subchapters.

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        $this->setTabs();
        
        $ilCtrl->setParameter($this, "backcmd", "showHierarchy");
        
        $form_gui = new ilChapterHierarchyFormGUI($this->content_object->getType(), $_GET["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", "");
 
        $ctpl = new ilTemplate("tpl.chap_and_pages.html", true, true, "Modules/LearningModule");
        $ctpl->setVariable("HIERARCHY_FORM", $form_gui->getHTML());
        $ilCtrl->setParameter($this, "obj_id", $_GET["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 $_GET, ilLMObjectGUI\$ctrl, ilLMObjectGUI\$lng, ilUtil\getImagePath(), ilObjContentObjectGUI\getMultiLangHeader(), and setTabs().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

subchap()

ilStructureObjectGUI::subchap

(

)

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

    {
        $tree = $this->tree;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $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", IL_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");
            // color changing
            $css_row = ilUtil::switchColor($cnt++, "tblrow1", "tblrow2");
 
            // checkbox
            $this->tpl->setVariable("CHECKBOX_ID", $child["obj_id"]);
            $this->tpl->setVariable("CSS_ROW", $css_row);
            $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();
        }
        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);
        //$this->showPossibleSubObjects("st");
        $subobj = array("st");
        $opts = ilUtil::formSelect(12, "new_type", $subobj);
        //$this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.svg"));
        $this->tpl->setCurrentBlock("add_object");
        $this->tpl->setVariable("SELECT_OBJTYPE", $opts);
        //$this->tpl->setVariable("FORMACTION_OBJ_ADD", "adm_object.php?cmd=create&ref_id=".$_GET["ref_id"]);
        $this->tpl->setVariable("BTN_NAME", "create");
        $this->tpl->setVariable("TXT_ADD", $this->lng->txt("insert"));
        $this->tpl->parseCurrentBlock();
 
        //$this->tpl->setVariable("NUM_COLS", 2);
        //$this->showPossibleSubObjects("st");
 
        $this->tpl->setCurrentBlock("form");
        $this->tpl->parseCurrentBlock();
 
        $ilCtrl->setParameter($this, "obj_id", $_GET["obj_id"]);
    }

References $_GET, ilLMObjectGUI\$ctrl, $ilUser, ilLMObjectGUI\$lng, $tree, $user, ilStructureObject\_getPresentationTitle(), ilLMObject\CHAPTER_TITLE, ilUtil\formSelect(), ilUtil\getImagePath(), IL_FIRST_NODE, setTabs(), ilLMObjectGUI\showActions(), and ilUtil\switchColor().

Here is the call graph for this function:

switchToLanguage()

ilStructureObjectGUI::switchToLanguage

(

)

Switch to language.

Parameters

return

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

    {
        $ilCtrl = $this->ctrl;
        
        $ilCtrl->setParameter($this, "transl", $_GET["totransl"]);
        $ilCtrl->redirect($this, "showHierarchy");
    }

References $_GET, and ilLMObjectGUI\$ctrl.

view()

ilStructureObjectGUI::view

(

)

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

    {
        $tree = $this->tree;
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $this->showHierarchy();
    }

References ilLMObjectGUI\$ctrl, $ilUser, ilLMObjectGUI\$lng, $tree, $user, and showHierarchy().

Referenced by edit().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$error

ilStructureObjectGUI::$error

protected

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

Referenced by pastePage().

$log

ilStructureObjectGUI::$log

protected

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

Referenced by insertChapterClip().

$obj

ilStructureObjectGUI::$obj

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

$tabs

ilStructureObjectGUI::$tabs

protected

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

Referenced by executeCommand(), insertTemplate(), and setTabs().

$tree

ilStructureObjectGUI::$tree

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

Referenced by putInTree(), subchap(), and view().

$user

ilStructureObjectGUI::$user

protected

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

Referenced by insertChapterClip(), insertPageClip(), pasteChapter(), pastePage(), setTabs(), subchap(), and view().

---

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

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