This class represents a user login property in a property form. More...

Inheritance diagram for ilUserLoginInputGUI:

Collaboration diagram for ilUserLoginInputGUI:

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

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

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

	setCurrentUserId ($a_user_id)
	Set Check whether login is unused. More...

	getCurrentUserId ()
	Get Check whether login is unused. More...

	setDisableHtmlAutoComplete ($a_value)
	Set autocomplete. More...

	isHtmlAutoCompleteDisabled ()
	Get autocomplete. More...

	checkInput ()
	Check input, strip slashes etc. More...

	insert ($a_tpl)
	Insert property html. 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...

Protected Attributes
	$value

	$size = 40

	$max_length = 80

	$checkunused = 0

	$autocomplete_disabled = false

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 user login 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.ilUserLoginInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 29 of file class.ilUserLoginInputGUI.php.

References $DIC.

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

Member Function Documentation

◆ checkInput()

ilUserLoginInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

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

References $_POST, ilFormPropertyGUI\$lng, ilObjUser\_loginExists(), getCurrentUserId(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilUtil\isLogin(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

     {
         $lng = $this->lng;
         
         $_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;
         }
         if (!ilUtil::isLogin($_POST[$this->getPostVar()])) {
             $this->setAlert($lng->txt("login_invalid"));
 
             return false;
         }
         
         if (ilObjUser::_loginExists($_POST[$this->getPostVar()], $this->getCurrentUserId())) {
             $this->setAlert($lng->txt("login_exists"));
 
             return false;
         }
 
         
         return true;
     }

Here is the call graph for this function:

◆ getCurrentUserId()

ilUserLoginInputGUI::getCurrentUserId ( )

Get Check whether login is unused.

Returns: boolean Check whether login is unused

Definition at line 82 of file class.ilUserLoginInputGUI.php.

References $checkunused.

Referenced by checkInput().

     {
         return $this->checkunused;
     }

Here is the caller graph for this function:

◆ getValue()

ilUserLoginInputGUI::getValue ( )

Get Value.

Returns: string Value

Definition at line 52 of file class.ilUserLoginInputGUI.php.

References $value.

Referenced by insert().

     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilUserLoginInputGUI::insert ( $a_tpl )

Insert property html.

Definition at line 141 of file class.ilUserLoginInputGUI.php.

References ilFormPropertyGUI\$lng, ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getValue(), isHtmlAutoCompleteDisabled(), ilUtil\prepareFormOutput(), and size.

     {
         $lng = $this->lng;
         
         $a_tpl->setCurrentBlock("prop_login");
         $a_tpl->setVariable("POST_VAR", $this->getPostVar());
         $a_tpl->setVariable("ID", $this->getFieldId());
         $a_tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));
         $a_tpl->setVariable("SIZE", $this->size);
         $a_tpl->setVariable("MAXLENGTH", $this->max_length);
         if ($this->getDisabled()) {
             $a_tpl->setVariable(
                 "DISABLED",
                 " disabled=\"disabled\""
             );
         }
         if ($this->isHtmlAutoCompleteDisabled()) {
             $a_tpl->setVariable("AUTOCOMPLETE", "autocomplete=\"off\"");
         }
         if ($this->getRequired()) {
             $a_tpl->setVariable("REQUIRED", "required=\"required\"");
         }
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ isHtmlAutoCompleteDisabled()

ilUserLoginInputGUI::isHtmlAutoCompleteDisabled ( )

Get autocomplete.

Returns: bool Value

Definition at line 102 of file class.ilUserLoginInputGUI.php.

References $autocomplete_disabled.

Referenced by insert().

     {
         return $this->autocomplete_disabled;
     }

Here is the caller graph for this function:

◆ setCurrentUserId()

ilUserLoginInputGUI::setCurrentUserId ( $a_user_id )

Set Check whether login is unused.

Parameters

int $a_checkunused user id of current user

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

     {
         $this->checkunused = $a_user_id;
     }

◆ setDisableHtmlAutoComplete()

ilUserLoginInputGUI::setDisableHtmlAutoComplete ( $a_value )

Set autocomplete.

Parameters

bool $a_value Value

Definition at line 92 of file class.ilUserLoginInputGUI.php.

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

◆ setValue()

ilUserLoginInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

Referenced by setValueByArray().

     {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilUserLoginInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 62 of file class.ilUserLoginInputGUI.php.

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

     {
         $this->setValue($a_values[$this->getPostVar()]);
     }

Here is the call graph for this function:

Field Documentation

◆ $autocomplete_disabled

ilUserLoginInputGUI::$autocomplete_disabled = false

protected

Definition at line 21 of file class.ilUserLoginInputGUI.php.

Referenced by isHtmlAutoCompleteDisabled().

◆ $checkunused

ilUserLoginInputGUI::$checkunused = 0

protected

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

Referenced by getCurrentUserId().

◆ $max_length

ilUserLoginInputGUI::$max_length = 80

protected

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

◆ $size

ilUserLoginInputGUI::$size = 40

protected

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

◆ $value

ilUserLoginInputGUI::$value

protected

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

Referenced by getValue().

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

Services/Form/classes/class.ilUserLoginInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getCurrentUserId()

◆ getValue()

◆ insert()

◆ isHtmlAutoCompleteDisabled()

◆ setCurrentUserId()

◆ setDisableHtmlAutoComplete()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $autocomplete_disabled

◆ $checkunused

◆ $max_length

◆ $size

◆ $value