ilLocatorGUI Class Reference

locator handling class More...

Collaboration diagram for ilLocatorGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	setTextOnly ($a_textonly)
	Set Only text, no HTML. More...
	setOffline ($a_offline)
	getOffline ()
	getTextOnly ()
	Get Only text, no HTML. More...
	addRepositoryItems ($a_ref_id=0)
	add repository item More...
	addAdministrationItems ($a_ref_id=0)
	add administration tree items More...
	addContextItems ($a_ref_id, $a_omit_node=false, $a_stop=0)
	addItem ($a_title, $a_link, $a_frame="", $a_ref_id=0, $type=null)
	add locator item More...
	clearItems ()
	Clear all Items. More...
	getItems ()
	Get all locator entries. More...
	getHTML ()
	Get locator HTML. More...
	getTextVersion ()
	Get text version. More...

Protected Attributes
	$tree
	$ctrl
	$obj_definition
	$access
	$settings
	$lng
	$entries

Detailed Description

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilLocatorGUI::__construct

(

)

Constructor.

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

References $DIC, $lng, setTextOnly(), and settings().

    {
        global $DIC;

        $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->entries = array();
        $this->setTextOnly(false);
        $this->offline = false;
    }

Here is the call graph for this function:

Member Function Documentation

addAdministrationItems()

ilLocatorGUI::addAdministrationItems

(

$a_ref_id = 0

)

add administration tree items

Parameters

int

$a_ref_id

current ref id (optional); if empty $_GET["ref_id"] is used

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

References $_GET, $ctrl, $lng, $obj_definition, $tree, addItem(), and ROOT_FOLDER_ID.

    {
        $tree = $this->tree;
        $ilCtrl = $this->ctrl;
        $objDefinition = $this->obj_definition;
        $lng = $this->lng;

        if ($a_ref_id == 0) {
            $a_ref_id = $_GET["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	(		$a_ref_id,
			$a_omit_node = false,
			$a_stop = 0
	)

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

References $tree, addItem(), and CLIENT_ID.

    {
        $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	(		$a_title,
			$a_link,
			$a_frame = "",
			$a_ref_id = 0,
			$type = null
	)

add locator item

Parameters

string	$a_title	item title
string	$a_link	item link
string	$a_frame	frame target

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

References $access, $DIC, $type, and ilObjectGUI\ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION.

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

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

        $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 caller graph for this function:

addRepositoryItems()

ilLocatorGUI::addRepositoryItems

(

$a_ref_id = 0

)

add repository item

Parameters

int

$a_ref_id

current ref id (optional); if empty $_GET["ref_id"] is used

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

References $_GET, $ctrl, $settings, $tree, ilFrameTargetInfo\_getFrame(), ilLink\_getLink(), ilContainer\_lookupContainerSetting(), ilObject\_lookupObjId(), addItem(), ilObjCourseGUI\BREADCRUMB_DEFAULT, ilObjCourseGUI\BREADCRUMB_FULL_PATH, and ROOT_FOLDER_ID.

    {
        $setting = $this->settings;
        $tree = $this->tree;
        $ilCtrl = $this->ctrl;

        if ($a_ref_id == 0) {
            $a_ref_id = $_GET["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 ((array) $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($row["child"]),
                    ilFrameTargetInfo::_getFrame("MainContent"),
                    $row["child"]
                );
            }
        }
    }

Here is the call graph for this function:

clearItems()

ilLocatorGUI::clearItems

(

)

Clear all Items.

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

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

getHTML()

ilLocatorGUI::getHTML

(

)

Get locator HTML.

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

References $ilSetting, $lng, $settings, $type, ilObject\_getIcon(), ilObject\_lookupObjId(), ilObject\_lookupType(), getItems(), getOffline(), and getTextOnly().

    {
        $lng = $this->lng;
        $ilSetting = $this->settings;

        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 (is_array($items)) {
            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

(

)

Get all locator entries.

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

References $entries.

Referenced by getHTML(), and getTextVersion().

    {
        return $this->entries;
    }

Here is the caller graph for this function:

getOffline()

ilLocatorGUI::getOffline

(

)

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

Referenced by getHTML().

    {
        return $this->offline;
    }

Here is the caller graph for this function:

getTextOnly()

ilLocatorGUI::getTextOnly

(

)

Get Only text, no HTML.

Returns

boolean Only text, no HTML

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

Referenced by getHTML().

    {
        return $this->textonly;
    }

Here is the caller graph for this function:

getTextVersion()

ilLocatorGUI::getTextVersion

(

)

Get text version.

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

References $ilSetting, $lng, $settings, and getItems().

    {
        $lng = $this->lng;
        $ilSetting = $this->settings;

        $items = $this->getItems();
        $first = true;

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

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

                $first = false;
            }
        }

        return $str;
    }

Here is the call graph for this function:

setOffline()

ilLocatorGUI::setOffline

(

$a_offline

)

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

    {
        $this->offline = $a_offline;
    }

setTextOnly()

ilLocatorGUI::setTextOnly

(

$a_textonly

)

Set Only text, no HTML.

Parameters

boolean

$a_textonly

Only text, no HTML

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

Referenced by __construct().

    {
        $this->textonly = $a_textonly;
    }

Here is the caller graph for this function:

Field Documentation

$access

ilLocatorGUI::$access

protected

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

Referenced by addItem().

$ctrl

ilLocatorGUI::$ctrl

protected

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

Referenced by addAdministrationItems(), and addRepositoryItems().

$entries

ilLocatorGUI::$entries

protected

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

Referenced by getItems().

$lng

ilLocatorGUI::$lng

protected

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

Referenced by __construct(), addAdministrationItems(), getHTML(), and getTextVersion().

$obj_definition

ilLocatorGUI::$obj_definition

protected

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

Referenced by addAdministrationItems().

$settings

ilLocatorGUI::$settings

protected

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

Referenced by addRepositoryItems(), getHTML(), and getTextVersion().

$tree

ilLocatorGUI::$tree

protected

Definition at line 20 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