ilRepositorySelectorInputGUI Class Reference

This class represents a repository selector in a property form. More...

Inheritance diagram for ilRepositorySelectorInputGUI:

Collaboration diagram for ilRepositorySelectorInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setValue ($a_value)
	Set Value. More...
	getValue ()
	Get Value. More...
	setValueByArray ($a_values)
	Set value by array. More...
	setSelectText ($a_val)
	Set select link text. More...
	getSelectText ()
	Get select link text. More...
	setHeaderMessage ($a_val)
	Set header message. More...
	getHeaderMessage ()
	Get header message. More...
	setClickableTypes ($a_types)
	Set clickable types. More...
	getClickableTypes ()
	Get clickable types. More...
	checkInput ()
	Check input, strip slashes etc. More...
	showRepositorySelection ()
	Select Repository Item. More...
	selectRepositoryItem ()
	Select repository item. More...
	reset ()
	Reset. More...
	render ($a_mode="property_form")
	Render item. More...
	insert ($a_tpl)
	Insert property html. More...
	getTableFilterHTML ()
	Get HTML for table filter. More...
Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	executeCommand ()
	Execute command. More...
	getType ()
	Get Type. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setPostVar ($a_postvar)
	Set Post Variable. More...
	getPostVar ()
	Get Post Variable. More...
	getFieldId ()
	Get Post Variable. More...
	setInfo ($a_info)
	Set Information Text. More...
	getInfo ()
	Get Information Text. More...
	setAlert ($a_alert)
	Set Alert Text. More...
	getAlert ()
	Get Alert Text. More...
	setRequired ($a_required)
	Set Required. More...
	getRequired ()
	Get Required. More...
	setDisabled ($a_disabled)
	Set Disabled. More...
	getDisabled ()
	Get Disabled. More...
	checkInput ()
	Check input, strip slashes etc. More...
	setParentForm ($a_parentform)
	Set Parent Form. More...
	getParentForm ()
	Get Parent Form. More...
	setParent ($a_val)
	Set Parent GUI object. More...
	getParent ()
	Get Parent GUI object. More...
	getSubForm ()
	Get sub form html. More...
	hideSubForm ()
	Sub form hidden on init? More...
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...
	getHiddenTitle ()
	Get hidden title. More...
	getItemByPostVar ($a_post_var)
	Get item by post var. More...
	serializeData ()
	serialize data More...
	unserializeData ($a_data)
	unserialize data More...
	writeToSession ()
	Write to session. More...
	clearFromSession ()
	Clear session value. More...
	readFromSession ()
	Read from session. More...
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...
	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...
	getMulti ()
	Get Multi. More...
	setMultiValues (array $a_values)
	Set multi values. More...
	getMultiValues ()
	Get multi values. More...
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...
	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

Protected Member Functions
	getHighlightedNode ()
	Returns the highlighted object. More...
	getVisibleTypes ()
	returns all visible types like container and clickable types More...
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...
	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Protected Attributes
	$tpl
	$tree
	$user
	$obj_data_cache
	$options
	$value
	$container_types = array("root", "cat", "grp", "fold", "crs")
Protected Attributes inherited from ilFormPropertyGUI
	$ctrl
	$lng
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""
	$multi = false
	$multi_sortable = false
	$multi_addremove = true
	$multi_values

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Detailed Description

This class represents a repository selector in a property form.

The implementation is kind of beta. It looses all other inputs, if the selector link is used.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilRepositorySelectorInputGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

__construct()

ilRepositorySelectorInputGUI::__construct	(		$a_title = "",
			$a_postvar = ""
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 70 of file class.ilRepositorySelectorInputGUI.php.

References $DIC, ilFormPropertyGUI\$lng, setClickableTypes(), setHeaderMessage(), setSelectText(), ilFormPropertyGUI\setType(), and user().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->tree = $DIC->repositoryTree();
        $this->user = $DIC->user();
        $this->obj_data_cache = $DIC["ilObjDataCache"];
        $lng = $DIC->language();
        
        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"));
    }

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilRepositorySelectorInputGUI::checkInput

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Returns

boolean Input ok, true/false

Definition at line 184 of file class.ilRepositorySelectorInputGUI.php.

References $_POST, ilFormPropertyGUI\$lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

    {
        $lng = $this->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;
    }

Here is the call graph for this function:

getClickableTypes()

ilRepositorySelectorInputGUI::getClickableTypes

(

)

Get clickable types.

Returns

array clickable types

Definition at line 174 of file class.ilRepositorySelectorInputGUI.php.

Referenced by getVisibleTypes(), render(), and showRepositorySelection().

    {
        return $this->clickable_types;
    }

Here is the caller graph for this function:

getHeaderMessage()

ilRepositorySelectorInputGUI::getHeaderMessage

(

)

Get header message.

Returns

string header message

Definition at line 154 of file class.ilRepositorySelectorInputGUI.php.

Referenced by showRepositorySelection().

    {
        return $this->hm;
    }

Here is the caller graph for this function:

getHighlightedNode()

ilRepositorySelectorInputGUI::getHighlightedNode ( )

protected

Returns the highlighted object.

Returns

int ref_id (node)

Definition at line 364 of file class.ilRepositorySelectorInputGUI.php.

References $tree, ilObject\_lookupType(), getValue(), and getVisibleTypes().

Referenced by showRepositorySelection().

    {
        $tree = $this->tree;

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

        return $this->getValue();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSelectText()

ilRepositorySelectorInputGUI::getSelectText

(

)

Get select link text.

Returns

string select link text

Definition at line 134 of file class.ilRepositorySelectorInputGUI.php.

Referenced by render().

    {
        return $this->select_text;
    }

Here is the caller graph for this function:

getTableFilterHTML()

ilRepositorySelectorInputGUI::getTableFilterHTML

(

)

Get HTML for table filter.

Implements ilTableFilterItem.

Definition at line 353 of file class.ilRepositorySelectorInputGUI.php.

References $html, and render().

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

Here is the call graph for this function:

getValue()

ilRepositorySelectorInputGUI::getValue

(

)

Get Value.

Returns

int ref id of selected repository item

Definition at line 104 of file class.ilRepositorySelectorInputGUI.php.

References $value.

Referenced by getHighlightedNode(), render(), and showRepositorySelection().

    {
        return $this->value;
    }

Here is the caller graph for this function:

getVisibleTypes()

ilRepositorySelectorInputGUI::getVisibleTypes ( )

protected

returns all visible types like container and clickable types

Returns

array

Definition at line 380 of file class.ilRepositorySelectorInputGUI.php.

References array, and getClickableTypes().

Referenced by getHighlightedNode(), and showRepositorySelection().

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

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilRepositorySelectorInputGUI::insert

(

$a_tpl

)

Insert property html.

Returns

int Size

Definition at line 343 of file class.ilRepositorySelectorInputGUI.php.

References render().

    {
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $this->render());
        $a_tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

render()

ilRepositorySelectorInputGUI::render

(

$a_mode = "property_form"

)

Render item.

Definition at line 276 of file class.ilRepositorySelectorInputGUI.php.

References ilFormPropertyGUI\$ctrl, $ilCtrl, ilFormPropertyGUI\$lng, $nd, $obj_data_cache, ilFormPropertyGUI\$title, $tpl, $tree, array, getClickableTypes(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getParent(), ilFormPropertyGUI\getPostVar(), getSelectText(), getValue(), and ilUtil\prepareFormOutput().

Referenced by getTableFilterHTML(), and insert().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilObjDataCache = $this->obj_data_cache;
        $tree = $this->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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilRepositorySelectorInputGUI::reset

(

)

Reset.

Definition at line 258 of file class.ilRepositorySelectorInputGUI.php.

References ilFormPropertyGUI\$ctrl, $ilCtrl, $ilUser, $user, ilFormPropertyGUI\getFieldId(), setValue(), and ilFormPropertyGUI\writeToSession().

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

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

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

        $ilCtrl->returnToParent($this, $anchor);
    }

Here is the call graph for this function:

selectRepositoryItem()

ilRepositorySelectorInputGUI::selectRepositoryItem

(

)

Select repository item.

Definition at line 240 of file class.ilRepositorySelectorInputGUI.php.

References $_GET, ilFormPropertyGUI\$ctrl, $ilCtrl, $ilUser, $user, ilFormPropertyGUI\getFieldId(), setValue(), and ilFormPropertyGUI\writeToSession().

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

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

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

        $ilCtrl->returnToParent($this, $anchor);
    }

Here is the call graph for this function:

setClickableTypes()

ilRepositorySelectorInputGUI::setClickableTypes

(

$a_types

)

Set clickable types.

Parameters

array

clickable types

Definition at line 164 of file class.ilRepositorySelectorInputGUI.php.

Referenced by __construct().

    {
        $this->clickable_types = $a_types;
    }

Here is the caller graph for this function:

setHeaderMessage()

ilRepositorySelectorInputGUI::setHeaderMessage

(

$a_val

)

Set header message.

Parameters

string

header message

Definition at line 144 of file class.ilRepositorySelectorInputGUI.php.

Referenced by __construct(), and ilTestQuestionBrowserTableGUI\initFilter().

    {
        $this->hm = $a_val;
    }

Here is the caller graph for this function:

setSelectText()

ilRepositorySelectorInputGUI::setSelectText

(

$a_val

)

Set select link text.

Parameters

string

select link text

Definition at line 124 of file class.ilRepositorySelectorInputGUI.php.

Referenced by __construct(), ilSearchBaseGUI\getSearchAreaForm(), ilLPTableBaseGUI\initBaseFilter(), ilMStShowUserCoursesTableGUI\initFilter(), and ilUserTableGUI\initFilter().

    {
        $this->select_text = $a_val;
    }

Here is the caller graph for this function:

setValue()

ilRepositorySelectorInputGUI::setValue

(

$a_value

)

Set Value.

Parameters

int	ref id of selected repository item

Definition at line 94 of file class.ilRepositorySelectorInputGUI.php.

Referenced by reset(), selectRepositoryItem(), and setValueByArray().

    {
        $this->value = $a_value;
    }

Here is the caller graph for this function:

setValueByArray()

ilRepositorySelectorInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

Definition at line 114 of file class.ilRepositorySelectorInputGUI.php.

References ilFormPropertyGUI\getPostVar(), and setValue().

    {
        $this->setValue($a_values[$this->getPostVar()]);
    }

Here is the call graph for this function:

showRepositorySelection()

ilRepositorySelectorInputGUI::showRepositorySelection

(

)

Select Repository Item.

Definition at line 202 of file class.ilRepositorySelectorInputGUI.php.

References ilFormPropertyGUI\$ctrl, $ilCtrl, $ilUser, ilFormPropertyGUI\$lng, $tpl, $tree, $user, getClickableTypes(), getHeaderMessage(), getHighlightedNode(), ilFormPropertyGUI\getPostVar(), getValue(), getVisibleTypes(), and ilUtil\sendInfo().

    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $tree = $this->tree;
        $ilUser = $this->user;
        
        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());
    }

Here is the call graph for this function:

Field Documentation

$container_types

ilRepositorySelectorInputGUI::$container_types = array("root", "cat", "grp", "fold", "crs")

protected

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

$obj_data_cache

ilRepositorySelectorInputGUI::$obj_data_cache

protected

Definition at line 58 of file class.ilRepositorySelectorInputGUI.php.

Referenced by render().

$options

ilRepositorySelectorInputGUI::$options

protected

Definition at line 60 of file class.ilRepositorySelectorInputGUI.php.

$tpl

ilRepositorySelectorInputGUI::$tpl

protected

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

Referenced by render(), and showRepositorySelection().

$tree

ilRepositorySelectorInputGUI::$tree

protected

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

Referenced by getHighlightedNode(), render(), and showRepositorySelection().

$user

ilRepositorySelectorInputGUI::$user

protected

Definition at line 53 of file class.ilRepositorySelectorInputGUI.php.

Referenced by reset(), selectRepositoryItem(), and showRepositorySelection().

$value

ilRepositorySelectorInputGUI::$value

protected

Definition at line 61 of file class.ilRepositorySelectorInputGUI.php.

Referenced by getValue().

---

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

• Services/Form/classes/class.ilRepositorySelectorInputGUI.php