ilSelectBuilderInputGUI Class Reference

Input GUI for the configuration of select input elements. More...

Inheritance diagram for ilSelectBuilderInputGUI:

Collaboration diagram for ilSelectBuilderInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	getOpenAnswerIndexes ()
	Get open answer indexes. More...
	setOpenAnswerIndexes ($a_indexes)
	Set open answer indexes. More...
	addOpenAnswerIndex ($a_idx)
	Mark an index as open answer. More...
	isOpenAnswerIndex ($a_idx)
	Check if an index is an open answer index. More...
	checkInput ()
	Check input, strip slashes etc. More...
	setValueByArray ($a_values)
	Set value by array. More...
	insert ($a_tpl)
	Insert property html. More...
Public Member Functions inherited from ilTextWizardInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setValues ($a_values)
	Set Values. More...
	setValue ($a_value)
	Set Value. More...
	getValues ()
	Get Values. More...
	setAllowMove ($a_allow_move)
	Set allow move. More...
	getAllowMove ()
	Get allow move. More...
	checkInput ()
	Check input, strip slashes etc. More...
	insert ($a_tpl)
	Insert property html. More...
	render ($a_mode="")
Public Member Functions inherited from ilTextInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setValue ($a_value)
	Set Value. More...
	getValue ()
	Get Value. More...
	setValidationFailureMessage ($a_msg)
	Set message string for validation failure. More...
	getValidationFailureMessage ()
	setValidationRegexp ($a_value)
	Set validation regexp. More...
	getValidationRegexp ()
	Get validation regexp. More...
	setMaxLength ($a_maxlength)
	Set Max Length. More...
	getMaxLength ()
	Get Max Length. More...
	setSize ($a_size)
	Set Size. More...
	setInlineStyle ($a_style)
	Set inline style. More...
	getInlineStyle ()
	Get inline style. More...
	setCssClass ($a_class)
	getCssClass ()
	setValueByArray ($a_values)
	Set value by array. More...
	getSize ()
	Get Size. More...
	setSuffix ($a_value)
	Set suffix. More...
	getSuffix ()
	Get suffix. More...
	setInputType ($a_type)
	set input type More...
	getInputType ()
	get input type More...
	setSubmitFormOnEnter ($a_val)
	Set submit form on enter. More...
	getSubmitFormOnEnter ()
	Get submit form on enter. More...
	checkInput ()
	Check input, strip slashes etc. More...
	getDataSource ()
	get datasource link for js autocomplete More...
	setDataSource ($href, $a_delimiter=null)
	set datasource link for js autocomplete More...
	setDataSourceSubmitOnSelection ($a_stat)
	getDataSourceSubmitOnSelection ()
	setDataSourceSubmitUrl ($a_url)
	getDataSourceSubmitUrl ()
	setMultiValues (array $a_values)
	Set multi values. More...
	insert ($a_tpl)
	Insert property html. More...
	getTableFilterHTML ()
	Get HTML for table filter. More...
	getToolbarHTML ()
	Get HTML for toolbar. More...
	setDisableHtmlAutoComplete ($autocomplete)
	isHtmlAutoCompleteDisabled ()
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...
	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...
	getFormLabelFor ()
	Get label "for" attribute value for form. More...
Public Member Functions inherited from ilTableFilterItem
	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...
	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Protected Attributes
	$tpl
	$open_answer_indexes = array()
Protected Attributes inherited from ilTextWizardInputGUI
	$tpl
	$values = array()
	$allowMove = false
Protected Attributes inherited from ilTextInputGUI
	$value
	$maxlength = 200
	$size = 40
	$validationRegexp
	$validationFailureMessage = ''
	$suffix
	$style_css
	$css_class
	$ajax_datasource
	$ajax_datasource_delimiter
	$ajax_datasource_commit = false
	$ajax_datasource_commit_url
	$submit_form_on_enter = false
	$autocomplete_disabled = false
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

Input GUI for the configuration of select input elements.

E.g course custum field, udf field, ...

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 12 of file class.ilSelectBuilderInputGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilTextWizardInputGUI.

Definition at line 24 of file class.ilSelectBuilderInputGUI.php.

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

addOpenAnswerIndex()

ilSelectBuilderInputGUI::addOpenAnswerIndex

(

$a_idx

)

Mark an index as open answer.

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

    {
        $this->open_answer_indexes[] = $a_idx;
    }

Referenced by checkInput(), and setValueByArray().

Here is the caller graph for this function:

checkInput()

ilSelectBuilderInputGUI::checkInput

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Returns

boolean Input ok, true/false

Reimplemented from ilTextWizardInputGUI.

Definition at line 73 of file class.ilSelectBuilderInputGUI.php.

    {
        $lng = $this->lng;
        
        $foundvalues = $_POST[$this->getPostVar()];
        
        
        
        $this->setOpenAnswerIndexes(array());
        if (is_array($foundvalues)) {
            foreach ($foundvalues as $idx => $value) {
                $_POST[$this->getPostVar()][$idx] = ilUtil::stripSlashes($value);
                if ($this->getRequired() && trim($value) == "") {
                    $this->setAlert($lng->txt("msg_input_is_required"));
 
                    return false;
                } elseif (strlen($this->getValidationRegexp())) {
                    if (!preg_match($this->getValidationRegexp(), $value)) {
                        $this->setAlert($lng->txt("msg_wrong_format"));
                        return false;
                    }
                }
            }
        } else {
            $this->setAlert($lng->txt("msg_input_is_required"));
            return false;
        }
        
        foreach ((array) $_POST[$this->getPostVar() . '_open'] as $oindex => $ovalue) {
            $this->addOpenAnswerIndex($oindex);
        }
        
        
        return $this->checkSubItemsInput();
    }

References $_POST, ilFormPropertyGUI\$lng, ilTextInputGUI\$value, addOpenAnswerIndex(), ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilTextInputGUI\getValidationRegexp(), ilFormPropertyGUI\setAlert(), setOpenAnswerIndexes(), and ilUtil\stripSlashes().

Here is the call graph for this function:

getOpenAnswerIndexes()

ilSelectBuilderInputGUI::getOpenAnswerIndexes

(

)

Get open answer indexes.

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

    {
        return $this->open_answer_indexes;
    }

References $open_answer_indexes.

insert()

ilSelectBuilderInputGUI::insert

(

$a_tpl

)

Insert property html.

Returns

int Size

Reimplemented from ilTextWizardInputGUI.

Definition at line 123 of file class.ilSelectBuilderInputGUI.php.

    {
        $lng = $this->lng;
        
        $tpl = new ilTemplate("tpl.prop_selectbuilder.html", true, true, "Services/Form");
        $i = 0;
        foreach ($this->values as $value) {
            if (!is_string($value)) {
                continue;
            }
            
            if (strlen((string) $value)) {
                $tpl->setCurrentBlock("prop_text_propval");
                $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput((string) $value));
                $tpl->parseCurrentBlock();
            }
            if ($this->getAllowMove()) {
                $tpl->setCurrentBlock("move");
                $tpl->setVariable("CMD_UP", "cmd[up" . $this->getFieldId() . "][$i]");
                $tpl->setVariable("CMD_DOWN", "cmd[down" . $this->getFieldId() . "][$i]");
                $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
                include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                $tpl->setVariable("UP_BUTTON", ilGlyphGUI::get(ilGlyphGUI::UP));
                $tpl->setVariable("DOWN_BUTTON", ilGlyphGUI::get(ilGlyphGUI::DOWN));
 
                $tpl->parseCurrentBlock();
            }
            $tpl->setCurrentBlock("row");
            $tpl->setVariable("POST_VAR", $this->getPostVar() . "[$i]");
            #$tpl->setVariable('POST_VAR_OPEN',$this->getPostVar().'[open]'.'['.$i.']');
            $tpl->setVariable('POST_VAR_OPEN', $this->getPostVar() . '_open' . '[' . $i . ']');
            $tpl->setVariable('POST_VAR_OPEN_ID', $this->getPostVar() . '_open[' . $i . ']');
            $tpl->setVariable('TXT_OPEN', $lng->txt("form_open_answer"));
            
            if ($this->isOpenAnswerIndex($i)) {
                $tpl->setVariable('PROP_OPEN_CHECKED', 'checked="checked"');
            }
            if ($this->getDisabled()) {
                $tpl->setVariable('PROP_OPEN_DISABLED', 'disabled="disabled"');
            }
            
            $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
            $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
            $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
            $tpl->setVariable("SIZE", $this->getSize());
            $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
            if ($this->getDisabled()) {
                $tpl->setVariable(
                    "DISABLED",
                    " disabled=\"disabled\""
                );
            }
            include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
            $tpl->setVariable("ADD_BUTTON", ilGlyphGUI::get(ilGlyphGUI::ADD));
            $tpl->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
            $tpl->parseCurrentBlock();
            $i++;
        }
        $tpl->setVariable("ELEMENT_ID", $this->getFieldId());
 
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
        $a_tpl->parseCurrentBlock();
        
        $tpl = $this->tpl;
        $tpl->addJavascript("./Services/Form/js/ServiceFormWizardInput.js");
        $tpl->addJavascript("./Services/Form/templates/default/textwizard.js");
    }

References $i, ilFormPropertyGUI\$lng, $tpl, ilTextInputGUI\$value, ilGlyphGUI\ADD, ilGlyphGUI\DOWN, ilGlyphGUI\get(), ilTextWizardInputGUI\getAllowMove(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilTextInputGUI\getMaxLength(), ilFormPropertyGUI\getPostVar(), ilTextInputGUI\getSize(), isOpenAnswerIndex(), ilUtil\prepareFormOutput(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

Here is the call graph for this function:

isOpenAnswerIndex()

ilSelectBuilderInputGUI::isOpenAnswerIndex

(

$a_idx

)

Check if an index is an open answer index.

Parameters

type

$a_idx

Returns

type

Definition at line 63 of file class.ilSelectBuilderInputGUI.php.

    {
        return in_array($a_idx, (array) $this->open_answer_indexes);
    }

Referenced by insert().

Here is the caller graph for this function:

setOpenAnswerIndexes()

ilSelectBuilderInputGUI::setOpenAnswerIndexes

(

$a_indexes

)

Set open answer indexes.

Definition at line 45 of file class.ilSelectBuilderInputGUI.php.

    {
        $this->open_answer_indexes = $a_indexes;
    }

Referenced by checkInput().

Here is the caller graph for this function:

setValueByArray()

ilSelectBuilderInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

Reimplemented from ilTextInputGUI.

Definition at line 109 of file class.ilSelectBuilderInputGUI.php.

    {
        parent::setValueByArray($a_values);
        
        foreach ((array) $_POST[$this->getPostVar() . '_open'] as $oindex => $ovalue) {
            $this->addOpenAnswerIndex($oindex);
        }
    }

References $_POST, addOpenAnswerIndex(), and ilFormPropertyGUI\getPostVar().

Here is the call graph for this function:

Field Documentation

$open_answer_indexes

ilSelectBuilderInputGUI::$open_answer_indexes = array()

protected

Definition at line 20 of file class.ilSelectBuilderInputGUI.php.

Referenced by getOpenAnswerIndexes().

$tpl

ilSelectBuilderInputGUI::$tpl

protected

Definition at line 17 of file class.ilSelectBuilderInputGUI.php.

Referenced by insert().

---

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

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