ilGloAdvColSortInputGUI Class Reference

Input for adv meta data column sorting in glossaries. More...

Inheritance diagram for ilGloAdvColSortInputGUI:

Collaboration diagram for ilGloAdvColSortInputGUI:

Public Member Functions
	__construct ($a_title="", $a_id="")
	Constructor. More...
	setValue ($a_value)
	Set Value. More...
	getValue ()
	Get Value. More...
	checkInput ()
	Input should always be valid, since we sort only. More...
	render ()
	render More...
	insert (&$a_tpl)
	Insert property html. More...
	setValueByArray ($a_values)
	Set value by array. 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...

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...
	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...
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

Detailed Description

Input for adv meta data column sorting in glossaries.

Please note, that data us already an array, we do not use the MultipleValues interface here.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilGloAdvColSortInputGUI::__construct	(		$a_title = "",
			$a_id = ""
	)

Constructor.

Parameters

Definition at line 23 of file class.ilGloAdvColSortInputGUI.php.

References $DIC, and ilFormPropertyGUI\setType().

    {
        global $DIC;

        $this->lng = $DIC->language();
        parent::__construct($a_title, $a_id);
        $this->setType("glo_adv_col_sort");
    }

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilGloAdvColSortInputGUI::checkInput

(

)

Input should always be valid, since we sort only.

Returns

boolean

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

References $_POST, array, ilFormPropertyGUI\getPostVar(), and ilUtil\stripSlashes().

    {
        if (is_array($_POST[$this->getPostVar()])) {
            foreach ($_POST[$this->getPostVar()] as $k => $v) {
                $_POST[$this->getPostVar()][$k]["id"] = ilUtil::stripSlashes($_POST[$this->getPostVar()][$k]["id"]);
                $_POST[$this->getPostVar()][$k]["text"] = ilUtil::stripSlashes($_POST[$this->getPostVar()][$k]["text"]);
            }
        } else {
            $_POST[$this->getPostVar()] = array();
        }

        return true;
    }

Here is the call graph for this function:

getTableFilterHTML()

ilGloAdvColSortInputGUI::getTableFilterHTML

(

)

Get HTML for table filter.

Definition at line 127 of file class.ilGloAdvColSortInputGUI.php.

References $html, and render().

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

Here is the call graph for this function:

getValue()

ilGloAdvColSortInputGUI::getValue

(

)

Get Value.

Returns

string Value

Definition at line 47 of file class.ilGloAdvColSortInputGUI.php.

Referenced by render().

    {
        return $this->value;
    }

Here is the caller graph for this function:

insert()

ilGloAdvColSortInputGUI::insert

(

&

$a_tpl

)

Insert property html.

Definition at line 105 of file class.ilGloAdvColSortInputGUI.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()

ilGloAdvColSortInputGUI::render

(

)

render

Definition at line 75 of file class.ilGloAdvColSortInputGUI.php.

References ilFormPropertyGUI\$lng, $tpl, ilGlyphGUI\DOWN, ilGlyphGUI\get(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), getValue(), ilUtil\prepareFormOutput(), and ilGlyphGUI\UP.

Referenced by getTableFilterHTML(), and insert().

    {
        $lng = $this->lng;
        
        $tpl = new ilTemplate("tpl.adv_col_sort_input.html", true, true, "Modules/Glossary");
        include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
        if (is_array($this->getValue())) {
            foreach ($this->getValue() as $k => $v) {
                $tpl->setCurrentBlock("item");
                $tpl->setVariable("TEXT", $v["text"]);
                $tpl->setVariable("ID", $this->getFieldId() . "~" . $k);
                $tpl->setVariable("DOWN", ilGlyphGUI::get(ilGlyphGUI::DOWN));
                $tpl->setVariable("TXT_DOWN", $lng->txt("down"));
                $tpl->setVariable("UP", ilGlyphGUI::get(ilGlyphGUI::UP));
                $tpl->setVariable("TXT_UP", $lng->txt("up"));
                $tpl->setVariable('NAME', $this->getPostVar() . "[" . $k . "][id]");
                $tpl->setVariable('TNAME', $this->getPostVar() . "[" . $k . "][text]");
                $tpl->setVariable('VAL', ilUtil::prepareFormOutput($v["id"]));
                $tpl->setVariable('TVAL', ilUtil::prepareFormOutput($v["text"]));
                $tpl->parseCurrentBlock();
            }
        }
        
        return $tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setValue()

ilGloAdvColSortInputGUI::setValue

(

$a_value

)

Set Value.

Parameters

string

$a_value

Value

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

Referenced by ilObjGlossaryGUI\initSettingsForm(), and setValueByArray().

    {
        $this->value = $a_value;
    }

Here is the caller graph for this function:

setValueByArray()

ilGloAdvColSortInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

Definition at line 117 of file class.ilGloAdvColSortInputGUI.php.

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

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

Here is the call graph for this function:

---

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

• Modules/Glossary/classes/class.ilGloAdvColSortInputGUI.php