ilCustomInputGUI Class Reference

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

Inheritance diagram for ilCustomInputGUI:

Collaboration diagram for ilCustomInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")
	setHtml (string $a_html)
	getHtml ()
	setValueByArray (array $a_values)
	insert (ilTemplate $a_tpl)
	setSkipRequiredCheck (bool $skip)
	checkInput ()
	getInput ()
Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)
	getSubItems ()
	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...
	checkSubItemsInput ()
	Check SubItems. More...
	getSubForm ()
	getItemByPostVar (string $a_post_var)
Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")
	executeCommand ()
	getType ()
	setTitle (string $a_title)
	getTitle ()
	setPostVar (string $a_postvar)
	getPostVar ()
	getFieldId ()
	setInfo (string $a_info)
	getInfo ()
	setAlert (string $a_alert)
	getAlert ()
	setRequired (bool $a_required)
	getRequired ()
	setDisabled (bool $a_disabled)
	getDisabled ()
	checkInput ()
	Check input, strip slashes etc. More...
	setParentForm (ilPropertyFormGUI $a_parentform)
	getParentForm ()
	setParent (ilFormPropertyGUI $a_val)
	getParent ()
	getSubForm ()
	hideSubForm ()
	setHiddenTitle (string $a_val)
	getHiddenTitle ()
	getItemByPostVar (string $a_post_var)
	Get item by post var. More...
	serializeData ()
	unserializeData (string $a_data)
	setParentTable ($a_val)
	Set parent table. More...
	getParentTable ()
	Get parent table. More...
	writeToSession ()
	clearFromSession ()
	readFromSession ()
	getHiddenTag (string $a_post_var, string $a_value)
	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)
	getMulti ()
	setMultiValues (array $a_values)
	getMultiValues ()
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...
	stripSlashesAddSpaceFallback (string $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...
	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Protected Attributes
bool	$skip_required_check = false
string	$html = ""
Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()
Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []
ilTable2GUI	$parent_table = null
ilFormPropertyGUI	$parent_gui = null
ilCtrl	$ctrl
ilLanguage	$lng
string	$type = ""
string	$title = ""
string	$postvar = ""
string	$info = ""
string	$alert = ""
bool	$required = false
ilPropertyFormGUI	$parentform = null
string	$hidden_title = ""
bool	$multi = false
bool	$multi_sortable = false
bool	$multi_addremove = true
array	$multi_values = []
RequestInterface	$request
HTTP Services	$http
Refinery Factory	$refinery = null
bool	$disabled = false
ilGlobalTemplateInterface	$global_tpl = null

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...
Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()
	setType (string $a_type)
	checkParentFormTable ()
	getSessionKey ()
	getMultiIconsHTML ()
	int ($key)
	intArray ($key)
	str ($key)
	raw ($key)
	strArray ($key)
	arrayArray ($key)
	isRequestParamArray (string $key)
	getRequestParam (string $key, Refinery\Transformation $t)

Detailed Description

This class represents a custom property in a property form.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Deprecated:

Deprecated since 4.4, inherit directly from InputGUI instead

12 This component will be removed with ILIAS 12

Definition at line 28 of file class.ilCustomInputGUI.php.

Constructor & Destructor Documentation

__construct()

ilCustomInputGUI::__construct	(	string	$a_title = "",
		string	$a_postvar = ""
	)

Definition at line 33 of file class.ilCustomInputGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setType().

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

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilCustomInputGUI::checkInput

(

)

Definition at line 72 of file class.ilCustomInputGUI.php.

References ilFormPropertyGUI\$lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), getInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilLanguage\txt().

                                : bool
    {
        $lng = $this->lng;

        if ($this->getPostVar()) {
            if (!$this->skip_required_check && $this->getRequired() && $this->getInput() == "") {
                $this->setAlert($lng->txt("msg_input_is_required"));
                return false;
            }
        }
        return $this->checkSubItemsInput();
    }

Here is the call graph for this function:

getHtml()

ilCustomInputGUI::getHtml

(

)

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

References $html.

Referenced by insert().

                             : string
    {
        return $this->html;
    }

Here is the caller graph for this function:

getInput()

ilCustomInputGUI::getInput

(

)

Definition at line 85 of file class.ilCustomInputGUI.php.

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

Referenced by checkInput().

                              : string
    {
        return trim($this->str($this->getPostVar()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilCustomInputGUI::insert

(

ilTemplate

$a_tpl

)

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

References getHtml(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                             : void
    {
        $a_tpl->setCurrentBlock("prop_custom");
        $a_tpl->setVariable("CUSTOM_CONTENT", $this->getHtml());
        $a_tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

setHtml()

ilCustomInputGUI::setHtml

(

string

$a_html

)

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

References ILIAS\Repository\html().

Referenced by ilMemberAgreementGUI\addExportFieldInfo(), ilMailFolderGUI\confirmDeleteMails(), ilRegistrationGUI\fillMembershipLimitation(), ilCourseObjectivesGUI\initFormLimits(), and assQuestionGUI\suggestedsolution().

                                           : void
    {
        $this->html = $a_html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSkipRequiredCheck()

ilCustomInputGUI::setSkipRequiredCheck

(

bool

$skip

)

Definition at line 67 of file class.ilCustomInputGUI.php.

                                                    : void
    {
        $this->skip_required_check = $skip;
    }

setValueByArray()

ilCustomInputGUI::setValueByArray

(

array

$a_values

)

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

References ilSubEnabledFormPropertyGUI\getSubItems().

                                                    : void
    {
        foreach ($this->getSubItems() as $item) {
            $item->setValueByArray($a_values);
        }
    }

Here is the call graph for this function:

Field Documentation

$html

string ilCustomInputGUI::$html = ""

protected

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

Referenced by getHtml().

$skip_required_check

bool ilCustomInputGUI::$skip_required_check = false

protected

Definition at line 30 of file class.ilCustomInputGUI.php.

---

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

• components/ILIAS/Form/classes/class.ilCustomInputGUI.php