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.
	allowRFC822 ($a_value)
	Allow extended email address format.
	checkInput ()
	Check input, strip slashes etc.
	insert (ilTemplate $a_tpl)
	setRetype ($a_val)
	getRetype ()
	setRetypeValue ($a_retypevalue)
	getRetypeValue ()
	setSize ($size)
	getSize ()
	setMaxLength ($max_length)
	getMaxLength ()
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)
	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi.
	getMulti ()
	Get Multi.
	setMultiValues (array $a_values)
	Set multi values.
	getMultiValues ()
	Get multi values.
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g.

Protected Attributes
	$value
	$size = 30
	$max_length = 80
	$allowRFC822 = false
	$retype = false
	$retypevalue = ''
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
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type.
	getMultiIconsHTML ()
	Get HTML for multiple value icons.

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 30 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 52 of file class.ilEMailInputGUI.php.

References setRetype().

        {
                parent::__construct($a_title, $a_postvar);
                $this->setRetype(false);
        }

Here is the call graph for this function:

Member Function Documentation

ilEMailInputGUI::allowRFC822

(

$a_value

)

Allow extended email address format.

"example@example.com" vs "example <example@example.com>"

Parameters

bool

$a_value

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

Referenced by checkInput().

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

Here is the caller graph for this function:

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

References $_POST, $lng, allowRFC822(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getRetype(), ilUtil\is_email(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

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

                        return false;
                }
                if($this->getRetype() && ($_POST[$this->getPostVar()] != $_POST[$this->getPostVar() . '_retype']))
                {
                        $this->setAlert($lng->txt('email_not_match'));

                        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::getMaxLength

(

)

Returns

int

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

References $max_length.

Referenced by insert().

        {
                return $this->max_length;
        }

Here is the caller graph for this function:

ilEMailInputGUI::getRetype

(

)

Returns

boolean

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

References $retype.

Referenced by checkInput(), and insert().

        {
                return $this->retype;
        }

Here is the caller graph for this function:

ilEMailInputGUI::getRetypeValue

(

)

Returns

string

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

References $retypevalue.

Referenced by insert().

        {
                return $this->retypevalue;
        }

Here is the caller graph for this function:

ilEMailInputGUI::getSize

(

)

Returns

int

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

References $size.

Referenced by insert().

        {
                return $this->size;
        }

Here is the caller graph for this function:

ilEMailInputGUI::getValue

(

)

Get Value.

Returns

string Value

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

References $value.

Referenced by insert().

        {
                return $this->value;
        }

Here is the caller graph for this function:

ilEMailInputGUI::insert

(

ilTemplate

$a_tpl

)

Parameters

ilTemplate

$a_tpl

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

References $lng, ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getHiddenTag(), getMaxLength(), ilFormPropertyGUI\getPostVar(), getRetype(), getRetypeValue(), getSize(), getValue(), ilTemplate\parseCurrentBlock(), ilUtil\prepareFormOutput(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

        {
                global $lng;

                $ptpl = new ilTemplate('tpl.prop_email.html', true, true, 'Services/Form');

                if($this->getRetype())
                {
                        $ptpl->setCurrentBlock('retype_email');
                        $ptpl->setVariable('RSIZE', $this->getSize());
                        $ptpl->setVariable('RID', $this->getFieldId());
                        $ptpl->setVariable('RMAXLENGTH', $this->getMaxLength());
                        $ptpl->setVariable('RPOST_VAR', $this->getPostVar());

                        $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_email'));
                        $ptpl->parseCurrentBlock();
                }

                $ptpl->setVariable('POST_VAR', $this->getPostVar());
                $ptpl->setVariable('ID', $this->getFieldId());
                $ptpl->setVariable('PROPERTY_VALUE', ilUtil::prepareFormOutput($this->getValue()));
                $ptpl->setVariable('SIZE', $this->getSize());
                $ptpl->setVariable('MAXLENGTH', $this->getMaxLength());
                if($this->getDisabled())
                {
                        $ptpl->setVariable('DISABLED', ' disabled="disabled"');
                        $ptpl->setVariable('HIDDEN_INPUT', $this->getHiddenTag($this->getPostVar(), $this->getValue()));
                }

                $a_tpl->setCurrentBlock('prop_generic');
                $a_tpl->setVariable('PROP_GENERIC', $ptpl->get());
                $a_tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

ilEMailInputGUI::setMaxLength

(

$max_length

)

Parameters

int

$max_length

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

References $max_length.

        {
                $this->max_length = $max_length;
        }

ilEMailInputGUI::setRetype

(

$a_val

)

Parameters

boolean

$a_val

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

Referenced by __construct().

        {
                $this->retype = $a_val;
        }

Here is the caller graph for this function:

ilEMailInputGUI::setRetypeValue

(

$a_retypevalue

)

Parameters

string

$a_retypevalue

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

Referenced by setValueByArray().

        {
                $this->retypevalue = $a_retypevalue;
        }

Here is the caller graph for this function:

ilEMailInputGUI::setSize

(

$size

)

Parameters

int

$size

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

References $size.

        {
                $this->size = $size;
        }

ilEMailInputGUI::setValue

(

$a_value

)

Set Value.

Parameters

string

$a_value

Value

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

Referenced by ilUserProfile\addStandardFieldsToForm(), and 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 80 of file class.ilEMailInputGUI.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

ilEMailInputGUI::$allowRFC822 = false

protected

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

ilEMailInputGUI::$max_length = 80

protected

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

Referenced by getMaxLength(), and setMaxLength().

ilEMailInputGUI::$retype = false

protected

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

Referenced by getRetype().

ilEMailInputGUI::$retypevalue = ''

protected

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

Referenced by getRetypeValue().

ilEMailInputGUI::$size = 30

protected

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

Referenced by getSize(), and setSize().

ilEMailInputGUI::$value

protected

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