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

Inheritance diagram for ilPasswordInputGUI:

Collaboration diagram for ilPasswordInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	setValue (string $a_value)

	getValue ()

	setRetype (bool $a_val)

	getRetype ()

	setRetypeValue (string $a_retypevalue)

	getRetypeValue ()

	setMaxLength (int $a_maxlength)

	getMaxLength ()

	setSize (int $a_size)

	setValueByArray (array $a_values)

	getSize ()

	setValidateAuthPost (string $a_validateauthpost)

	getValidateAuthPost ()

	setRequiredOnAuth (bool $a_requiredonauth)

	getRequiredOnAuth ()

	setSkipSyntaxCheck (bool $a_val)

	getSkipSyntaxCheck ()

	setDisableHtmlAutoComplete (bool $a_value)

	isHtmlAutoCompleteDisabled ()

	setUseStripSlashes (bool $a_stat)
	En/disable use of stripslashes. More...

	getUseStripSlashes ()

	checkInput ()

	getInput ()

	render ()

	insert (ilTemplate $a_tpl)

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_syntax_check = false

string	$value = ""

int	$size = 20

string	$validateauthpost = ""

bool	$requiredonauth = false

int	$maxlength = 0

bool	$use_strip_slashes = true

bool	$autocomplete_disabled = true

string	$retypevalue = ""

bool	$retype = false

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

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

Definition at line 26 of file class.ilPasswordInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPasswordInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), setRetype(), and setSkipSyntaxCheck().

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

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilPasswordInputGUI::checkInput ( )

Definition at line 168 of file class.ilPasswordInputGUI.php.

References ilFormPropertyGUI\$lng, ilAuthUtils\_allowPasswordModificationByAuthMode(), ilAuthUtils\_getAuthMode(), ilSubEnabledFormPropertyGUI\checkSubItemsInput(), getInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getRequiredOnAuth(), getRetype(), getSkipSyntaxCheck(), getUseStripSlashes(), getValidateAuthPost(), ilSecuritySettingsChecker\isPassword(), ilFormPropertyGUI\raw(), ilFormPropertyGUI\setAlert(), ilFormPropertyGUI\str(), and ilLanguage\txt().

                                 : bool
     {
         $lng = $this->lng;
 
         $pass_value = $this->getInput();
         $retype_value = ($this->getUseStripSlashes())
             ? $this->str($this->getPostVar() . "_retype")
             : $this->raw($this->getPostVar() . "_retype");
 
         if ($this->getRequired() && trim($pass_value) == "") {
             $this->setAlert($lng->txt("msg_input_is_required"));
             return false;
         }
         if ($this->getValidateAuthPost() != "") {
             $auth = ilAuthUtils::_getAuthMode($this->str($this->getValidateAuthPost()));
 
             // check, if password is required dependent on auth mode
             if ($this->getRequiredOnAuth() && ilAuthUtils::_allowPasswordModificationByAuthMode($auth)
                 && trim($pass_value) == "") {
                 $this->setAlert($lng->txt("form_password_required_for_auth"));
                 return false;
             }
 
             // check, if password is allowed to be set for given auth mode
             if (trim($pass_value) != "" &&
                 !ilAuthUtils::_allowPasswordModificationByAuthMode($auth)) {
                 $this->setAlert($lng->txt("form_password_not_allowed_for_auth"));
                 return false;
             }
         }
         if ($this->getRetype() &&
             ($pass_value != $retype_value)) {
             $this->setAlert($lng->txt("passwd_not_match"));
             return false;
         }
         if (!$this->getSkipSyntaxCheck() &&
             !ilSecuritySettingsChecker::isPassword($pass_value, $custom_error) &&
             $pass_value != "") {
             if ($custom_error != '') {
                 $this->setAlert($custom_error);
             } else {
                 $this->setAlert($lng->txt("passwd_invalid"));
             }
             return false;
         }
 
         return $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ getInput()

ilPasswordInputGUI::getInput ( )

Definition at line 217 of file class.ilPasswordInputGUI.php.

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

Referenced by checkInput().

                               : string
     {
         if ($this->getUseStripSlashes()) {
             return $this->str($this->getPostVar());
         }
         return $this->raw($this->getPostVar());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxLength()

ilPasswordInputGUI::getMaxLength ( )

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

References $maxlength.

Referenced by render().

                                   : int
     {
         return $this->maxlength;
     }

Here is the caller graph for this function:

◆ getRequiredOnAuth()

ilPasswordInputGUI::getRequiredOnAuth ( )

Definition at line 128 of file class.ilPasswordInputGUI.php.

References $requiredonauth.

Referenced by checkInput().

                                        : bool
     {
         return $this->requiredonauth;
     }

Here is the caller graph for this function:

◆ getRetype()

ilPasswordInputGUI::getRetype ( )

Definition at line 70 of file class.ilPasswordInputGUI.php.

References $retype.

Referenced by checkInput(), and render().

                                : bool
     {
         return $this->retype;
     }

Here is the caller graph for this function:

◆ getRetypeValue()

ilPasswordInputGUI::getRetypeValue ( )

Definition at line 80 of file class.ilPasswordInputGUI.php.

References $retypevalue.

Referenced by render().

                                     : string
     {
         return $this->retypevalue;
     }

Here is the caller graph for this function:

◆ getSize()

ilPasswordInputGUI::getSize ( )

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

References $size.

Referenced by render().

                              : int
     {
         return $this->size;
     }

Here is the caller graph for this function:

◆ getSkipSyntaxCheck()

ilPasswordInputGUI::getSkipSyntaxCheck ( )

Definition at line 138 of file class.ilPasswordInputGUI.php.

References $skip_syntax_check.

Referenced by checkInput().

                                         : bool
     {
         return $this->skip_syntax_check;
     }

Here is the caller graph for this function:

◆ getUseStripSlashes()

ilPasswordInputGUI::getUseStripSlashes ( )

Definition at line 163 of file class.ilPasswordInputGUI.php.

References $use_strip_slashes.

Referenced by checkInput(), and getInput().

                                         : bool
     {
         return $this->use_strip_slashes;
     }

Here is the caller graph for this function:

◆ getValidateAuthPost()

ilPasswordInputGUI::getValidateAuthPost ( )

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

References $validateauthpost.

Referenced by checkInput().

                                          : string
     {
         return $this->validateauthpost;
     }

Here is the caller graph for this function:

◆ getValue()

ilPasswordInputGUI::getValue ( )

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

References $value.

Referenced by render().

                               : string
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilPasswordInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 290 of file class.ilPasswordInputGUI.php.

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

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

Here is the call graph for this function:

◆ isHtmlAutoCompleteDisabled()

ilPasswordInputGUI::isHtmlAutoCompleteDisabled ( )

Definition at line 148 of file class.ilPasswordInputGUI.php.

References $autocomplete_disabled.

Referenced by render().

                                                 : bool
     {
         return $this->autocomplete_disabled;
     }

Here is the caller graph for this function:

◆ render()

ilPasswordInputGUI::render ( )

Definition at line 225 of file class.ilPasswordInputGUI.php.

References ilFormPropertyGUI\$lng, ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), getMaxLength(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getRetype(), getRetypeValue(), getSize(), getValue(), isHtmlAutoCompleteDisabled(), ilLegacyFormElementsUtil\prepareFormOutput(), and ilLanguage\txt().

Referenced by insert().

                             : string
     {
         $lng = $this->lng;
 
         $ptpl = new ilTemplate("tpl.prop_password.html", true, true, "components/ILIAS/Form");
 
         if ($this->getRetype()) {
             $ptpl->setCurrentBlock("retype");
             $ptpl->setVariable("RSIZE", $this->getSize());
             $ptpl->setVariable("RID", $this->getFieldId());
             if ($this->getMaxLength() > 0) {
                 $ptpl->setCurrentBlock("rmaxlength");
                 $ptpl->setVariable("RMAXLENGTH", $this->getMaxLength());
                 $ptpl->parseCurrentBlock();
             }
             $ptpl->setVariable("RPOST_VAR", $this->getPostVar());
 
             if ($this->isHtmlAutoCompleteDisabled()) {
                 $ptpl->setVariable("RAUTOCOMPLETE", "autocomplete=\"off\"");
             }
 
             // this is creating an "auto entry" in the setup, if the retype is missing
             /*$retype_value = ($this->getRetypeValue() != "")
                 ? $this->getRetypeValue()
                 : $this->getValue();*/
             $retype_value = $this->getRetypeValue();
             $ptpl->setVariable("PROPERTY_RETYPE_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($retype_value));
             if ($this->getDisabled()) {
                 $ptpl->setVariable(
                     "RDISABLED",
                     " disabled=\"disabled\""
                 );
             }
             $ptpl->setVariable("TXT_RETYPE", $lng->txt("form_retype_password"));
             $ptpl->parseCurrentBlock();
         }
 
         if (strlen($this->getValue())) {
             $ptpl->setCurrentBlock("prop_password_propval");
             $ptpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($this->getValue()));
             $ptpl->parseCurrentBlock();
         }
         $ptpl->setVariable("POST_VAR", $this->getPostVar());
         $ptpl->setVariable("ID", $this->getFieldId());
         $ptpl->setVariable("SIZE", $this->getSize());
         if ($this->getMaxLength() > 0) {
             $ptpl->setCurrentBlock("maxlength");
             $ptpl->setVariable("MAXLENGTH", $this->getMaxLength());
             $ptpl->parseCurrentBlock();
         }
         if ($this->getDisabled()) {
             $ptpl->setVariable(
                 "DISABLED",
                 " disabled=\"disabled\""
             );
         }
         if ($this->isHtmlAutoCompleteDisabled()) {
             $ptpl->setVariable("AUTOCOMPLETE", "autocomplete=\"off\"");
         }
         if ($this->getRequired()) {
             $ptpl->setVariable("REQUIRED", "required=\"required\"");
         }
         return $ptpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDisableHtmlAutoComplete()

ilPasswordInputGUI::setDisableHtmlAutoComplete ( bool $a_value )

Definition at line 143 of file class.ilPasswordInputGUI.php.

                                                              : void
     {
         $this->autocomplete_disabled = $a_value;
     }

◆ setMaxLength()

ilPasswordInputGUI::setMaxLength ( int $a_maxlength )

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

                                                   : void
     {
         $this->maxlength = $a_maxlength;
     }

◆ setRequiredOnAuth()

ilPasswordInputGUI::setRequiredOnAuth ( bool $a_requiredonauth )

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

                                                              : void
     {
         $this->requiredonauth = $a_requiredonauth;
     }

◆ setRetype()

ilPasswordInputGUI::setRetype ( bool $a_val )

Definition at line 65 of file class.ilPasswordInputGUI.php.

Referenced by __construct(), ilObjMailGUI\getExternalSettingsForm(), ilSharedResourceGUI\initPasswordForm(), ilObjWorkspaceFolderGUI\initPasswordForm(), and ilECSSettingsGUI\initSettingsForm().

                                           : void
     {
         $this->retype = $a_val;
     }

Here is the caller graph for this function:

◆ setRetypeValue()

ilPasswordInputGUI::setRetypeValue ( string $a_retypevalue )

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

Referenced by setValueByArray().

                                                          : void
     {
         $this->retypevalue = $a_retypevalue;
     }

Here is the caller graph for this function:

◆ setSize()

ilPasswordInputGUI::setSize ( int $a_size )

Definition at line 95 of file class.ilPasswordInputGUI.php.

                                         : void
     {
         $this->size = $a_size;
     }

◆ setSkipSyntaxCheck()

ilPasswordInputGUI::setSkipSyntaxCheck ( bool $a_val )

Definition at line 133 of file class.ilPasswordInputGUI.php.

Referenced by __construct(), ilLDAPSettingsGUI\initForm(), and ilOpenIdConnectSettingsGUI\initSettingsForm().

                                                    : void
     {
         $this->skip_syntax_check = $a_val;
     }

Here is the caller graph for this function:

◆ setUseStripSlashes()

ilPasswordInputGUI::setUseStripSlashes ( bool $a_stat )

En/disable use of stripslashes.

e.g on login screen. Otherwise passwords containing "<" are stripped and therefor authentication fails against external authentication services.

Definition at line 158 of file class.ilPasswordInputGUI.php.

Referenced by ilUserProfile\getPasswordInput(), and ilObjUserGUI\initForm().

                                                     : void
     {
         $this->use_strip_slashes = $a_stat;
     }

Here is the caller graph for this function:

◆ setValidateAuthPost()

ilPasswordInputGUI::setValidateAuthPost ( string $a_validateauthpost )

Definition at line 112 of file class.ilPasswordInputGUI.php.

                                                                    : void
     {
         $this->validateauthpost = $a_validateauthpost;
     }

◆ setValue()

ilPasswordInputGUI::setValue ( string $a_value )

Definition at line 54 of file class.ilPasswordInputGUI.php.

Referenced by setValueByArray().

      : void {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilPasswordInputGUI::setValueByArray ( array $a_values )

Definition at line 100 of file class.ilPasswordInputGUI.php.

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

                                                     : void
     {
         $this->setValue($a_values[$this->getPostVar()] ?? "");
         $this->setRetypeValue($a_values[$this->getPostVar() . "_retype"] ?? "");
     }