This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilEMailInputGUI:

Collaboration diagram for ilEMailInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	setValue (string $a_value)

	getValue ()

	setValueByArray (array $a_values)

	allowRFC822 (bool $a_value)
	Allow extended email address format. More...

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

	getInput ()

	insert (ilTemplate $a_tpl)

	setRetype (bool $a_val)

	getRetype ()

	setRetypeValue (string $a_retypevalue)

	getRetypeValue ()

	setSize (int $size)

	getSize ()

	setMaxLength (int $max_length)

	getMaxLength ()

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

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

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback (string $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...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Protected Member Functions
	sanitize ($key)

Protected Member Functions inherited from ilFormPropertyGUI
	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Protected Attributes
string	$value = ""

int	$size = 30

int	$max_length = 80

bool	$allowRFC822 = false

bool	$retype = false

string	$retypevalue = ''

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning This class represents a email property in a property form.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilFormPropertyGUI.

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and setRetype().

Here is the call graph for this function:

Member Function Documentation

◆ allowRFC822()

ilEMailInputGUI::allowRFC822 ( bool $a_value )

Allow extended email address format.

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

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

                                              : void
    {
        $this->allowRFC822 = $a_value;
    }

References allowRFC822().

Referenced by allowRFC822(), and sanitize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkInput()

ilEMailInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilFormPropertyGUI.

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

                                : bool
    {
        $lng = $this->lng;
 
        if ($this->getRequired() && trim($this->str($this->getPostVar())) == "") {
            $this->setAlert($lng->txt("msg_input_is_required"));
            return false;
        }
        if ($this->getRetype() &&
            ($this->sanitize($this->getPostVar()) != $this->sanitize($this->getPostVar() . '_retype'))) {
            $this->setAlert($lng->txt('email_not_match'));
            return false;
        }
        if (!ilUtil::is_email($this->sanitize($this->getPostVar())) &&
            trim($this->sanitize($this->getPostVar())) != ""
        ) {
            $this->setAlert($lng->txt("email_not_valid"));
            return false;
        }
        return true;
    }

References ilFormPropertyGUI\$lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getRetype(), ilUtil\is_email(), sanitize(), ilFormPropertyGUI\setAlert(), ilFormPropertyGUI\str(), and ilLanguage\txt().

Here is the call graph for this function:

◆ getInput()

ilEMailInputGUI::getInput ( )

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

                              : string
    {
        return trim($this->sanitize($this->getPostVar()));
    }

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

Here is the call graph for this function:

◆ getMaxLength()

ilEMailInputGUI::getMaxLength ( )

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

                                  : int
    {
        return $this->max_length;
    }

References $max_length.

Referenced by insert().

Here is the caller graph for this function:

◆ getRetype()

ilEMailInputGUI::getRetype ( )

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

                               : bool
    {
        return $this->retype;
    }

References $retype.

Referenced by checkInput(), and insert().

Here is the caller graph for this function:

◆ getRetypeValue()

ilEMailInputGUI::getRetypeValue ( )

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

                                    : string
    {
        return $this->retypevalue;
    }

References $retypevalue.

Referenced by insert().

Here is the caller graph for this function:

◆ getSize()

ilEMailInputGUI::getSize ( )

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

                             : int
    {
        return $this->size;
    }

References $size.

Referenced by insert().

Here is the caller graph for this function:

◆ getValue()

ilEMailInputGUI::getValue ( )

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

                              : string
    {
        return $this->value;
    }

References $value.

Referenced by insert().

Here is the caller graph for this function:

◆ insert()

ilEMailInputGUI::insert ( ilTemplate $a_tpl )

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

                                             : void
    {
        $lng = $this->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', ilLegacyFormElementsUtil::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', ilLegacyFormElementsUtil::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()));
        }
 
        if ($this->getRequired()) {
            $ptpl->setVariable("REQUIRED", "required=\"required\"");
        }
 
        $a_tpl->setCurrentBlock('prop_generic');
        $a_tpl->setVariable('PROP_GENERIC', $ptpl->get());
        $a_tpl->parseCurrentBlock();
    }

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

Here is the call graph for this function:

◆ sanitize()

ilEMailInputGUI::sanitize ( $key )

protected

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

                                     : string
    {
        $t = $this->refinery->kindlyTo()->string();
        return ilUtil::stripSlashes(
            (string) ($this->getRequestParam($key, $t) ?? ""),
            !$this->allowRFC822
        );
    }

References ILIAS\LTI\ToolProvider\$key, allowRFC822(), ilFormPropertyGUI\getRequestParam(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Referenced by checkInput(), and getInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMaxLength()

ilEMailInputGUI::setMaxLength ( int $max_length )

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

                                                 : void
    {
        $this->max_length = $max_length;
    }

References $max_length.

◆ setRetype()

ilEMailInputGUI::setRetype ( bool $a_val )

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

                                          : void
    {
        $this->retype = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setRetypeValue()

ilEMailInputGUI::setRetypeValue ( string $a_retypevalue )

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

                                                         : void
    {
        $this->retypevalue = $a_retypevalue;
    }

Referenced by setValueByArray().

Here is the caller graph for this function:

◆ setSize()

ilEMailInputGUI::setSize ( int $size )

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

                                      : void
    {
        $this->size = $size;
    }

References $size.

◆ setValue()

ilEMailInputGUI::setValue ( string $a_value )

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

                                             : void
    {
        $this->value = $a_value;
    }

Referenced by setValueByArray().

Here is the caller graph for this function:

◆ setValueByArray()

ilEMailInputGUI::setValueByArray ( array $a_values )

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $allowRFC822

bool ilEMailInputGUI::$allowRFC822 = false

protected

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

◆ $max_length

int ilEMailInputGUI::$max_length = 80

protected

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

Referenced by getMaxLength(), and setMaxLength().

◆ $retype

bool ilEMailInputGUI::$retype = false

protected

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

Referenced by getRetype().

◆ $retypevalue

string ilEMailInputGUI::$retypevalue = ''

protected

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

Referenced by getRetypeValue().

◆ $size

int ilEMailInputGUI::$size = 30

protected

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

Referenced by getSize(), and setSize().

◆ $value

string ilEMailInputGUI::$value = ""

protected

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allowRFC822()

◆ checkInput()

◆ getInput()

◆ getMaxLength()

◆ getRetype()

◆ getRetypeValue()

◆ getSize()

◆ getValue()

◆ insert()

◆ sanitize()

◆ setMaxLength()

◆ setRetype()

◆ setRetypeValue()

◆ setSize()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $allowRFC822

◆ $max_length

◆ $retype

◆ $retypevalue

◆ $size

◆ $value