ilStructureObjectGUI Class Reference

ilStructureObjectGUI: ilConditionHandlerGUI, ilObjectMetaDataGUI ilStructureObjectGUI: ILIAS 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 ()
	edit ()
	view ()
	initConditionHandlerInterface ()
	cancel ()
	cancel creation of new page or chapter More...
	setTabs ()
	setPageLayout ()
	Set layout for multipl pages. More...
	initSetPageLayoutForm ()
	Init set page layout form. More...
	savePageLayout ()
	Save page layout. More...
	editMasterLanguage ()
	switchToLanguage ()
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 (array $ids)
	Confirm deletion screen (delete page or structure objects) More...
	setTabs ()
	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 Member Functions
	addSubTabs ($active="")

Protected Attributes
ILIAS LearningModule InternalDomainService	$domain
ILIAS LearningModule InternalGUIService	$gui
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

ilStructureObjectGUI: ilConditionHandlerGUI, ilObjectMetaDataGUI ilStructureObjectGUI: ILIAS

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

Constructor & Destructor Documentation

__construct()

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

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

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

      {
        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;
        $this->gui = $DIC->learningModule()->internal()->gui();
        $this->domain = $DIC->learningModule()->internal()->domain();
    }

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 240 of file class.ilStructureObjectGUI.php.

References ilLMObjectGUI\$ctrl, $DIC, ilLMObjectGUI\$lng, $ref_id, ilObject\_getAllReferences(), ilObjectGUI\_gotoRepositoryRoot(), ilLMObject\_lookupContObjID(), ilObject\_lookupTitle(), ilCtrl\redirectByClass(), ROOT_FOLDER_ID, ilCtrl\setParameterByClass(), and ilLanguage\txt().

Referenced by ILIAS\StaticURL\Handler\LegacyGotoHandler\handle().

     : 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"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addSubTabs()

ilStructureObjectGUI::addSubTabs (   $active = "" )

protected

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

References ilLMObjectGUI\$lng, $tabs, ILIAS\Repository\ctrl(), and ilLanguage\txt().

Referenced by executeCommand().

    {
        $ilTabs = $this->tabs;
        $lng = $this->lng;

        // content -> pages
        $this->ctrl->setParameterByClass(static::class, "sub_type", "pg");
        $ilTabs->addSubTab(
            "sub_pages",
            $lng->txt("cont_pages"),
            $this->ctrl->getLinkTargetByClass(EditSubObjectsGUI::class)
        );

        // chapters
        $this->ctrl->setParameterByClass(static::class, "sub_type", "st");
        $ilTabs->addSubTab(
            "sub_chapters",
            $lng->txt("cont_subchapters"),
            $this->ctrl->getLinkTargetByClass(EditSubObjectsGUI::class)
        );
        $ilTabs->activateSubTab($active);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancel()

ilStructureObjectGUI::cancel

(

)

cancel creation of new page or chapter

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

create()

ilStructureObjectGUI::create

(

)

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

References setTabs().

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

Here is the call graph for this function:

edit()

ilStructureObjectGUI::edit

(

)

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

References view().

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

Here is the call graph for this function:

editMasterLanguage()

ilStructureObjectGUI::editMasterLanguage

(

)

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

References ilLMObjectGUI\$ctrl, and ilCtrl\setParameter().

                                        : void
    {
        $ilCtrl = $this->ctrl;

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

Here is the call graph for this function:

executeCommand()

ilStructureObjectGUI::executeCommand

(

)

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

References ilLMObjectGUI\$content_object, $tabs, ilObjectMetaDataGUI\addMDObserver(), addSubTabs(), ILIAS\Repository\ctrl(), initConditionHandlerInterface(), ILIAS\Repository\lng(), setTabs(), and ILIAS\Repository\tabs().

                                    : 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;

            case strtolower(EditSubObjectsGUI::class):
                $this->setTabs();
                $this->tabs->activateTab("sub_pages");
                if ($this->request->getSubType() === "pg") {
                    $this->addSubTabs("sub_pages");
                    $table_title = $this->lng->txt("cont_pages");
                } else {
                    $this->addSubTabs("sub_chapters");
                    $table_title = $this->lng->txt("cont_subchapters");
                }
                $gui = $this->gui->editing()->editSubObjectsGUI(
                    $this->request->getSubType(),
                    $this->content_object,
                    $table_title
                );
                $this->ctrl->forwardCommand($gui);
                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;
        }
    }

Here is the call graph for this function:

getType()

ilStructureObjectGUI::getType

(

)

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

                             : string
    {
        return "st";
    }

initConditionHandlerInterface()

ilStructureObjectGUI::initConditionHandlerInterface

(

)

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

Referenced by executeCommand().

                                                   : 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());
    }

Here is the caller graph for this function:

initSetPageLayoutForm()

ilStructureObjectGUI::initSetPageLayoutForm

(

)

Init set page layout form.

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

References ilLMObjectGUI\$ctrl, $id, ilLMObjectGUI\$lng, ILIAS\Repository\form(), ilObjContentObjectGUI\getLayoutOption(), and ilLanguage\txt().

Referenced by setPageLayout().

                                           : 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));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

savePageLayout()

ilStructureObjectGUI::savePageLayout

(

)

Save page layout.

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

References ilLMObjectGUI\$ctrl, $id, ilLMObjectGUI\$lng, ilLanguage\txt(), and ilLMObject\writeLayout().

                                    : 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");
    }

Here is the call graph for this function:

setPageLayout()

ilStructureObjectGUI::setPageLayout

(

)

Set layout for multipl pages.

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

References ilLMObjectGUI\$ctrl, ilLMObjectGUI\$lng, ilLMObjectGUI\$tpl, ILIAS\Repository\form(), initSetPageLayoutForm(), ILIAS\UICore\GlobalTemplate\setContent(), and ilLanguage\txt().

                                   : 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());
    }

Here is the call graph for this function:

setStructureObject()

ilStructureObjectGUI::setStructureObject

(

ilStructureObject

$a_st_object

)

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

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

setTabs()

ilStructureObjectGUI::setTabs

(

)

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

References ilLMObjectGUI\$lng, $tabs, ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ilObjectMetaDataGUI\getTab(), ILIAS\Repository\lng(), and ilLanguage\txt().

Referenced by create(), and executeCommand().

                             : void
    {
        $ilTabs = $this->tabs;
        $lng = $this->lng;

        // subelements
        $this->ctrl->setParameterByClass(static::class, "sub_type", "pg");
        $ilTabs->addTab(
            "sub_pages",
            $lng->txt("cont_content"),
            $this->ctrl->getLinkTargetByClass(EditSubObjectsGUI::class)
        );

        // preconditions
        $ilTabs->addTab(
            "preconditions",
            $lng->txt("preconditions"),
            $this->ctrl->getLinkTarget($this, 'listConditions')
        );

        // metadata
        $mdgui = new ilObjectMetaDataGUI($this->content_object, $this->obj->getType(), $this->obj->getId());
        $mdtab = $mdgui->getTab();
        if ($mdtab) {
            $ilTabs->addTab(
                "meta_data",
                $lng->txt("meta_data"),
                $mdtab
            );
        }

        $this->tpl->setTitleIcon(ilUtil::getImagePath("standard/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()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

switchToLanguage()

ilStructureObjectGUI::switchToLanguage

(

)

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

References ilLMObjectGUI\$ctrl, and ilCtrl\setParameter().

                                      : void
    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->setParameter($this, "transl", $this->requested_totransl);
        $ilCtrl->redirect($this, "showHierarchy");
    }

Here is the call graph for this function:

view()

ilStructureObjectGUI::view

(

)

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

References ILIAS\Repository\ctrl().

Referenced by edit().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$condHI

ilConditionHandlerGUI ilStructureObjectGUI::$condHI

protected

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

$domain

ILIAS LearningModule InternalDomainService ilStructureObjectGUI::$domain

protected

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

$form

ilPropertyFormGUI ilStructureObjectGUI::$form

protected

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

$gui

ILIAS LearningModule InternalGUIService ilStructureObjectGUI::$gui

protected

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

$log

ilLogger ilStructureObjectGUI::$log

protected

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

$tabs

ilTabsGUI ilStructureObjectGUI::$tabs

protected

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

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

$tree

ilLMTree ilStructureObjectGUI::$tree

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

$user

ilObjUser ilStructureObjectGUI::$user

protected

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

---

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

• components/ILIAS/LearningModule/classes/class.ilStructureObjectGUI.php