ilPasswordInputGUI Class Reference

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

Inheritance diagram for ilPasswordInputGUI:

Collaboration diagram for ilPasswordInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setValue ($a_value)
	Set Value. More...
	getValue ()
	Get Value. More...
	setRetype ($a_val)
	Set retype on/off. More...
	getRetype ()
	Get retype on/off. More...
	setRetypeValue ($a_retypevalue)
	Set Retype Value. More...
	getRetypeValue ()
	Get Retype Value. More...
	setMaxLength ($a_maxlength)
	Set Max Length. More...
	getMaxLength ()
	Get Max Length. More...
	setSize ($a_size)
	Set Size. More...
	setValueByArray ($a_values)
	Set value by array. More...
	getSize ()
	Get Size. More...
	setValidateAuthPost ($a_validateauthpost)
	Set Validate required status against authentication POST var. More...
	getValidateAuthPost ()
	Get Validate required status against authentication POST var. More...
	setRequiredOnAuth ($a_requiredonauth)
	Set input required, if authentication mode allows password setting. More...
	getRequiredOnAuth ()
	Get input required, if authentication mode allows password setting. More...
	setSkipSyntaxCheck ($a_val)
	Set skip syntax check. More...
	getSkipSyntaxCheck ()
	Get skip syntax check. More...
	setDisableHtmlAutoComplete ($a_value)
	Set autocomplete. More...
	isHtmlAutoCompleteDisabled ()
	Get autocomplete. More...
	setUseStripSlashes ($a_stat)
	En/disable use of stripslashes. More...
	getUseStripSlashes ()
	checkInput ()
	Check input, strip slashes etc. More...
	render ()
	Render item. More...
	insert ($a_tpl)
	Insert property html. 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
	$value
	$size = 20
	$validateauthpost = ""
	$requiredonauth = false
	$maxlength = false
	$use_strip_slashes = true
	$autocomplete_disabled = true
Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()
Protected Attributes inherited from ilFormPropertyGUI
	$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 password 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$

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References setRetype(), and setSkipSyntaxCheck().

        {
                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

(

)

Check input, strip slashes etc.

set alert, if input is not ok.

Returns

boolean Input ok, true/false

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

References $_POST, $lng, ilAuthUtils\_allowPasswordModificationByAuthMode(), ilAuthUtils\_getAuthMode(), ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getRequiredOnAuth(), getRetype(), getSkipSyntaxCheck(), getUseStripSlashes(), getValidateAuthPost(), ilUtil\isPassword(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

        {
                global $lng;
                
                if($this->getUseStripSlashes())
                {
                        $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                        $_POST[$this->getPostVar()."_retype"] = ilUtil::stripSlashes($_POST[$this->getPostVar()."_retype"]);
                }
                if ($this->getRequired() && trim($_POST[$this->getPostVar()]) == "")
                {
                        $this->setAlert($lng->txt("msg_input_is_required"));

                        return false;
                }
                if ($this->getValidateAuthPost() != "")
                {
                        $auth = ilAuthUtils::_getAuthMode($_POST[$this->getValidateAuthPost()]);

                        // check, if password is required dependent on auth mode
                        if ($this->getRequiredOnAuth() && ilAuthUtils::_allowPasswordModificationByAuthMode($auth)
                                && trim($_POST[$this->getPostVar()]) == "")
                        {
                                $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($_POST[$this->getPostVar()]) != "" &&
                                !ilAuthUtils::_allowPasswordModificationByAuthMode($auth))
                        {
                                $this->setAlert($lng->txt("form_password_not_allowed_for_auth"));
        
                                return false;
                        }
                }
                if ($this->getRetype() &&
                        ($_POST[$this->getPostVar()] != $_POST[$this->getPostVar()."_retype"]))
                {
                        $this->setAlert($lng->txt("passwd_not_match"));

                        return false;
                }
                if (!$this->getSkipSyntaxCheck() &&
                        !ilUtil::isPassword($_POST[$this->getPostVar()],$custom_error) &&
                        $_POST[$this->getPostVar()] != "")
                {
                        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:

getMaxLength()

ilPasswordInputGUI::getMaxLength

(

)

Get Max Length.

Returns

int Max Length

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

References $maxlength.

Referenced by render().

        {
                return $this->maxlength;
        }

Here is the caller graph for this function:

getRequiredOnAuth()

ilPasswordInputGUI::getRequiredOnAuth

(

)

Get input required, if authentication mode allows password setting.

Returns

boolean require input

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

References $requiredonauth.

Referenced by checkInput().

        {
                return $this->requiredonauth;
        }

Here is the caller graph for this function:

getRetype()

ilPasswordInputGUI::getRetype

(

)

Get retype on/off.

Returns

boolean retype

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

Referenced by checkInput(), and render().

        {
                return $this->retype;
        }

Here is the caller graph for this function:

getRetypeValue()

ilPasswordInputGUI::getRetypeValue

(

)

Get Retype Value.

Returns

string Retype Value

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

Referenced by render().

        {
                return $this->retypevalue;
        }

Here is the caller graph for this function:

getSize()

ilPasswordInputGUI::getSize

(

)

Get Size.

Returns

int Size

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

References $size.

Referenced by render().

        {
                return $this->size;
        }

Here is the caller graph for this function:

getSkipSyntaxCheck()

ilPasswordInputGUI::getSkipSyntaxCheck

(

)

Get skip syntax check.

Returns

boolean skip syntax check

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

Referenced by checkInput().

        {
                return $this->skip_syntax_check;
        }

Here is the caller graph for this function:

getUseStripSlashes()

ilPasswordInputGUI::getUseStripSlashes

(

)

Returns

type

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

References $use_strip_slashes.

Referenced by checkInput().

        {
                return $this->use_strip_slashes;
        }

Here is the caller graph for this function:

getValidateAuthPost()

ilPasswordInputGUI::getValidateAuthPost

(

)

Get Validate required status against authentication POST var.

Returns

string POST var

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

References $validateauthpost.

Referenced by checkInput().

        {
                return $this->validateauthpost;
        }

Here is the caller graph for this function:

getValue()

ilPasswordInputGUI::getValue

(

)

Get Value.

Returns

string Value

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

References $value.

Referenced by render().

        {
                return $this->value;
        }

Here is the caller graph for this function:

insert()

ilPasswordInputGUI::insert

(

$a_tpl

)

Insert property html.

Returns

int Size

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

References $html, and render().

        {
                $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

(

)

Get autocomplete.

Returns

bool Value

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

References $autocomplete_disabled.

Referenced by render().

        {
                return $this->autocomplete_disabled;
        }

Here is the caller graph for this function:

render()

ilPasswordInputGUI::render

(

)

Render item.

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

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

Referenced by insert().

        {
                global $lng;
                
                $ptpl = new ilTemplate("tpl.prop_password.html", true, true, "Services/Form");
                
                if ($this->getRetype())
                {
                        $ptpl->setCurrentBlock("retype");
                        $ptpl->setVariable("RSIZE", $this->getSize());
                        $ptpl->setVariable("RID", $this->getFieldId());
                        $ptpl->setVariable("RMAXLENGTH", $this->getMaxLength());
                        $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", ilUtil::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", ilUtil::prepareFormOutput($this->getValue()));
                        $ptpl->parseCurrentBlock();
                }
                $ptpl->setVariable("POST_VAR", $this->getPostVar());
                $ptpl->setVariable("ID", $this->getFieldId());
                $ptpl->setVariable("SIZE", $this->getSize());
                $ptpl->setVariable("MAXLENGTH", $this->getMaxLength());
                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

(

$a_value

)

Set autocomplete.

Parameters

bool

$a_value

Value

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

        {
                $this->autocomplete_disabled = (bool)$a_value;
        }

setMaxLength()

ilPasswordInputGUI::setMaxLength

(

$a_maxlength

)

Set Max Length.

Parameters

int

$a_maxlength

Max Length

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

        {
                $this->maxlength = $a_maxlength;
        }

setRequiredOnAuth()

ilPasswordInputGUI::setRequiredOnAuth

(

$a_requiredonauth

)

Set input required, if authentication mode allows password setting.

Parameters

boolean

$a_requiredonauth

require input

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

        {
                $this->requiredonauth = $a_requiredonauth;
        }

setRetype()

ilPasswordInputGUI::setRetype

(

$a_val

)

Set retype on/off.

Parameters

boolean

retype

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

Referenced by __construct(), ilSharedResourceGUI\initPasswordForm(), ilPersonalSettingsGUI\initPasswordForm(), and ilObjWorkspaceFolderGUI\initPasswordForm().

        {
                $this->retype = $a_val;
        }

Here is the caller graph for this function:

setRetypeValue()

ilPasswordInputGUI::setRetypeValue

(

$a_retypevalue

)

Set Retype Value.

Parameters

string

$a_retypevalue

Retype Value

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

Referenced by setValueByArray().

        {
                $this->retypevalue = $a_retypevalue;
        }

Here is the caller graph for this function:

setSize()

ilPasswordInputGUI::setSize

(

$a_size

)

Set Size.

Parameters

int

$a_size

Size

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

References size.

Referenced by ilObjUserGUI\getValues(), ilSetupGUI\initClientLoginForm(), and ilSetupGUI\initMasterLoginForm().

        {
                $this->size = $a_size;
        }

Here is the caller graph for this function:

setSkipSyntaxCheck()

ilPasswordInputGUI::setSkipSyntaxCheck

(

$a_val

)

Set skip syntax check.

Parameters

boolean

skip syntax check

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

Referenced by __construct().

        {
                $this->skip_syntax_check = $a_val;
        }

Here is the caller graph for this function:

setUseStripSlashes()

ilPasswordInputGUI::setUseStripSlashes

(

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

Parameters

type

$a_stat

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

Referenced by ilStartUpGUI\initStandardLoginForm().

        {
                $this->use_strip_slashes = $a_stat;
        }

Here is the caller graph for this function:

setValidateAuthPost()

ilPasswordInputGUI::setValidateAuthPost

(

$a_validateauthpost

)

Set Validate required status against authentication POST var.

Parameters

string

$a_validateauthpost

POST var

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

        {
                $this->validateauthpost = $a_validateauthpost;
        }

setValue()

ilPasswordInputGUI::setValue

(

$a_value

)

Set Value.

Parameters

string

$a_value

Value

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

Referenced by setValueByArray().

        {
                $this->value = $a_value;
        }

Here is the caller graph for this function:

setValueByArray()

ilPasswordInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

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

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

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

Here is the call graph for this function:

Field Documentation

$autocomplete_disabled

ilPasswordInputGUI::$autocomplete_disabled = true

protected

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

Referenced by isHtmlAutoCompleteDisabled().

$maxlength

ilPasswordInputGUI::$maxlength = false

protected

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

Referenced by getMaxLength().

$requiredonauth

ilPasswordInputGUI::$requiredonauth = false

protected

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

Referenced by getRequiredOnAuth().

$size

ilPasswordInputGUI::$size = 20

protected

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

Referenced by getSize().

$use_strip_slashes

ilPasswordInputGUI::$use_strip_slashes = true

protected

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

Referenced by getUseStripSlashes().

$validateauthpost

ilPasswordInputGUI::$validateauthpost = ""

protected

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

Referenced by getValidateAuthPost().

$value

ilPasswordInputGUI::$value

protected

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

Referenced by getValue().

---

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

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