ilPasswordAssistanceGUI Class Reference

Password assistance facility for users who have forgotten their password or for users for whom no password has been assigned yet. More...

Collaboration diagram for ilPasswordAssistanceGUI:

Public Member Functions
	__construct ()
	executeCommand ()
	showAssistanceForm (ilPropertyFormGUI $form=null)
	submitAssistanceForm ()
	Reads the submitted data from the password assistance form. More...
	showAssignPasswordForm (ilPropertyFormGUI $form=null, $pwassist_id='')
	Assign password form. More...
	submitAssignPasswordForm ()
	Reads the submitted data from the password assistance form. More...
	showUsernameAssistanceForm (ilPropertyFormGUI $form=null)
	Shows the password assistance form. More...
	submitUsernameAssistanceForm ()
	Reads the submitted data from the password assistance form. More...
	showMessageForm ($text, string $permanent_link_context)
	This form is used to show a message to the user. More...

Data Fields
const	PERMANENT_LINK_TARGET_PW = 'pwassist'
const	PERMANENT_LINK_TARGET_NAME = 'nameassist'

Protected Member Functions
	getBaseUrl ()
	Returns the ILIAS http path without a trailing /. More...
	buildUrl (string $script, array $queryParameters)
	getAssistanceForm ()
	getAssignPasswordForm ($pwassist_id)
	getUsernameAssistanceForm ()
	fillPermanentLink ($context)

Protected Attributes
	$ctrl
	$lng
	$rbacreview
	$tpl
	$settings
	$ilias

Private Attributes
	$ilErr
	$help
	$actor

Detailed Description

Password assistance facility for users who have forgotten their password or for users for whom no password has been assigned yet.

Author

Werner Randelshofer wrand.nosp@m.els@.nosp@m.hsw.f.nosp@m.hz.c.nosp@m.h

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

Definition at line 12 of file class.ilPasswordAssistanceGUI.php.

Constructor & Destructor Documentation

__construct()

ilPasswordAssistanceGUI::__construct

(

)

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

References $DIC, help(), and settings().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->rbacreview = $DIC->rbac()->review();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->settings = $DIC->settings();
        $this->ilias = $DIC['ilias'];
        $this->ilErr = $DIC['ilErr'];
        $this->help = $DIC->help();
        $this->actor = $DIC->user();

        $this->help->setScreenIdComponent('init');
    }

Here is the call graph for this function:

Member Function Documentation

buildUrl()

ilPasswordAssistanceGUI::buildUrl ( string  $script, array  $queryParameters  )

protected

Parameters

string	$script
array	$queryParameters

Returns

string

Definition at line 137 of file class.ilPasswordAssistanceGUI.php.

References $url, ilUtil\appendUrlParameterString(), and getBaseUrl().

Referenced by submitAssistanceForm(), and submitUsernameAssistanceForm().

                                                                        : string
    {
        $url = implode('/', [
            $this->getBaseUrl(),
            ltrim($script, '/')
        ]);

        $url = \ilUtil::appendUrlParameterString(
            $url,
            http_build_query($queryParameters, null, '&')
        );

        return $url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPasswordAssistanceGUI::executeCommand

(

)

Returns

mixed

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

References $_GET, $lang, $lng, settings(), showAssignPasswordForm(), and showAssistanceForm().

    {
        // check hack attempts
        if (!$this->settings->get('setup_ok')) {
            $this->ilErr->raiseError('Setup is not completed. Please run setup routine again.', $this->ilErr->FATAL);
        }

        if (!$this->settings->get('password_assistance')) {
            $this->ilErr->raiseError($this->lng->txt('permission_denied'), $this->ilErr->MESSAGE);
        }

        if ($this->actor->getId() > 0 && !$this->actor->isAnonymous()) {
            $this->ilErr->raiseError($this->lng->txt('permission_denied'), $this->ilErr->MESSAGE);
        }

        // Change the language, if necessary.
        // And load the 'pwassist' language module
        $lang = $_GET['lang'];
        if ($lang != null && $lang != '' && $this->lng->getLangKey() != $lang) {
            $lng = new ilLanguage($lang);
        }
        $this->lng->loadLanguageModule('pwassist');

        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass($this);

        switch ($next_class) {
            default:
                if ($cmd != '' && method_exists($this, $cmd)) {
                    return $this->$cmd();
                } else {
                    if (!empty($_GET['key'])) {
                        $this->showAssignPasswordForm();
                    } else {
                        $this->showAssistanceForm();
                    }
                }
                break;
        }
    }

Here is the call graph for this function:

fillPermanentLink()

ilPasswordAssistanceGUI::fillPermanentLink (   $context )

protected

Parameters

string

$context

Definition at line 739 of file class.ilPasswordAssistanceGUI.php.

References $context.

Referenced by showAssignPasswordForm(), showAssistanceForm(), and showMessageForm().

    {
        $this->tpl->setPermanentLink('usr', null, $context);
    }

Here is the caller graph for this function:

getAssignPasswordForm()

ilPasswordAssistanceGUI::getAssignPasswordForm (   $pwassist_id )

protected

Parameters

string

$pwassist_id

Returns

ilPropertyFormGUI

Definition at line 385 of file class.ilPasswordAssistanceGUI.php.

References $password, and ilUtil\getPasswordRequirementsInfo().

Referenced by showAssignPasswordForm(), and submitAssignPasswordForm().

    {
        require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();

        $form->setFormAction($this->ctrl->getFormAction($this, 'submitAssignPasswordForm'));
        $form->setTarget('_parent');

        $username = new ilTextInputGUI($this->lng->txt('username'), 'username');
        $username->setRequired(true);
        $form->addItem($username);

        $password = new ilPasswordInputGUI($this->lng->txt('password'), 'password');
        $password->setInfo(\ilUtil::getPasswordRequirementsInfo());
        $password->setRequired(true);
        $password->setUseStripSlashes(false);
        $form->addItem($password);

        $key = new ilHiddenInputGUI('key');
        $key->setValue($pwassist_id);
        $form->addItem($key);

        $form->addCommandButton('submitAssignPasswordForm', $this->lng->txt('submit'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssistanceForm()

ilPasswordAssistanceGUI::getAssistanceForm ( )

protected

Returns

ilPropertyFormGUI

Definition at line 155 of file class.ilPasswordAssistanceGUI.php.

References $email.

Referenced by showAssistanceForm(), and submitAssistanceForm().

    {
        require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();

        $form->setFormAction($this->ctrl->getFormAction($this, 'submitAssistanceForm'));
        $form->setTarget('_parent');

        $username = new ilTextInputGUI($this->lng->txt('username'), 'username');
        $username->setRequired(true);
        $form->addItem($username);

        $email = new ilEMailInputGUI($this->lng->txt('email'), 'email');
        $email->setRequired(true);
        $form->addItem($email);

        $form->addCommandButton('submitAssistanceForm', $this->lng->txt('submit'));

        return $form;
    }

Here is the caller graph for this function:

getBaseUrl()

ilPasswordAssistanceGUI::getBaseUrl ( )

protected

Returns the ILIAS http path without a trailing /.

Returns

string

Definition at line 127 of file class.ilPasswordAssistanceGUI.php.

Referenced by buildUrl(), submitAssistanceForm(), and submitUsernameAssistanceForm().

                                    : string
    {
        return rtrim(ILIAS_HTTP_PATH, '/');
    }

Here is the caller graph for this function:

getUsernameAssistanceForm()

ilPasswordAssistanceGUI::getUsernameAssistanceForm ( )

protected

Returns

ilPropertyFormGUI

Definition at line 569 of file class.ilPasswordAssistanceGUI.php.

References $email.

Referenced by showUsernameAssistanceForm(), and submitUsernameAssistanceForm().

    {
        require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();

        $form->setFormAction($this->ctrl->getFormAction($this, 'submitUsernameAssistanceForm'));
        $form->setTarget('_parent');

        $email = new ilTextInputGUI($this->lng->txt('email'), 'email');
        $email->setRequired(true);
        $form->addItem($email);

        $form->addCommandButton('submitUsernameAssistanceForm', $this->lng->txt('submit'));

        return $form;
    }

Here is the caller graph for this function:

showAssignPasswordForm()

ilPasswordAssistanceGUI::showAssignPasswordForm	(	ilPropertyFormGUI	$form = null,
			$pwassist_id = ''
	)

Assign password form.

This form is used to assign a password to a username. To use this form, the following data must be provided as HTTP GET parameter, or in argument pwassist_id: key The key is used to retrieve the password assistance session. If the key is missing, or if the password assistance session has expired, the password assistance form will be shown instead of this form.

Parameters

ilPropertyFormGUI	$form
string	$pwassist_id

Definition at line 424 of file class.ilPasswordAssistanceGUI.php.

References $_GET, $tpl, db_pwassist_session_read(), fillPermanentLink(), getAssignPasswordForm(), ilUtil\getImagePath(), help(), ilStartUpGUI\printToGlobalTemplate(), ilUtil\sendFailure(), and showAssistanceForm().

Referenced by executeCommand(), and submitAssignPasswordForm().

    {
        require_once 'include/inc.pwassist_session_handler.php';
        require_once 'Services/Language/classes/class.ilLanguage.php';

        $this->help->setSubScreenId('password_input');

        // Retrieve form data
        if (!$pwassist_id) {
            $pwassist_id = $_GET['key'];
        }

        // Retrieve the session, and check if it is valid
        $pwassist_session = db_pwassist_session_read($pwassist_id);
        if (
            !is_array($pwassist_session) ||
            count($pwassist_session) == 0 ||
            $pwassist_session['expires'] < time()
        ) {
            ilUtil::sendFailure($this->lng->txt('pwassist_session_expired'));
            $this->showAssistanceForm(null);
        } else {
            $tpl = ilStartUpGUI::initStartUpTemplate('tpl.pwassist_assignpassword.html', true);
            $tpl->setVariable('IMG_PAGEHEADLINE', ilUtil::getImagePath('icon_auth.svg'));
            $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('password_assistance'));

            $tpl->setVariable('TXT_ENTER_USERNAME_AND_NEW_PASSWORD', $this->lng->txt('pwassist_enter_username_and_new_password'));

            if (!$form) {
                $form = $this->getAssignPasswordForm($pwassist_id);
            }
            $tpl->setVariable('FORM', $form->getHTML());
            $this->fillPermanentLink(self::PERMANENT_LINK_TARGET_PW);
            ilStartUpGUI::printToGlobalTemplate($tpl);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showAssistanceForm()

ilPasswordAssistanceGUI::showAssistanceForm

(

ilPropertyFormGUI

$form = null

)

Parameters

ilPropertyFormGUI

$form

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

References $tpl, fillPermanentLink(), getAssistanceForm(), ilUtil\getImagePath(), help(), ilUtil\prepareFormOutput(), ilStartUpGUI\printToGlobalTemplate(), and settings().

Referenced by executeCommand(), showAssignPasswordForm(), submitAssignPasswordForm(), and submitAssistanceForm().

    {
        $this->help->setSubScreenId('password_assistance');

        $tpl = ilStartUpGUI::initStartUpTemplate('tpl.pwassist_assistance.html', true);
        $tpl->setVariable('IMG_PAGEHEADLINE', ilUtil::getImagePath('icon_auth.svg'));
        $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('password_assistance'));

        $tpl->setVariable(
            'TXT_ENTER_USERNAME_AND_EMAIL',
            str_replace(
                "\\n",
                '<br />',
                sprintf(
                    $this->lng->txt('pwassist_enter_username_and_email'),
                    '<a href="mailto:' . ilUtil::prepareFormOutput($this->settings->get('admin_email')) . '">' . ilUtil::prepareFormOutput($this->settings->get('admin_email')) . '</a>'
                )
            )
        );

        if (!$form) {
            $form = $this->getAssistanceForm();
        }
        $tpl->setVariable('FORM', $form->getHTML());
        $this->fillPermanentLink(self::PERMANENT_LINK_TARGET_PW);
        ilStartUpGUI::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showMessageForm()

ilPasswordAssistanceGUI::showMessageForm	(		$text,
		string	$permanent_link_context
	)

This form is used to show a message to the user.

Parameters

string

$text

Definition at line 725 of file class.ilPasswordAssistanceGUI.php.

References $tpl, fillPermanentLink(), ilUtil\getImagePath(), and ilStartUpGUI\printToGlobalTemplate().

Referenced by submitAssignPasswordForm(), submitAssistanceForm(), and submitUsernameAssistanceForm().

    {
        $tpl = ilStartUpGUI::initStartUpTemplate('tpl.pwassist_message.html', true);
        $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('password_assistance'));
        $tpl->setVariable('IMG_PAGEHEADLINE', ilUtil::getImagePath('icon_auth.svg'));

        $tpl->setVariable('TXT_TEXT', str_replace("\\n", '<br />', $text));
        $this->fillPermanentLink($permanent_link_context);
        ilStartUpGUI::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showUsernameAssistanceForm()

ilPasswordAssistanceGUI::showUsernameAssistanceForm

(

ilPropertyFormGUI

$form = null

)

Shows the password assistance form.

This form is used to request a password assistance mail from ILIAS. This form contains the following fields: username email When the user submits the form, then this script is invoked with the cmd 'submitAssistanceForm'.

Parameters

ilPropertyFormGUI

$form

Definition at line 596 of file class.ilPasswordAssistanceGUI.php.

References $tpl, ilUtil\getImagePath(), getUsernameAssistanceForm(), help(), ilUtil\prepareFormOutput(), ilStartUpGUI\printToGlobalTemplate(), and settings().

Referenced by submitUsernameAssistanceForm().

    {
        $this->help->setSubScreenId('username_assistance');

        $tpl = ilStartUpGUI::initStartUpTemplate('tpl.pwassist_username_assistance.html', true);
        $tpl->setVariable('IMG_PAGEHEADLINE', ilUtil::getImagePath('icon_auth.svg'));
        $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('password_assistance'));

        $tpl->setVariable(
            'TXT_ENTER_USERNAME_AND_EMAIL',
            str_replace(
                "\\n",
                '<br />',
                sprintf(
                    $this->lng->txt('pwassist_enter_email'),
                    '<a href="mailto:' . ilUtil::prepareFormOutput($this->settings->get('admin_email')) . '">' . ilUtil::prepareFormOutput($this->settings->get('admin_email')) . '</a>'
                )
            )
        );

        if (!$form) {
            $form = $this->getUsernameAssistanceForm();
        }
        $tpl->setVariable('FORM', $form->getHTML());
        //$this->fillPermanentLink(self::PERMANENT_LINK_TARGET_NAME);
        ilStartUpGUI::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

submitAssignPasswordForm()

ilPasswordAssistanceGUI::submitAssignPasswordForm

(

)

Reads the submitted data from the password assistance form.

The following form fields are read as HTTP POST parameters: key username password1 password2 The key is used to retrieve the password assistance session. If the key is missing, or if the password assistance session has expired, the password assistance form will be shown instead of this form. If the password assistance session is valid, and if the username matches the username, for which the password assistance has been requested, and if the new password is valid, ILIAS assigns the password to the user. Note: To prevent replay attacks, the session is deleted when the password has been assigned successfully.

Definition at line 477 of file class.ilPasswordAssistanceGUI.php.

References $_POST, $message, $password, db_pwassist_session_destroy(), db_pwassist_session_read(), getAssignPasswordForm(), ilObjectFactory\getInstanceByObjId(), ilObjUser\getLogin(), ilUtil\isPasswordValidForUserContext(), ilUtil\sendFailure(), ilObjUser\setLastPasswordChangeToNow(), showAssignPasswordForm(), showAssistanceForm(), showMessageForm(), ilUtil\stripSlashes(), and ilObject\update().

    {
        require_once 'include/inc.pwassist_session_handler.php';

        // We need to fetch this before form instantiation
        $pwassist_id = ilUtil::stripSlashes($_POST['key']);

        $form = $this->getAssignPasswordForm($pwassist_id);
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->showAssignPasswordForm($form, $pwassist_id);
            return;
        }

        $username = $form->getInput('username');
        $password = $form->getInput('password');
        $pwassist_id = $form->getInput('key');

        // Retrieve the session
        $pwassist_session = db_pwassist_session_read($pwassist_id);

        if (
            !is_array($pwassist_session) ||
            count($pwassist_session) == 0 ||
            $pwassist_session['expires'] < time()
        ) {
            ilUtil::sendFailure(str_replace("\\n", '', $this->lng->txt('pwassist_session_expired')));
            $form->setValuesByPost();
            $this->showAssistanceForm($form);
            return;
        } else {
            $is_successful = true;
            $message = '';

            $userObj = \ilObjectFactory::getInstanceByObjId($pwassist_session['user_id'], false);
            if (!$userObj || !($userObj instanceof \ilObjUser)) {
                $message = $this->lng->txt('user_does_not_exist');
                $is_successful = false;
            }

            // check if the username entered by the user matches the
            // one of the user object.
            if ($is_successful && strcasecmp($userObj->getLogin(), $username) != 0) {
                $message = $this->lng->txt('pwassist_login_not_match');
                $is_successful = false;
            }

            $error_lng_var = '';
            if (!ilUtil::isPasswordValidForUserContext($password, $userObj, $error_lng_var)) {
                $message = $this->lng->txt($error_lng_var);
                $is_successful = false;
            }

            // End of validation
            // If the validation was successful, we change the password of the
            // user.
            // ------------------
            if ($is_successful) {
                $is_successful = $userObj->resetPassword($password, $password);
                if (!$is_successful) {
                    $message = $this->lng->txt('passwd_invalid');
                }
            }

            // If we are successful so far, we update the user object.
            // ------------------
            if ($is_successful) {
                $userObj->setLastPasswordChangeToNow();
                $userObj->update();
            }

            // If we are successful, we destroy the password assistance
            // session and redirect to the login page.
            // Else we display the form again along with an error message.
            // ------------------
            if ($is_successful) {
                db_pwassist_session_destroy($pwassist_id);
                $this->showMessageForm(
                    sprintf($this->lng->txt('pwassist_password_assigned'), $username),
                    self::PERMANENT_LINK_TARGET_PW
                );
            } else {
                ilUtil::sendFailure(str_replace("\\n", '', $message));
                $form->setValuesByPost();
                $this->showAssignPasswordForm($form, $pwassist_id);
            }
        }
    }

Here is the call graph for this function:

submitAssistanceForm()

ilPasswordAssistanceGUI::submitAssistanceForm

(

)

Reads the submitted data from the password assistance form.

The following form fields are read as HTTP POST parameters: username email If the submitted username and email address matches an entry in the user data table, then ILIAS creates a password assistance session for the user, and sends a password assistance mail to the email address. For details about the creation of the session and the e-mail see function sendPasswordAssistanceMail().

Definition at line 218 of file class.ilPasswordAssistanceGUI.php.

References $_SERVER, $DIC, $email, $GLOBALS, ANONYMOUS_ROLE_ID, AUTH_LOCAL, AUTH_SAML, buildUrl(), db_pwassist_create_id(), db_pwassist_session_find(), db_pwassist_session_write(), getAssistanceForm(), getBaseUrl(), ilObjUser\getEmail(), ilObject\getId(), ilLoggerFactory\getLogger(), ilObjUser\getLogin(), ilObjUser\getUserIdByLogin(), showAssistanceForm(), showMessageForm(), and SYSTEM_ROLE_ID.

    {
        $form = $this->getAssistanceForm();
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->showAssistanceForm($form);
            return;
        }

        $username = $form->getInput('username');
        $email = trim($form->getInput('email'));

        $usrId = \ilObjUser::getUserIdByLogin($username);
        if (!is_numeric($usrId) || !($usrId > 0)) {
            \ilLoggerFactory::getLogger('usr')->info(sprintf(
                'Could not process password assistance form (reason: no user found) %s / %s',
                $username,
                $email
            ));

            $this->showMessageForm(
                sprintf($this->lng->txt('pwassist_mail_sent'), $email),
                self::PERMANENT_LINK_TARGET_PW
            );
            return;
        }

        $defaultAuth = AUTH_LOCAL;
        if ($GLOBALS['DIC']['ilSetting']->get('auth_mode')) {
            $defaultAuth = $GLOBALS['DIC']['ilSetting']->get('auth_mode');
        }

        $user = new \ilObjUser($usrId);
        $emailAddresses = array_map('strtolower', [$user->getEmail(), $user->getSecondEmail()]);

        if (!in_array(strtolower($email), $emailAddresses)) {
            if (0 === strlen(implode('', $emailAddresses))) {
                \ilLoggerFactory::getLogger('usr')->info(sprintf(
                    'Could not process password assistance form (reason: account without email addresses): %s / %s',
                    $username,
                    $email
                ));
            } else {
                \ilLoggerFactory::getLogger('usr')->info(sprintf(
                    'Could not process password assistance form (reason: account email addresses differ from input): %s / %s',
                    $username,
                    $email
                ));
            }
        } elseif (
            (
                $user->getAuthMode(true) != AUTH_LOCAL ||
                ($user->getAuthMode(true) == $defaultAuth && $defaultAuth != AUTH_LOCAL)
            ) && !(
                $user->getAuthMode(true) == AUTH_SAML
            )
        ) {
            \ilLoggerFactory::getLogger('usr')->info(sprintf(
                'Could not process password assistance form (reason: not permitted for accounts using external authentication sources): %s / %s',
                $username,
                $email
            ));
        } elseif (
            $this->rbacreview->isAssigned($user->getId(), ANONYMOUS_ROLE_ID) ||
            $this->rbacreview->isAssigned($user->getId(), SYSTEM_ROLE_ID)
        ) {
            \ilLoggerFactory::getLogger('usr')->info(sprintf(
                'Could not process password assistance form (reason: not permitted for system user or anonymous): %s / %s',
                $username,
                $email
            ));
        } else {
            $this->sendPasswordAssistanceMail($user);
        }

        $this->showMessageForm(
            sprintf($this->lng->txt('pwassist_mail_sent'), $email),
            self::PERMANENT_LINK_TARGET_PW
        );
    }

Here is the call graph for this function:

submitUsernameAssistanceForm()

ilPasswordAssistanceGUI::submitUsernameAssistanceForm

(

)

Reads the submitted data from the password assistance form.

The following form fields are read as HTTP POST parameters: username email If the submitted username and email address matches an entry in the user data table, then ILIAS creates a password assistance session for the user, and sends a password assistance mail to the email address. For details about the creation of the session and the e-mail see function sendPasswordAssistanceMail().

Definition at line 635 of file class.ilPasswordAssistanceGUI.php.

References $_SERVER, $DIC, $email, buildUrl(), getBaseUrl(), ilLoggerFactory\getLogger(), ilObjUser\getUserLoginsByEmail(), getUsernameAssistanceForm(), showMessageForm(), and showUsernameAssistanceForm().

    {
        require_once 'Services/User/classes/class.ilObjUser.php';
        require_once 'Services/Utilities/classes/class.ilUtil.php';

        $form = $this->getUsernameAssistanceForm();
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->showUsernameAssistanceForm($form);

            return;
        }

        $email = trim($form->getInput('email'));
        $logins = ilObjUser::getUserLoginsByEmail($email);

        if (is_array($logins) && count($logins) > 0) {
            $this->sendUsernameAssistanceMail($email, $logins);
        } else {
            \ilLoggerFactory::getLogger('usr')->info(sprintf(
                'Could not sent username assistance emails to (reason: no user found): %s',
                $email
            ));
        }

        $this->showMessageForm(
            $this->lng->txt('pwassist_mail_sent_generic'),
            self::PERMANENT_LINK_TARGET_NAME
        );
    }

Here is the call graph for this function:

Field Documentation

$actor

ilPasswordAssistanceGUI::$actor

private

Definition at line 60 of file class.ilPasswordAssistanceGUI.php.

$ctrl

ilPasswordAssistanceGUI::$ctrl

protected

Definition at line 20 of file class.ilPasswordAssistanceGUI.php.

$help

ilPasswordAssistanceGUI::$help

private

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

$ilErr

ilPasswordAssistanceGUI::$ilErr

private

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

$ilias

ilPasswordAssistanceGUI::$ilias

protected

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

$lng

ilPasswordAssistanceGUI::$lng

protected

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

Referenced by executeCommand().

$rbacreview

ilPasswordAssistanceGUI::$rbacreview

protected

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

$settings

ilPasswordAssistanceGUI::$settings

protected

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

$tpl

ilPasswordAssistanceGUI::$tpl

protected

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

Referenced by showAssignPasswordForm(), showAssistanceForm(), showMessageForm(), and showUsernameAssistanceForm().

PERMANENT_LINK_TARGET_NAME

const ilPasswordAssistanceGUI::PERMANENT_LINK_TARGET_NAME = 'nameassist'

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

PERMANENT_LINK_TARGET_PW

const ilPasswordAssistanceGUI::PERMANENT_LINK_TARGET_PW = 'pwassist'

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

---

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

• Services/Init/classes/class.ilPasswordAssistanceGUI.php