ilLocatorGUI Class Reference

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

Collaboration diagram for ilLocatorGUI:

Public Member Functions
	__construct ()
	setTextOnly (bool $a_textonly)
	setOffline (bool $a_offline)
	getOffline ()
	getTextOnly ()
	addRepositoryItems (int $a_ref_id=0)
	addAdministrationItems (int $a_ref_id=0)
	add administration tree items More...
	addContextItems (int $a_ref_id, bool $a_omit_node=false, int $a_stop=0)
	addItem (string $a_title, string $a_link, string $a_frame="", int $a_ref_id=0, ?string $type=null)
	clearItems ()
	getItems ()
	getHTML ()
	getTextVersion ()
	Get text version. More...

Protected Member Functions
	init ()

Protected Attributes
int	$ref_id = null
bool	$textonly
bool	$offline = false
ilTree	$tree
ilCtrl	$ctrl
ilObjectDefinition	$obj_definition
ilAccessHandler	$access
ilSetting	$settings
ilLanguage	$lng
array	$entries = []
bool	$initialised = false

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 locator handling class

This class supplies an implementation for the locator. The locator will send its output to ist own frame, enabling more flexibility in the design of the desktop.

Author

Arjan Ammerlaan a.l.a.nosp@m.mmer.nosp@m.laan@.nosp@m.web..nosp@m.de

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

Constructor & Destructor Documentation

__construct()

ilLocatorGUI::__construct

(

)

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

References setTextOnly().

    {
        $this->entries = array();
        $this->offline = false;
        $this->setTextOnly(false);
    }

Here is the call graph for this function:

Member Function Documentation

addAdministrationItems()

ilLocatorGUI::addAdministrationItems

(

int

$a_ref_id = 0

)

add administration tree items

Exceptions

ilCtrlException

Definition at line 161 of file class.ilLocatorGUI.php.

References $ctrl, ILIAS\LTI\ToolProvider\$key, $lng, $obj_definition, $path, $ref_id, $tree, addItem(), ilTree\getPathFull(), init(), ROOT_FOLDER_ID, and ilLanguage\txt().

                                                             : void
    {
        $this->init();
        $tree = $this->tree;
        $ilCtrl = $this->ctrl;
        $objDefinition = $this->obj_definition;
        $lng = $this->lng;

        if ($a_ref_id == 0) {
            $a_ref_id = $this->ref_id;
        }

        if ($a_ref_id > 0) {
            $path = $tree->getPathFull($a_ref_id);

            // add item for each node on path
            foreach ($path as $key => $row) {
                if (!in_array($row["type"], array("root", "cat", "crs", "fold", "grp"))) {
                    continue;
                }

                if ($row["child"] == ROOT_FOLDER_ID) {
                    $row["title"] = $lng->txt("repository");
                }

                $class_name = $objDefinition->getClassName($row["type"]);
                $class = strtolower("ilObj" . $class_name . "GUI");
                $ilCtrl->setParameterByClass($class, "ref_id", $row["child"]);
                $this->addItem(
                    $row["title"],
                    $ilCtrl->getLinkTargetByClass($class, "view"),
                    "",
                    $row["child"]
                );
            }
        }
    }

Here is the call graph for this function:

addContextItems()

ilLocatorGUI::addContextItems	(	int	$a_ref_id,
		bool	$a_omit_node = false,
		int	$a_stop = 0
	)

Definition at line 199 of file class.ilLocatorGUI.php.

References ILIAS\LTI\ToolProvider\$key, $path, $tree, addItem(), CLIENT_ID, ilTree\getPathFull(), init(), and ILIAS\Repository\lng().

     : void {
        $this->init();
        $tree = $this->tree;

        if ($a_ref_id > 0) {
            $path = $tree->getPathFull($a_ref_id);

            // we want to show the full path, from the major container to the item
            // (folders are not! treated as containers here), at least one parent item
            $r_path = array_reverse($path);
            $first = "";
            $omit = array();
            $do_omit = false;
            foreach ($r_path as $key => $row) {
                if ($first == "") {
                    if (in_array($row["type"], array("root", "cat", "grp", "crs")) &&
                        $row["child"] != $a_ref_id) {
                        $first = $row["child"];
                    }
                }
                if ($a_stop == $row["child"]) {
                    $do_omit = true;
                }
                $omit[$row["child"]] = $do_omit;
            }

            $add_it = false;
            foreach ($path as $key => $row) {
                if ($first == $row["child"]) {
                    $add_it = true;
                }


                if ($add_it && !$omit[$row["child"]] &&
                    (!$a_omit_node || ($row["child"] != $a_ref_id))) {
                    //echo "-".ilObject::_lookupTitle($row["obj_id"])."-";
                    if ($row["title"] == "ILIAS" && $row["type"] == "root") {
                        $row["title"] = $this->lng->txt("repository");
                    }
                    $this->addItem(
                        $row["title"],
                        "./goto.php?client_id=" . rawurlencode(CLIENT_ID) . "&target=" . $row["type"] . "_" . $row["child"],
                        "_top",
                        $row["child"],
                        $row["type"]
                    );
                }
            }
        }
    }

Here is the call graph for this function:

addItem()

ilLocatorGUI::addItem	(	string	$a_title,
		string	$a_link,
		string	$a_frame = "",
		int	$a_ref_id = 0,
		?string	$type = null
	)

Definition at line 254 of file class.ilLocatorGUI.php.

References $access, $DIC, $type, ilObjectGUI\ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION, and init().

Referenced by addAdministrationItems(), addContextItems(), ilObjContentObjectGUI\addLocations(), ilObjPortfolioBaseGUI\addLocatorItems(), ilContainerReferenceGUI\addLocatorItems(), ilObjectPluginGUI\addLocatorItems(), ilObjCmiXapiGUI\addLocatorItems(), ilObjFileBasedLMGUI\addLocatorItems(), ilObjBookingPoolGUI\addLocatorItems(), ilObjSurveyQuestionPoolGUI\addLocatorItems(), ilObjSurveyGUI\addLocatorItems(), ilObjExerciseGUI\addLocatorItems(), ilObjLTIConsumerGUI\addLocatorItems(), ilObjWikiGUI\addLocatorItems(), ilObjMediaCastGUI\addLocatorItems(), ilObjSessionGUI\addLocatorItems(), ilObjBlogGUI\addLocatorItems(), addRepositoryItems(), and ilObjSkillTreeGUI\showLocator().

     : void {
        // LTI
        global $DIC;
        $ltiview = $DIC['lti'];

        $this->init();

        $ilAccess = $this->access;

        if ($a_ref_id > 0 && !$ilAccess->checkAccess("visible", "", $a_ref_id)) {
            return;
        }
        // LTI
        if ($ltiview->isActive()) {
            $a_frame = "_self";
        }
        $this->entries[] = array(
            "title" => strip_tags(
                $a_title,
                ilObjectGUI::ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
            ),
            "link" => $a_link,
            "frame" => $a_frame,
            "ref_id" => $a_ref_id,
            "type" => $type
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addRepositoryItems()

ilLocatorGUI::addRepositoryItems

(

int

$a_ref_id = 0

)

Parameters

int

$a_ref_id

Returns

void

Exceptions

ilCtrlException

Definition at line 96 of file class.ilLocatorGUI.php.

References $ctrl, ILIAS\LTI\ToolProvider\$key, $path, $ref_id, $settings, $tree, ilFrameTargetInfo\_getFrame(), ilLink\_getLink(), ilContainer\_lookupContainerSetting(), ilObject\_lookupObjId(), addItem(), ilObjCourseGUI\BREADCRUMB_DEFAULT, ilObjCourseGUI\BREADCRUMB_FULL_PATH, ilTree\getPathFull(), init(), ILIAS\Repository\lng(), and ROOT_FOLDER_ID.

                                                         : void
    {
        $this->init();
        $setting = $this->settings;
        $tree = $this->tree;
        $ilCtrl = $this->ctrl;

        if ($a_ref_id == 0) {
            $a_ref_id = $this->ref_id;
        }

        $a_start = ROOT_FOLDER_ID;
        if ($a_ref_id > 0) {
            $path = $tree->getPathFull($a_ref_id, $a_start);

            // check if path contains crs
            $crs_ref_id = 0;
            foreach ($path as $k => $v) {
                if ($v["type"] == "crs") {
                    $crs_ref_id = $v["child"];
                }
            }
            if (!$setting->get("rep_breadcr_crs")) { // no overwrite
                $crs_ref_id = 0;
            } elseif ($setting->get("rep_breadcr_crs_overwrite")) { // overwrite
                // course wants full path
                if (ilContainer::_lookupContainerSetting(ilObject::_lookupObjId($crs_ref_id), "rep_breacrumb") == ilObjCourseGUI::BREADCRUMB_FULL_PATH) {
                    $crs_ref_id = 0;
                }
                // course wants default and default wants full path
                if (ilContainer::_lookupContainerSetting(ilObject::_lookupObjId($crs_ref_id), "rep_breacrumb") == ilObjCourseGUI::BREADCRUMB_DEFAULT && !$setting->get("rep_breadcr_crs_default")) {
                    $crs_ref_id = 0;
                }
            }

            // add item for each node on path
            foreach ($path as $key => $row) {
                if (!in_array($row["type"], array("root", "cat", "crs", "fold", "grp", "prg", "lso"))) {
                    continue;
                }
                if ($crs_ref_id > 0 && $row["child"] == $crs_ref_id) {
                    $crs_ref_id = 0;
                }
                if ($crs_ref_id > 0) {
                    continue;
                }

                if ($row["title"] == "ILIAS" && $row["type"] == "root") {
                    $row["title"] = $this->lng->txt("repository");
                }

                $this->addItem(
                    $row["title"],
                    ilLink::_getLink((int) $row["child"]),
                    ilFrameTargetInfo::_getFrame("MainContent"),
                    $row["child"]
                );
            }
        }
    }

Here is the call graph for this function:

clearItems()

ilLocatorGUI::clearItems

(

)

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

Referenced by ilObjSkillTreeGUI\showLocator().

                                : void
    {
        $this->entries = array();
    }

Here is the caller graph for this function:

getHTML()

ilLocatorGUI::getHTML

(

)

Definition at line 298 of file class.ilLocatorGUI.php.

References $lng, $type, ilObject\_getIcon(), ilObject\_lookupObjId(), ilObject\_lookupType(), getItems(), getOffline(), getTextOnly(), init(), and ilLanguage\txt().

                             : string
    {
        $this->init();
        $lng = $this->lng;
        $icon_path = "";

        if ($this->getTextOnly()) {
            $loc_tpl = new ilTemplate("tpl.locator_text_only.html", true, true, "Services/Locator");
        } else {
            $loc_tpl = new ilTemplate("tpl.locator.html", true, true, "Services/Locator");
        }

        $items = $this->getItems();
        $first = true;
        if (count($items) > 0) {
            foreach ($items as $item) {
                if (!$first) {
                    $loc_tpl->touchBlock("locator_separator_prefix");
                }

                if ($item["ref_id"] > 0) {
                    $obj_id = ilObject::_lookupObjId($item["ref_id"]);
                    $type = ilObject::_lookupType($obj_id);

                    if (!$this->getTextOnly()) {
                        $icon_path = ilObject::_getIcon(
                            $obj_id,
                            "tiny",
                            $type,
                            $this->getOffline()
                        );
                    }

                    $loc_tpl->setCurrentBlock("locator_img");
                    $loc_tpl->setVariable("IMG_SRC", $icon_path);
                    $loc_tpl->setVariable(
                        "IMG_ALT",
                        $lng->txt("obj_" . $type)
                    );
                    $loc_tpl->parseCurrentBlock();
                }

                $loc_tpl->setCurrentBlock("locator_item");
                if ($item["link"] != "") {
                    $loc_tpl->setVariable("LINK_ITEM", $item["link"]);
                    if ($item["frame"] != "") {
                        $loc_tpl->setVariable("LINK_TARGET", ' target="' . $item["frame"] . '" ');
                    }
                    $loc_tpl->setVariable("ITEM", $item["title"]);
                } else {
                    $loc_tpl->setVariable("PREFIX", $item["title"]);
                }
                $loc_tpl->parseCurrentBlock();

                $first = false;
            }
        } else {
            //            $loc_tpl->setVariable("NOITEM", " ");
            //            $loc_tpl->touchBlock("locator");
        }
        $loc_tpl->setVariable("TXT_BREADCRUMBS", $lng->txt("breadcrumb_navigation"));

        return trim($loc_tpl->get());
    }

Here is the call graph for this function:

getItems()

ilLocatorGUI::getItems

(

)

Definition at line 293 of file class.ilLocatorGUI.php.

References $entries.

Referenced by getHTML(), and getTextVersion().

                              : array
    {
        return $this->entries;
    }

Here is the caller graph for this function:

getOffline()

ilLocatorGUI::getOffline

(

)

Definition at line 81 of file class.ilLocatorGUI.php.

References $offline.

Referenced by getHTML().

                                : bool
    {
        return $this->offline;
    }

Here is the caller graph for this function:

getTextOnly()

ilLocatorGUI::getTextOnly

(

)

Definition at line 86 of file class.ilLocatorGUI.php.

References $textonly.

Referenced by getHTML().

                                 : bool
    {
        return $this->textonly;
    }

Here is the caller graph for this function:

getTextVersion()

ilLocatorGUI::getTextVersion

(

)

Get text version.

Definition at line 366 of file class.ilLocatorGUI.php.

References getItems(), and init().

                                    : string
    {
        $this->init();
        $items = $this->getItems();
        $first = true;

        $str = "";
        foreach ($items as $item) {
            if (!$first) {
                $str .= " > ";
            }

            $str .= $item["title"];

            $first = false;
        }

        return $str;
    }

Here is the call graph for this function:

init()

ilLocatorGUI::init ( )

protected

Definition at line 48 of file class.ilLocatorGUI.php.

References $DIC, $lng, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Referenced by addAdministrationItems(), addContextItems(), addItem(), addRepositoryItems(), getHTML(), and getTextVersion().

                             : void
    {
        global $DIC;

        if ($this->initialised) {
            return;
        }
        $this->tree = $DIC->repositoryTree();
        $this->ctrl = $DIC->ctrl();
        $this->obj_definition = $DIC["objDefinition"];
        $this->access = $DIC->access();
        $this->settings = $DIC->settings();
        $lng = $DIC->language();

        $this->lng = $lng;
        $this->ref_id = ($DIC->http()->wrapper()->query()->has("ref_id"))
            ? $DIC->http()->wrapper()->query()->retrieve("ref_id", $DIC->refinery()->kindlyTo()->int())
            : null;
        if ($this->ref_id == 0) {
            $this->ref_id = null;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setOffline()

ilLocatorGUI::setOffline

(

bool

$a_offline

)

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

                                               : void
    {
        $this->offline = $a_offline;
    }

setTextOnly()

ilLocatorGUI::setTextOnly

(

bool

$a_textonly

)

Definition at line 71 of file class.ilLocatorGUI.php.

Referenced by __construct().

                                                 : void
    {
        $this->textonly = $a_textonly;
    }

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilLocatorGUI::$access

protected

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

Referenced by addItem().

$ctrl

ilCtrl ilLocatorGUI::$ctrl

protected

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

Referenced by addAdministrationItems(), and addRepositoryItems().

$entries

array ilLocatorGUI::$entries = []

protected

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

Referenced by getItems().

$initialised

bool ilLocatorGUI::$initialised = false

protected

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

$lng

ilLanguage ilLocatorGUI::$lng

protected

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

Referenced by addAdministrationItems(), getHTML(), and init().

$obj_definition

ilObjectDefinition ilLocatorGUI::$obj_definition

protected

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

Referenced by addAdministrationItems().

$offline

bool ilLocatorGUI::$offline = false

protected

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

Referenced by getOffline().

$ref_id

int ilLocatorGUI::$ref_id = null

protected

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

Referenced by addAdministrationItems(), and addRepositoryItems().

$settings

ilSetting ilLocatorGUI::$settings

protected

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

Referenced by addRepositoryItems().

$textonly

bool ilLocatorGUI::$textonly

protected

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

Referenced by getTextOnly().

$tree

ilTree ilLocatorGUI::$tree

protected

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

Referenced by addAdministrationItems(), addContextItems(), and addRepositoryItems().

---

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

• Services/Locator/classes/class.ilLocatorGUI.php