ilLMObjectGUI Class Reference

Base class for ilStructureObjects and ilPageObjects (see ILIAS DTD) More...

Inheritance diagram for ilLMObjectGUI:

Collaboration diagram for ilLMObjectGUI:

Public Member Functions
	__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...

Data Fields
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilLMObject	$obj
ilCtrl	$ctrl
ilObjLearningModule	$content_object
array	$actions

Protected Attributes
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

Base class for ilStructureObjects and ilPageObjects (see ILIAS DTD)

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 26 of file class.ilLMObjectGUI.php.

Constructor & Destructor Documentation

__construct()

ilLMObjectGUI::__construct

(

ilObjLearningModule

$a_content_obj

)

constructor

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

References $DIC, $lng, XapiProxy\$req, $request, $tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

    {
        global $DIC;

        $tpl = $DIC["tpl"];
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();

        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->ctrl = $ilCtrl;
        $this->content_object = $a_content_obj;
        $this->ui = $DIC->ui();
        $this->request = $DIC
            ->learningModule()
            ->internal()
            ->gui()
            ->editing()
            ->request();
        $req = $this->request;

        $this->requested_ref_id = $req->getRefId();
        $this->requested_obj_id = $req->getObjId();
        $this->requested_transl = $req->getTranslation();
        $this->requested_totransl = $req->getToTranslation();
        $this->requested_target = $req->getTarget();
        $this->requested_new_type = $req->getNewType();
    }

Here is the call graph for this function:

Member Function Documentation

cancelDelete()

ilLMObjectGUI::cancelDelete

(

)

cancel deletion of page/structure objects

Definition at line 194 of file class.ilLMObjectGUI.php.

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

                                  : void
    {
        ilSession::clear("saved_post");
        $this->ctrl->redirect($this, $this->request->getBackCmd());
    }

Here is the call graph for this function:

checkTree()

ilLMObjectGUI::checkTree

(

)

check the content object tree

Definition at line 244 of file class.ilLMObjectGUI.php.

Referenced by ilStructureObjectGUI\save().

                               : void
    {
        $this->content_object->checkTree();
    }

Here is the caller graph for this function:

confirmedDelete()

ilLMObjectGUI::confirmedDelete

(

)

page and structure object deletion

Definition at line 204 of file class.ilLMObjectGUI.php.

References ilObjContentObjectGUI\confirmedDelete(), and ILIAS\Repository\ctrl().

                                     : void
    {
        $cont_obj_gui = new ilObjLearningModuleGUI(
            "",
            $this->content_object->getRefId(),
            true,
            false
        );
        $cont_obj_gui->confirmedDelete($this->obj->getId());
        $this->ctrl->redirect($this, $this->request->getBackCmd());
    }

Here is the call graph for this function:

create()

ilLMObjectGUI::create

(

)

structure / page object creation form

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

References getCreateForm().

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

Here is the call graph for this function:

delete()

ilLMObjectGUI::delete

(

)

Confirm deletion screen (delete page or structure objects)

Definition at line 177 of file class.ilLMObjectGUI.php.

References ilObjContentObjectGUI\delete().

                            : void
    {
        $this->setTabs();

        $cont_obj_gui = new ilObjLearningModuleGUI(
            "",
            $this->content_object->getRefId(),
            true,
            false
        );
        $cont_obj_gui->delete($this->obj->getId());
    }

Here is the call graph for this function:

getCreateForm()

ilLMObjectGUI::getCreateForm

(

)

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

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

Referenced by create(), and ilStructureObjectGUI\save().

                                   : ilPropertyFormGUI
    {
        $new_type = $this->requested_new_type;
        $this->ctrl->setParameter($this, "new_type", $new_type);
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "save"));
        $form->setTitle($this->lng->txt($new_type . "_new"));

        $title = new ilTextInputGUI($this->lng->txt("title"), "title");
        $form->addItem($title);

        $desc = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
        $form->addItem($desc);

        $form->addCommandButton("save", $this->lng->txt($new_type . "_add"));
        $form->addCommandButton("cancel", $this->lng->txt("cancel"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTargetFrame()

ilLMObjectGUI::getTargetFrame	(	string	$a_cmd,
		string	$a_target_frame = ""
	)

get target frame for command (command is method name without "Object", e.g.

"perm")

Parameters

string	$a_cmd	command
string	$a_target_frame	default target frame (is returned, if no special target frame was set)

Definition at line 100 of file class.ilLMObjectGUI.php.

     : string {
        if ($this->target_frame[$a_cmd] != "") {
            return $this->target_frame[$a_cmd];
        } elseif (!empty($a_target_frame)) {
            return "target=\"" . $a_target_frame . "\"";
        } else {
            return "";
        }
    }

putInTree()

ilLMObjectGUI::putInTree

(

?int

$target = 0

)

put this object into content object tree

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

References $requested_target, and ilTree\POS_FIRST_NODE.

                                               : void
    {
        if ($target == 0) {
            $target = $this->requested_target;
        }
        $tree = new ilTree($this->content_object->getId());
        $tree->setTableNames('lm_tree', 'lm_data');
        $tree->setTreeTablePK("lm_id");

        $parent_id = ($this->requested_obj_id > 0)
            ? $this->requested_obj_id
            : $tree->getRootId();

        if ($target == "") {
            // determine last child of current type
            $childs = $tree->getChildsByType($parent_id, $this->obj->getType());
            if (count($childs) == 0) {
                $target = ilTree::POS_FIRST_NODE;
            } else {
                $target = $childs[count($childs) - 1]["obj_id"];
            }
        }
        if (!$tree->isInTree($this->obj->getId())) {
            $tree->insertNode($this->obj->getId(), $parent_id, $target);
        }
    }

setActions()

ilLMObjectGUI::setActions

(

?array

$a_actions = null

)

Parameters

?array

$a_actions action array (key = action key, value = action language string)

Definition at line 82 of file class.ilLMObjectGUI.php.

References $name.

                                                        : void
    {
        if (is_array($a_actions)) {
            foreach ($a_actions as $name => $lng) {
                $this->actions[$name] = array("name" => $name, "lng" => $lng);
            }
        } else {
            $this->actions = [];
        }
    }

showActions()

ilLMObjectGUI::showActions

(

array

$a_actions

)

show possible action (form buttons)

Definition at line 219 of file class.ilLMObjectGUI.php.

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

Referenced by ilStructureObjectGUI\subchap().

                                                 : void
    {
        $d = [];
        foreach ($a_actions as $name => $lng) {
            $d[$name] = array("name" => $name, "lng" => $lng);
        }

        $operations = $d;
        if (count($operations) > 0) {
            foreach ($operations as $val) {
                $this->tpl->setCurrentBlock("operation_btn");
                $this->tpl->setVariable("BTN_NAME", $val["name"]);
                $this->tpl->setVariable("BTN_VALUE", $this->lng->txt($val["lng"]));
                $this->tpl->parseCurrentBlock();
            }

            $this->tpl->setCurrentBlock("operation");
            $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.svg"));
            $this->tpl->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$actions

array ilLMObjectGUI::$actions

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

$content_object

ilObjLearningModule ilLMObjectGUI::$content_object

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

Referenced by ilLMPageObjectGUI\getLinkXML().

$ctrl

ilCtrl ilLMObjectGUI::$ctrl

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

Referenced by ilLMPageObjectGUI\_goto(), ilStructureObjectGUI\_goto(), ilLMPageObjectGUI\addPageTabs(), ilStructureObjectGUI\copyItems(), ilLMPageObjectGUI\create(), ilStructureObjectGUI\cutItems(), ilLMPageObjectGUI\editLayout(), ilStructureObjectGUI\editMasterLanguage(), ilLMPageObjectGUI\executeCommand(), ilLMPageObjectGUI\initEditLayoutForm(), ilStructureObjectGUI\initInsertTemplateForm(), ilLMPageObjectGUI\initNewPageForm(), ilStructureObjectGUI\initSetPageLayoutForm(), ilStructureObjectGUI\insertChapter(), ilStructureObjectGUI\insertChapterClip(), ilStructureObjectGUI\insertPage(), ilStructureObjectGUI\insertPageClip(), ilStructureObjectGUI\insertPageFromTemplate(), ilStructureObjectGUI\insertTemplate(), ilStructureObjectGUI\proceedDragDrop(), ilStructureObjectGUI\saveAllTitles(), ilLMPageObjectGUI\saveLayout(), ilStructureObjectGUI\savePageLayout(), ilStructureObjectGUI\setPageLayout(), ilStructureObjectGUI\showHierarchy(), ilStructureObjectGUI\subchap(), and ilStructureObjectGUI\switchToLanguage().

$lng

ilLanguage ilLMObjectGUI::$lng

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

Referenced by __construct(), ilLMPageObjectGUI\_goto(), ilStructureObjectGUI\_goto(), ilStructureObjectGUI\activatePages(), ilStructureObjectGUI\copyItems(), ilLMPageObjectGUI\create(), ilStructureObjectGUI\cutItems(), ilLMPageObjectGUI\initEditLayoutForm(), ilStructureObjectGUI\initInsertTemplateForm(), ilLMPageObjectGUI\initNewPageForm(), ilStructureObjectGUI\initSetPageLayoutForm(), ilStructureObjectGUI\insertChapter(), ilStructureObjectGUI\insertPage(), ilStructureObjectGUI\insertTemplate(), ilLMPageObjectGUI\save(), ilLMPageObjectGUI\saveLayout(), ilStructureObjectGUI\savePageLayout(), ilStructureObjectGUI\setPageLayout(), ilStructureObjectGUI\setTabs(), and ilStructureObjectGUI\showHierarchy().

$obj

ilLMObject ilLMObjectGUI::$obj

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

Referenced by ilLMPageObjectGUI\editLayout(), and ilLMPageObjectGUI\executeCommand().

$request

EditingGUIRequest ilLMObjectGUI::$request

protected

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

Referenced by __construct(), ilStructureObjectGUI\proceedDragDrop(), and ilLMPageObjectGUI\save().

$requested_new_type

string ilLMObjectGUI::$requested_new_type

protected

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

Referenced by getCreateForm().

$requested_obj_id

int ilLMObjectGUI::$requested_obj_id

protected

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

$requested_ref_id

int ilLMObjectGUI::$requested_ref_id

protected

Definition at line 28 of file class.ilLMObjectGUI.php.

Referenced by ilLMPageObjectGUI\executeCommand().

$requested_target

string ilLMObjectGUI::$requested_target

protected

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

Referenced by putInTree(), and ilStructureObjectGUI\putInTree().

$requested_totransl

string ilLMObjectGUI::$requested_totransl = ""

protected

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

$requested_transl

string ilLMObjectGUI::$requested_transl = ""

protected

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

Referenced by ilLMPageObjectGUI\executeCommand(), and ilStructureObjectGUI\showHierarchy().

$target_frame

array ilLMObjectGUI::$target_frame

protected

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

$tpl

ilGlobalTemplateInterface ilLMObjectGUI::$tpl

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

Referenced by __construct(), ilLMPageObjectGUI\editLayout(), ilLMPageObjectGUI\executeCommand(), ilLMPageObjectGUI\saveLayout(), and ilStructureObjectGUI\setPageLayout().

$ui

ILIAS DI UIServices ilLMObjectGUI::$ui

protected

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

Referenced by ilLMPageObjectGUI\create(), ilStructureObjectGUI\initInsertTemplateForm(), ilLMPageObjectGUI\initNewPageForm(), and ilStructureObjectGUI\insertTemplate().

---

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

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