class.ilRepositorySelectorInputGUI.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2007 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

include_once("./Services/Table/interfaces/interface.ilTableFilterItem.php");
include_once("./Services/Form/classes/class.ilFormPropertyGUI.php");

class ilRepositorySelectorInputGUI extends ilFormPropertyGUI implements ilTableFilterItem
{
        protected $options;
        protected $value;
        protected $container_types = array("root", "cat", "grp", "fold", "crs");
        
        function __construct($a_title = "", $a_postvar = "")
        {
                global $lng;
                
                parent::__construct($a_title, $a_postvar);
                $this->setClickableTypes($this->container_types);
                $this->setHeaderMessage($lng->txt('search_area_info'));
                $this->setType("rep_select");
                $this->setSelectText($lng->txt("select"));
        }

        function setValue($a_value)
        {
                $this->value = $a_value;
        }

        function getValue()
        {
                return $this->value;
        }
        
        function setValueByArray($a_values)
        {
                $this->setValue($a_values[$this->getPostVar()]);
        }

        function setSelectText($a_val)
        {
                $this->select_text = $a_val;
        }
        
        function getSelectText()
        {
                return $this->select_text;
        }
        
        function setHeaderMessage($a_val)
        {
                $this->hm = $a_val;
        }
        
        function getHeaderMessage()
        {
                return $this->hm;
        }
        
        function setClickableTypes($a_types)
        {
                $this->clickable_types = $a_types;
        }
        
        function getClickableTypes()
        {
                return $this->clickable_types;
        }
        
        function checkInput()
        {
                global $lng;
                
                $_POST[$this->getPostVar()] = 
                        ilUtil::stripSlashes($_POST[$this->getPostVar()]);

                if ($this->getRequired() && trim($_POST[$this->getPostVar()]) == "")
                {
                        $this->setAlert($lng->txt("msg_input_is_required"));

                        return false;
                }
                return true;
        }

        function showRepositorySelection()
        {
                global $tpl, $lng, $ilCtrl, $tree, $ilUser;
                
                include_once 'Services/Repository/classes/class.ilRepositorySelectorExplorerGUI.php';
                $ilCtrl->setParameter($this, "postvar", $this->getPostVar());

                ilUtil::sendInfo($this->getHeaderMessage());

                $exp = new ilRepositorySelectorExplorerGUI($this, "showRepositorySelection",
                        $this, "selectRepositoryItem", "root_id");
                $exp->setTypeWhiteList($this->getVisibleTypes());
                $exp->setClickableTypes($this->getClickableTypes());

                if($this->getValue())
                {
                        $exp->setPathOpen($this->getValue());
                        $exp->setHighlightedNode($this->getHighlightedNode());
                }

                if ($exp->handleCommand())
                {
                        return;
                }
                // build html-output
                $tpl->setContent($exp->getHTML());
        }
        
        function selectRepositoryItem()
        {
                global $ilCtrl, $ilUser;

                $anchor = $ilUser->prefs["screen_reader_optimization"]
                        ? $this->getFieldId()."_anchor"
                        : "";

                $this->setValue($_GET["root_id"]);
                $this->writeToSession();

                $ilCtrl->returnToParent($this, $anchor);
        }
        
        function reset()
        {
                global $ilCtrl, $ilUser;

                $anchor = $ilUser->prefs["screen_reader_optimization"]
                        ? $this->getFieldId()."_anchor"
                        : "";

                $this->setValue("");
                $this->writeToSession();

                $ilCtrl->returnToParent($this, $anchor);
        }
        
        function render($a_mode = "property_form")
        {
                global $lng, $ilCtrl, $ilObjDataCache, $tree;
                
                $tpl = new ilTemplate("tpl.prop_rep_select.html", true, true, "Services/Form");

                $tpl->setVariable("POST_VAR", $this->getPostVar());
                $tpl->setVariable("ID", $this->getFieldId());
                $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));
                $tpl->setVariable("TXT_SELECT", $this->getSelectText());
                $tpl->setVariable("TXT_RESET", $lng->txt("reset"));
                switch ($a_mode)
                {
                        case "property_form":
                                $parent_gui = "ilpropertyformgui";
                                break;
                                
                        case "table_filter":
                                $parent_gui = get_class($this->getParent());
                                break;
                }

                $ilCtrl->setParameterByClass("ilrepositoryselectorinputgui",
                        "postvar", $this->getPostVar());
                $tpl->setVariable("HREF_SELECT",
                        $ilCtrl->getLinkTargetByClass(array($parent_gui, "ilformpropertydispatchgui", "ilrepositoryselectorinputgui"),
                        "showRepositorySelection"));
                $tpl->setVariable("HREF_RESET",
                        $ilCtrl->getLinkTargetByClass(array($parent_gui, "ilformpropertydispatchgui", "ilrepositoryselectorinputgui"),
                        "reset"));

                if ($this->getValue() > 0 && $this->getValue() != ROOT_FOLDER_ID)
                {
                        $tpl->setVariable("TXT_ITEM",
                                $ilObjDataCache->lookupTitle($ilObjDataCache->lookupObjId($this->getValue())));
                }
                else
                {
                        $nd = $tree->getNodeData(ROOT_FOLDER_ID);
                        $title = $nd["title"];
                        if ($title == "ILIAS")
                        {
                                $title = $lng->txt("repository");
                        }
                        if (in_array($nd["type"], $this->getClickableTypes()))
                        {
                                $tpl->setVariable("TXT_ITEM", $title);
                        }
                }
                return $tpl->get();
        }
        
        function insert(&$a_tpl)
        {
                $a_tpl->setCurrentBlock("prop_generic");
                $a_tpl->setVariable("PROP_GENERIC", $this->render());
                $a_tpl->parseCurrentBlock();
        }

        function getTableFilterHTML()
        {
                $html = $this->render("table_filter");
                return $html;
        }

        protected function getHighlightedNode()
        {
                global $tree;

                if(!in_array(ilObject::_lookupType($this->getValue(),true), $this->getVisibleTypes()))
                {
                        return $tree->getParentId($this->getValue());
                }

                return $this->getValue();
        }

        protected function getVisibleTypes()
        {
                return array_merge((array)$this->container_types, (array)$this->getClickableTypes());
        }

}