ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilUserLoginInputGUI Class Reference

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.
 setValue ($a_value)
 Set Value.
 getValue ()
 Get Value.
 setValueByArray ($a_values)
 Set value by array.
 setCurrentUserId ($a_user_id)
 Set Check whether login is unused.
 getCurrentUserId ()
 Get Check whether login is unused.
 checkInput ()
 Check input, strip slashes etc.
 insert (&$a_tpl)
 Insert property html.
- Public Member Functions inherited from ilFormPropertyGUI
 getType ()
 Get Type.
 setTitle ($a_title)
 Set Title.
 getTitle ()
 Get Title.
 setPostVar ($a_postvar)
 Set Post Variable.
 getPostVar ()
 Get Post Variable.
 getFieldId ()
 Get Post Variable.
 setInfo ($a_info)
 Set Information Text.
 getInfo ()
 Get Information Text.
 setAlert ($a_alert)
 Set Alert Text.
 getAlert ()
 Get Alert Text.
 setRequired ($a_required)
 Set Required.
 getRequired ()
 Get Required.
 setDisabled ($a_disabled)
 Set Disabled.
 getDisabled ()
 Get Disabled.
 getSubForm ()
 Get sub form html.
 getSubformMode ()

Protected Attributes

 $value
 $size = 40
 $max_length = 80
 $checkunused = 0
- Protected Attributes inherited from ilFormPropertyGUI
 $type
 $title
 $postvar
 $info
 $alert
 $required = false

Additional Inherited Members

- Protected Member Functions inherited from ilFormPropertyGUI
 setType ($a_type)
 Set Type.

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 31 of file class.ilUserLoginInputGUI.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters
string$a_titleTitle
string$a_postvarPost Variable

Reimplemented from ilFormPropertyGUI.

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

{
parent::__construct($a_title, $a_postvar);
}

Member Function Documentation

ilUserLoginInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns
boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

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

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

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

ilUserLoginInputGUI::getCurrentUserId ( )

Get Check whether login is unused.

Returns
boolean Check whether login is unused

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

References $checkunused.

Referenced by checkInput().

{
}

+ Here is the caller graph for this function:

ilUserLoginInputGUI::getValue ( )

Get Value.

Returns
string Value

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

References $value.

Referenced by insert().

{
return $this->value;
}

+ Here is the caller graph for this function:

ilUserLoginInputGUI::insert ( $a_tpl)

Insert property html.

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

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

{
global $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->maxlength);
if ($this->getDisabled())
{
$a_tpl->setVariable("DISABLED",
" disabled=\"disabled\"");
}
$a_tpl->parseCurrentBlock();
}

+ Here is the call graph for this function:

ilUserLoginInputGUI::setCurrentUserId (   $a_user_id)

Set Check whether login is unused.

Parameters
int$a_checkunuseduser id of current user

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

{
$this->checkunused = $a_user_id;
}
ilUserLoginInputGUI::setValue (   $a_value)

Set Value.

Parameters
string$a_valueValue

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

Referenced by setValueByArray().

{
$this->value = $a_value;
}

+ Here is the caller graph for this function:

ilUserLoginInputGUI::setValueByArray (   $a_values)

Set value by array.

Parameters
array$a_valuesvalue array

Definition at line 74 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

ilUserLoginInputGUI::$checkunused = 0
protected

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

Referenced by getCurrentUserId().

ilUserLoginInputGUI::$max_length = 80
protected

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

ilUserLoginInputGUI::$size = 40
protected

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

ilUserLoginInputGUI::$value
protected

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

Referenced by getValue().


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