ilEMailInputGUI Class Reference

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

Inheritance diagram for ilEMailInputGUI:

Collaboration diagram for ilEMailInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor.
	setValue ($a_value)
	Set Value.
	getValue ()
	Get Value.
	setValueByArray ($a_values)
	Set value by array.
	checkInput ()
	Check input, strip slashes etc.
	insert (&$a_tpl)
	Insert property html.
Public Member Functions inherited from ilFormPropertyGUI
&	executeCommand ()
	Execute command.
	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.
	setParentForm ($a_parentform)
	Set Parent Form.
	getParentForm ()
	Get Parent Form.
	setParent ($a_val)
	Set Parent GUI object.
	getParent ()
	Get Parent GUI object.
	getSubForm ()
	Get sub form html.
	hideSubForm ()
	Sub form hidden on init?
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders)
	getHiddenTitle ()
	Get hidden title.
	getItemByPostVar ($a_post_var)
	Get item by post var.
	serializeData ()
	serialize data
	unserializeData ($a_data)
	unserialize data
	writeToSession ()
	Write to session.
	clearFromSession ()
	Clear session value.
	readFromSession ()
	Read from session.
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties)

Protected Attributes
	$value
	$size = 30
	$max_length = 80
Protected Attributes inherited from ilFormPropertyGUI
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type.

Detailed Description

This class represents a email 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.ilEMailInputGUI.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

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

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

Member Function Documentation

ilEMailInputGUI::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 83 of file class.ilEMailInputGUI.php.

References $_POST, $lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilUtil\is_email(), 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::is_email($_POST[$this->getPostVar()]) &&
                        trim($_POST[$this->getPostVar()]) != "")
                {
                        $this->setAlert($lng->txt("email_not_valid"));

                        return false;
                }
                
                
                return true;
        }

Here is the call graph for this function:

ilEMailInputGUI::getValue

(

)

Get Value.

Returns

string Value

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

References $value.

Referenced by insert().

        {
                return $this->value;
        }

Here is the caller graph for this function:

ilEMailInputGUI::insert

(

&

$a_tpl

)

Insert property html.

Definition at line 109 of file class.ilEMailInputGUI.php.

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

        {
                global $lng;
                
                $a_tpl->setCurrentBlock("prop_email");
                $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:

ilEMailInputGUI::setValue

(

$a_value

)

Set Value.

Parameters

string

$a_value

Value

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

Referenced by setValueByArray().

        {
                $this->value = $a_value;
        }

Here is the caller graph for this function:

ilEMailInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

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

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

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

Here is the call graph for this function:

Field Documentation

ilEMailInputGUI::$max_length = 80

protected

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

ilEMailInputGUI::$size = 30

protected

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

ilEMailInputGUI::$value

protected

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

Referenced by getValue().

---

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

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