class.ilLocatorGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilLocatorGUI
{
        protected $lng;
        protected $entries;
        
        function __construct()
        {
                global $lng;

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

        function setTextOnly($a_textonly)
        {
                $this->textonly = $a_textonly;
        }
        
        function setOffline($a_offline)
        {
                $this->offline = $a_offline;
        }

        function getOffline()
        {
                return $this->offline;
        }

        function getTextOnly()
        {
                return $this->textonly;
        }

        function addRepositoryItems($a_ref_id = 0)
        {
                global $tree, $ilCtrl;

                if ($a_ref_id == 0)
                {
                        $a_ref_id = $_GET["ref_id"];
                }
                
                include_once './Services/Container/classes/class.ilMemberViewSettings.php';
                if(ilMemberViewSettings::getInstance()->isActive() and $a_ref_id != ROOT_FOLDER_ID)
                {
                        $a_start = ilMemberViewSettings::getInstance()->getContainer();
                }
                else
                {
                        $a_start = ROOT_FOLDER_ID;
                }
                
                if ($a_ref_id > 0)
                {
                        $path = $tree->getPathFull($a_ref_id,$a_start);

                        // 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")))
                                {
                                        continue;
                                }
                                if ($row["title"] == "ILIAS" && $row["type"] == "root")
                                {
                                        $row["title"] = $this->lng->txt("repository");
                                }
                                
                                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $row["child"]);
                                $this->addItem($row["title"],
                                        $ilCtrl->getLinkTargetByClass("ilrepositorygui", "frameset"),
                                        ilFrameTargetInfo::_getFrame("MainContent"), $row["child"]);
                                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $_GET["ref_id"]);
                        }
                }
        }
        
        function addAdministrationItems($a_ref_id = 0)
        {
                global $tree, $ilCtrl, $objDefinition, $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"]);
                        }
                }
        }
        
        function addContextItems($a_ref_id, $a_omit_node = false, $a_stop = 0)
        {
                global $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"]);
                                }
                        }
                }
        }
        
        function addItem($a_title, $a_link, $a_frame = "", $a_ref_id = 0, $type = null)
        {
                global $ilAccess;

                if ($a_ref_id > 0 && !$ilAccess->checkAccess("visible", "", $a_ref_id))
                {
                        return;
                }

                $this->entries[] = array("title" => $a_title,
                        "link" => $a_link, "frame" => $a_frame, "ref_id" => $a_ref_id, "type" => $type); 
        }
        
        function clearItems()
        {
                $this->entries = array();
        }
        
        function getItems()
        {
                return $this->entries;
        }
        
        function getHTML()
        {
                global $lng, $ilSetting;
                
                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", "&nbsp;");
                        $loc_tpl->touchBlock("locator");
                }
                $loc_tpl->setVariable("TXT_BREADCRUMBS", $lng->txt("breadcrumb_navigation"));
                
                return trim($loc_tpl->get());
        }

        function getTextVersion()
        {
                global $lng, $ilSetting;
                
                $items = $this->getItems();
                $first = true;

                $str = "";
                if (is_array($items))
                {
                        foreach($items as $item)
                        {
                                if (!$first)
                                {
                                        $str.= " > ";
                                }
                                
                                $str.= $item["title"];
                                
                                $first = false;
                        }
                }
                
                return $str;
        }

} // END class.LocatorGUI
?>