This class represents a number property in a property form. More...

Inheritance diagram for ilCombinationInputGUI:

Collaboration diagram for ilCombinationInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	addCombinationItem ($id, $item, $label="")
	Add property item. More...

	getCombinationItem ($id)
	Get property item. More...

	removeCombinationItem ($id)
	Remove property item. More...

	__call ($method, $param)
	Call item methods. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	setComparisonMode ($mode)
	Set mode for comparison (extended validation) More...

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setValueByArray ($a_values)
	Set value by array. More...

	checkInput ()
	Check input, strip slashes etc. More...

	insert ($a_tpl)
	Insert property html. More...

	render ()
	Render item. More...

	getTableFilterHTML ()
	Get HTML for table filter. More...

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. 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...

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

Data Fields
const	COMPARISON_ASCENDING = 1

const	COMPARISON_DESCENDING = 2

Protected Attributes
	$lng

	$items = array()

	$labels

	$comparison

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

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...

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Detailed Description

This class represents a number property in a property form.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 31 of file class.ilCombinationInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCombinationInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Reimplemented from ilFormPropertyGUI.

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

    {
        parent::__construct($a_title, $a_postvar);
        global $DIC;
 
        $this->lng = $DIC->language();
    }

References $DIC.

Member Function Documentation

◆ __call()

ilCombinationInputGUI::__call	(	$method,
		$param
	)

Call item methods.

Parameters

string	$method
array	$param

Definition at line 103 of file class.ilCombinationInputGUI.php.

    {
        $result = array();
        foreach ($this->items as $id => $obj) {
            if (method_exists($obj, $method)) {
                $result[$id] = call_user_func_array(array($obj, $method), $param);
            }
        }
        return $result;
    }

References $id, and $result.

◆ addCombinationItem()

ilCombinationInputGUI::addCombinationItem	(	$id,
		$item,
		$label = `""`
	)

Add property item.

Parameters

string	$id
object	$item
string	$label

Definition at line 64 of file class.ilCombinationInputGUI.php.

    {
        $this->items[$id] = $item;
        if ($label) {
            $this->labels[$id] = $label;
        }
    }

References $id.

◆ checkInput()

ilCombinationInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

Definition at line 242 of file class.ilCombinationInputGUI.php.

    {
        if (sizeof($this->items)) {
            foreach ($this->items as $id => $obj) {
                if (!$obj->checkInput()) {
                    return false;
                }
            }
 
            if ($this->comparison_mode) {
                $prev = null;
                foreach ($this->items as $id => $obj) {
                    $value = $obj->getPostValueForComparison();
                    if ($value != "") {
                        if ($prev !== null) {
                            if ($this->comparison_mode == self::COMPARISON_ASCENDING) {
                                if ($value < $prev) {
                                    return false;
                                }
                            } else {
                                if ($value > $prev) {
                                    return false;
                                }
                            }
                        }
                        $prev = $value;
                    }
                }
            }
        }
 
        return $this->checkSubItemsInput();
    }

References $id, and ilSubEnabledFormPropertyGUI\checkSubItemsInput().

Here is the call graph for this function:

◆ getCombinationItem()

ilCombinationInputGUI::getCombinationItem ( $id )

Get property item.

Parameters

string $id

Returns: object

Definition at line 78 of file class.ilCombinationInputGUI.php.

    {
        if (isset($this->items[$id])) {
            return $this->items[$id];
        }
    }

References $id.

◆ getTableFilterHTML()

ilCombinationInputGUI::getTableFilterHTML ( )

Get HTML for table filter.

Implements ilTableFilterItem.

Definition at line 320 of file class.ilCombinationInputGUI.php.

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

References $html, and render().

Here is the call graph for this function:

◆ getValue()

ilCombinationInputGUI::getValue ( )

Get Value.

Returns: string Value

Definition at line 210 of file class.ilCombinationInputGUI.php.

    {
        $result = array();
        foreach ($this->items as $id => $obj) {
            if (method_exists($obj, "getValue")) {
                $result[$id] = $obj->getValue();
            }
            // datetime
            elseif (method_exists($obj, "setDate")) {
                $result[$id] = $obj->getDate();
            }
        }
        return $result;
    }

References $id, and $result.

◆ insert()

ilCombinationInputGUI::insert ( $a_tpl )

Insert property html.

Returns: int Size

Definition at line 281 of file class.ilCombinationInputGUI.php.

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

References $html, and render().

Here is the call graph for this function:

◆ removeCombinationItem()

ilCombinationInputGUI::removeCombinationItem ( $id )

Remove property item.

Parameters

string $id

Definition at line 90 of file class.ilCombinationInputGUI.php.

    {
        if (isset($this->items[$id])) {
            unset($this->items[$id]);
        }
    }

References $id.

◆ render()

ilCombinationInputGUI::render ( )

Render item.

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

    {
        $lng = $this->lng;
 
        $tpl = new ilTemplate("tpl.prop_combination.html", true, true, "Services/Form");
 
        if (sizeof($this->items)) {
            foreach ($this->items as $id => $obj) {
                // label
                if (isset($this->labels[$id])) {
                    $tpl->setCurrentBlock("prop_combination_label");
                    $tpl->setVariable("LABEL", $this->labels[$id]);
                    $tpl->parseCurrentBlock();
                }
 
                $tpl->setCurrentBlock("prop_combination");
                $tpl->setVariable("FIELD", $obj->render());
                $tpl->parseCurrentBlock();
            }
        }
 
        return $tpl->get();
    }

References $id, $lng, and $tpl.

Referenced by getTableFilterHTML(), and insert().

Here is the caller graph for this function:

◆ serializeData()

ilCombinationInputGUI::serializeData ( )

serialize data

Reimplemented from ilFormPropertyGUI.

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

    {
        $result = array();
        foreach ($this->items as $id => $obj) {
            $result[$id] = $obj->serializeData();
        }
        return serialize($result);
    }

References $id, and $result.

◆ setComparisonMode()

ilCombinationInputGUI::setComparisonMode ( $mode )

Set mode for comparison (extended validation)

Parameters

int $mode

Returns: bool

Definition at line 152 of file class.ilCombinationInputGUI.php.

    {
        if (in_array($mode, array(self::COMPARISON_ASCENDING, self::COMPARISON_DESCENDING))) {
            foreach ($this->items as $obj) {
                if (!method_exists($obj, "getPostValueForComparison")) {
                    return false;
                }
            }
            $this->comparison_mode = $mode;
            return true;
        }
    }

◆ setValue()

ilCombinationInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

Definition at line 170 of file class.ilCombinationInputGUI.php.

    {
        if (is_array($a_value)) {
            foreach ($a_value as $id => $value) {
                if (isset($this->items[$id])) {
                    if (method_exists($this->items[$id], "setValue")) {
                        $this->items[$id]->setValue($value);
                    }
                    // datetime
                    elseif (method_exists($this->items[$id], "setDate")) {
                        $this->items[$id]->setDate($value);
                    }
                }
            }
        } elseif ($a_value === null) {
            foreach ($this->items as $item) {
                if (method_exists($item, "setValue")) {
                    $item->setValue(null);
                }
                // datetime
                elseif (method_exists($item, "setDate")) {
                    $item->setDate();
                }
                // duration
                elseif (method_exists($item, "setMonths")) {
                    $item->setMonths(0);
                    $item->setDays(0);
                    $item->setHours(0);
                    $item->setMinutes(0);
                    $item->setSeconds(0);
                }
            }
        }
    }

References $id.

Referenced by unserializeData().

Here is the caller graph for this function:

◆ setValueByArray()

ilCombinationInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 230 of file class.ilCombinationInputGUI.php.

    {
        foreach ($this->items as $id => $obj) {
            $obj->setValueByArray($a_values);
        }
    }

References $id.

◆ unserializeData()

ilCombinationInputGUI::unserializeData ( $a_data )

unserialize data

Reimplemented from ilFormPropertyGUI.

Definition at line 129 of file class.ilCombinationInputGUI.php.

    {
        $data = unserialize($a_data);
 
        if ($data) {
            foreach ($this->items as $id => $obj) {
                $obj->unserializeData($data[$id]);
            }
        } else {
            foreach ($this->items as $id => $obj) {
                if (method_exists($obj, "setValue")) {
                    $this->setValue(false);
                }
            }
        }
    }