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

Inheritance diagram for ilCustomInputGUI:

Collaboration diagram for ilCustomInputGUI:

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

	setHtml ($a_html)
	Set Html. More...

	getHtml ()
	Get Html. More...

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

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

	checkInput ()
	Check input, strip slashes etc. 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...

Protected Attributes
	$lng

	$html

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 custom property in a property form.

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

Version: $Id$

Deprecated:: Deprecated since 4.4, inherit directly from InputGUI instead

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References $DIC, 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 ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

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

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

     {
         $lng = $this->lng;
         
         if ($this->getPostVar()) {
             $_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 $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ getHtml()

ilCustomInputGUI::getHtml ( )

Get Html.

Returns: string Html

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

References $html.

Referenced by insert().

     {
         return $this->html;
     }

Here is the caller graph for this function:

◆ insert()

ilCustomInputGUI::insert ( $a_tpl )

Insert property html.

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

References getHtml().

     {
         $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 ( $a_html )

Set Html.

Parameters

string $a_html Html

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

References html().

Referenced by ilMemberAgreementGUI\addExportFieldInfo(), ilTestScoringGUI\buildManScoringParticipantForm(), ilMailFolderGUI\cancelDeleteMails(), ilObjPDFGenerationGUI\configForm(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilCourseRegistrationGUI\fillMaxMembers(), ilGroupRegistrationGUI\fillMaxMembers(), ilRegistrationGUI\fillMembershipLimitation(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilBibliographicDetailsGUI\getInstance(), ilCourseObjectivesGUI\initFormLimits(), and ilAdministrationSettingsFormHandler\parseFieldDefinition().

     {
         $this->html = $a_html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueByArray()

ilCustomInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

object $a_item Item

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

References ilSubEnabledFormPropertyGUI\getSubItems().

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

Here is the call graph for this function:

Field Documentation

◆ $html

ilCustomInputGUI::$html

protected

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

Referenced by getHtml().

◆ $lng

ilCustomInputGUI::$lng

protected

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

Referenced by checkInput().

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

Services/Form/classes/class.ilCustomInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getHtml()

◆ insert()

◆ setHtml()

◆ setValueByArray()

Field Documentation

◆ $html

◆ $lng