ilPCResourcesGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPCResourcesGUI:

Collaboration diagram for ilPCResourcesGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	insert ()
	edit (bool $a_insert=false)
	create ()
	update ()
Public Member Functions inherited from ilPageContentGUI
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id="", string $a_pc_id="0")
	setContentObject (ilPageContent $a_val)
	getContentObject ()
	setPage (ilPageObject $a_val)
	getPage ()
	setPageConfig (ilPageConfig $a_val)
	getPageConfig ()
	setStyleId (int $a_styleid)
	getStyleId ()
	getStyle ()
	getCharacteristicsOfCurrentStyle (array $a_type)
	Get characteristics of current style and call setCharacteristics, if style is given. More...
	setCharacteristics (array $a_chars)
	getCharacteristics ()
	getHierId ()
	setHierId (string $a_hier_id)
	set hierarchical id in dom object More...
	delete ()
	moveAfter ()
	move content element after another element More...
	moveBefore ()
	move content element before another element More...
	splitPage ()
	split page to new page at specified position More...
	splitPageNext ()
	split page to next page at specified position More...
	displayValidationError ()
	cancelCreate ()
	cancel creating page content More...
	cancelUpdate ()
	cancel update More...
	cancel ()
	Cancel. More...
	deactivate ()
	gui function set enabled if is not enabled and vice versa More...
	cut ()
	Cut single element. More...
	copy ()
	Copy single element. More...
	getTemplateOptions (string $a_type="")
	Get table templates. More...

Static Public Member Functions
static	insertResourcesIntoPageContent (string $a_content)
	Insert resources (see also ilContainerContentGUI::determinePageEmbeddedBlocks for presentation) More...
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()

Protected Attributes
ilTree	$rep_tree
ilObjectDefinition	$obj_definition
Protected Attributes inherited from ilPageContentGUI
EditSessionRepository	$edit_repo
string	$pc_id = ""
array	$chars
ilObjStyleSheet	$style = null
ilLogger	$log
int	$styleid = 0
EditGUIRequest	$request
string	$sub_command = ""
int	$requested_ref_id = 0
Style Content CharacteristicManager	$char_manager

Additional Inherited Members
Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilPageObject	$pg_obj
string	$hier_id = ""
php4DOMDocument	$dom
	$updated
string	$target_script = ""
string	$return_location = ""
ilPageConfig	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static string	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")
	getParentReturn (string $hier_id="")
	updateAndReturn ()
	setCurrentTextLang (string $lang_key)
	getCurrentTextLang ()
Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning User Interface for Resources Component Editing

Author

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

Definition at line 23 of file class.ilPCResourcesGUI.php.

Constructor & Destructor Documentation

__construct()

ilPCResourcesGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPageContent	$a_content_obj,
		string	$a_hier_id,
		string	$a_pc_id = ""
	)

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

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

      {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC["tpl"];
        $this->lng = $DIC->language();
        $this->obj_definition = $DIC["objDefinition"];
        $tree = $DIC->repositoryTree();

        $this->rep_tree = $tree;
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilPCResourcesGUI::create

(

)

Definition at line 175 of file class.ilPCResourcesGUI.php.

References ILIAS\Repository\ctrl(), ilPageContentGUI\getPage(), and insert().

                            : void
    {
        $this->content_obj = new ilPCResources($this->getPage());
        $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);

        if ($this->request->getString("res_type") != "itgr") {
            $this->content_obj->setResourceListType(
                $this->request->getString("type")
            );
        } else {
            $this->content_obj->setItemGroupRefId(
                $this->request->getString("itgr")
            );
        }
        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
        } else {
            $this->insert();
        }
    }

Here is the call graph for this function:

edit()

ilPCResourcesGUI::edit

(

bool

$a_insert = false

)

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

References $c, ilPageContentGUI\$ctrl, ILIAS\LTI\ToolProvider\$key, ilPageContentGUI\$lng, $obj_definition, $ref_id, ilPageContentGUI\$requested_ref_id, ilPageContentGUI\$tpl, ilObject\_lookupObjId(), ilObject\_lookupType(), ilPageContentGUI\displayValidationError(), ilObjectPlugin\getPluginObjectByType(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\setContent(), ilRadioGroupInputGUI\setValue(), and ilLanguage\txt().

Referenced by insert(), and update().

                                                : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
        $objDefinition = $this->obj_definition;

        $op_type = null;
        $op_itemgroup = null;

        $this->displayValidationError();

        // edit form
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_insert) {
            $form->setTitle($this->lng->txt("cont_insert_resources"));
        } else {
            $form->setTitle($this->lng->txt("cont_update_resources"));
        }

        // count number of existing objects per type and collect item groups
        $ref_id = $this->requested_ref_id;
        $childs = $this->rep_tree->getChilds($ref_id);
        $type_counts = array();
        $item_groups = array();
        foreach ($childs as $c) {
            // see bug #12471
            //echo "<br>-".$c["type"]."-".$objDefinition->getGroupOfObj($c["type"])."-";
            $key = ($objDefinition->getGroupOfObj($c["type"]) != "")
                ? $objDefinition->getGroupOfObj($c["type"])
                : $c["type"];
            $type_counts[$key] = ($type_counts[$key] ?? 0) + 1;
            if ($c["type"] == "itgr") {
                $item_groups[$c["ref_id"]] = $c["title"];
            }
        }

        if (count($item_groups) > 0) {
            // radio group for type selection
            $radg = new ilRadioGroupInputGUI($lng->txt("cont_resources"), "res_type");
            if (!$a_insert && $this->content_obj->getMainType() == "ItemGroup") {
                $radg->setValue("itgr");
            } else {
                $radg->setValue("by_type");
            }

            $op_type = new ilRadioOption($lng->txt("cont_resources_of_type"), "by_type", "");
            $radg->addOption($op_type);
            $op_itemgroup = new ilRadioOption($lng->txt("obj_itgr"), "itgr", "");
            $radg->addOption($op_itemgroup);
            $form->addItem($radg);
        }

        // type selection
        $type_prop = new ilSelectInputGUI(
            $this->lng->txt("cont_type"),
            "type"
        );
        $obj_id = ilObject::_lookupObjId($this->requested_ref_id);
        $obj_type = ilObject::_lookupType($obj_id);
        $sub_objs = $objDefinition->getGroupedRepositoryObjectTypes($obj_type);
        $types = array();
        foreach ($sub_objs as $k => $so) {
            if (!$objDefinition->isPlugin($k)) {
                if ($k != "itgr") {
                    $types[$k] = $this->lng->txt("objs_" . $k) . " (" . (int) ($type_counts[$k] ?? 0) . ")";
                }
            } else {
                $pl = ilObjectPlugin::getPluginObjectByType($k);
                $types[$k] = $pl->txt("objs_" . $k) . " (" . (int) ($type_counts[$k] ?? 0) . ")";
            }
        }
        $type_prop->setOptions($types);
        $selected = ($a_insert)
            ? ""
            : $this->content_obj->getResourceListType();
        $type_prop->setValue($selected);
        if (count($item_groups) > 0) {
            $op_type->addSubItem($type_prop);
        } else {
            $form->addItem($type_prop);
        }

        if (count($item_groups) > 0) {
            // item groups
            $options = $item_groups;
            $si = new ilSelectInputGUI($this->lng->txt("obj_itgr"), "itgr");
            $si->setOptions($options);
            $selected = ($a_insert)
                ? ""
                : $this->content_obj->getItemGroupRefId();
            $op_itemgroup->addSubItem($si);
        }


        // save/cancel buttons
        if ($a_insert) {
            $form->addCommandButton("create_resources", $lng->txt("save"));
            $form->addCommandButton("cancelCreate", $lng->txt("cancel"));
        } else {
            $form->addCommandButton("update_resources", $lng->txt("save"));
            $form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
        }
        $html = $form->getHTML();
        $tpl->setContent($html);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCResourcesGUI::executeCommand

(

)

Definition at line 47 of file class.ilPCResourcesGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get current command
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            default:
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

insert()

ilPCResourcesGUI::insert

(

)

Definition at line 62 of file class.ilPCResourcesGUI.php.

References edit().

Referenced by create().

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

Here is the call graph for this function:

Here is the caller graph for this function:

insertResourcesIntoPageContent()

static ilPCResourcesGUI::insertResourcesIntoPageContent ( string  $a_content )

static

Insert resources (see also ilContainerContentGUI::determinePageEmbeddedBlocks for presentation)

Definition at line 220 of file class.ilPCResourcesGUI.php.

References $DIC, ilPageContentGUI\$lng, $ref_id, ilPageContentGUI\$tpl, $type, ilObject\_getIcon(), ilObject\_lookupObjId(), ilContainerReference\_lookupTitle(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilGlobalTemplateInterface\get(), ilUtil\img(), ILIAS\Repository\int(), ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), ilGlobalTemplateInterface\setVariable(), and ilLanguage\txt().

Referenced by ilPageObjectGUI\insertResources().

     : string {
        global $DIC;

        $objDefinition = $DIC["objDefinition"];
        $tree = $DIC->repositoryTree();
        $lng = $DIC->language();

        $ref_id = $DIC
            ->copage()
            ->internal()
            ->gui()
            ->pc()
            ->editRequest()
            ->getRefId();
        $obj_id = ilObject::_lookupObjId($ref_id);
        $obj_type = ilObject::_lookupType($obj_id);

        // determine type -> group
        $type_to_grp = array();
        $type_grps =
            $objDefinition->getGroupedRepositoryObjectTypes($obj_type);
        foreach ($type_grps as $grp => $def) {
            foreach ($def["objs"] as $t) {
                $type_to_grp[$t] = $grp;
            }
        }

        $childs = $tree->getChilds($ref_id);
        $childs_by_type = array();
        $item_groups = array();
        foreach ($childs as $child) {
            if (isset($type_to_grp[$child["type"]])) {
                $childs_by_type[$type_to_grp[$child["type"]]][] = $child;
                if ($child["type"] == "itgr") {
                    $item_groups[(int) $child["ref_id"]] = $child["title"];
                }
            }
        }

        // handle "by type" lists
        foreach ($type_grps as $type => $v) {
            if (is_int(strpos($a_content, "[list-" . $type . "]"))) {
                // render block
                $tpl = new ilTemplate("tpl.resource_block.html", true, true, "Services/COPage");
                $cnt = 0;

                if (isset($childs_by_type[$type]) && count($childs_by_type[$type]) > 0) {
                    foreach ($childs_by_type[$type] as $child) {
                        $tpl->setCurrentBlock("row");
                        $tpl->setVariable("IMG",
                            ilUtil::img(
                                ilObject::_getIcon((int) $child["obj_id"], "small"),
                                null,
                                "",
                                "",
                                0,
                                "",
                                "ilListItemIcon"
                            )
                        );
                        $tpl->setVariable("TITLE", $child["title"]);
                        $tpl->parseCurrentBlock();
                        $cnt++;
                    }
                } else {
                    $tpl->setCurrentBlock("row");
                    $tpl->setVariable("TITLE", $lng->txt("no_items"));
                    $tpl->parseCurrentBlock();
                }
                $tpl->setVariable("HEADER", $lng->txt("objs_" . $type));
                $a_content = str_replace("[list-" . $type . "]", $tpl->get(), $a_content);
            }
        }

        // handle item groups
        while (preg_match('/\[(item-group-([0-9]*))\]/i', $a_content, $found)) {
            $itgr_ref_id = (int) $found[2];

            // check whether this item group is child -> insert editing html
            if (isset($item_groups[$itgr_ref_id])) {
                $itgr_items = new ilItemGroupItems($itgr_ref_id);
                $items = $itgr_items->getValidItems();

                // render block
                $tpl = new ilTemplate("tpl.resource_block.html", true, true, "Services/COPage");
                foreach ($items as $it_ref_id) {
                    $it_obj_id = ilObject::_lookupObjId($it_ref_id);
                    $it_title = ilObject::_lookupTitle($it_obj_id);
                    $it_type = ilObject::_lookupType($it_obj_id);

                    // TODO: Handle this switch by module.xml definitions
                    if (in_array($it_type, array("catr", "crsr", "grpr"))) {
                        $it_title = ilContainerReference::_lookupTitle($it_obj_id);
                    }


                    $tpl->setCurrentBlock("row");
                    $tpl->setVariable("IMG", ilUtil::img(ilObject::_getIcon($it_obj_id, "small")));
                    $tpl->setVariable("TITLE", $it_title);
                    $tpl->parseCurrentBlock();
                }
                $tpl->setVariable("HEADER", $item_groups[$itgr_ref_id]);
                $html = $tpl->get();
            } else {
                $html = "<i>" . $lng->txt("cont_element_refers_removed_itgr") . "</i>";
            }
            $a_content = preg_replace('/\[' . $found[1] . '\]/i', $html, $a_content);
        }


        return $a_content;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPCResourcesGUI::update

(

)

Definition at line 197 of file class.ilPCResourcesGUI.php.

References ILIAS\Repository\ctrl(), and edit().

                            : void
    {
        if ($this->request->getString("res_type") != "itgr") {
            $this->content_obj->setResourceListType(
                $this->request->getString("type")
            );
        } else {
            $this->content_obj->setItemGroupRefId(
                $this->request->getString("itgr")
            );
        }
        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
        } else {
            $this->pg_obj->addHierIDs();
            $this->edit();
        }
    }

Here is the call graph for this function:

Field Documentation

$obj_definition

ilObjectDefinition ilPCResourcesGUI::$obj_definition

protected

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

Referenced by edit().

$rep_tree

ilTree ilPCResourcesGUI::$rep_tree

protected

Definition at line 25 of file class.ilPCResourcesGUI.php.

---

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

• Services/COPage/classes/class.ilPCResourcesGUI.php