ilUserProfileStartUpStep Class Reference

Inheritance diagram for ilUserProfileStartUpStep:

Collaboration diagram for ilUserProfileStartUpStep:

Public Member Functions
	__construct (ilObjUser $user, ilCtrl $ctrl)
	shouldStoreRequestTarget ()
	isInFulfillment ()
	shouldInterceptRequest ()
	execute ()
Public Member Functions inherited from ILIAS\Init\StartupSequence\StartUpSequenceStep
	shouldStoreRequestTarget ()
	shouldInterceptRequest ()
	isInFulfillment ()
	execute ()

Protected Attributes
ILIAS User ProfileGUIRequest	$profile_request
bool	$update_prompt = false

Private Attributes
ilObjUser	$user
ilCtrl	$ctrl

Detailed Description

Definition at line 24 of file class.ilUserProfileStartUpStep.php.

Constructor & Destructor Documentation

__construct()

ilUserProfileStartUpStep::__construct	(	ilObjUser	$user,
		ilCtrl	$ctrl
	)

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

References $ctrl, $DIC, $user, ILIAS\Repository\ctrl(), and ILIAS\Repository\user().

    {
        global $DIC;

        $this->user = $user;
        $this->ctrl = $ctrl;
        $this->profile_request = new ProfileGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );
    }

Here is the call graph for this function:

Member Function Documentation

execute()

ilUserProfileStartUpStep::execute

(

)

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

References ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), and ILIAS\Repository\user().

                             : void
    {
        $user_log = ilLoggerFactory::getLogger('user');

        if ($this->update_prompt) {
            $user_log->debug('Update last prompt date for user :' . $this->user->getId());
            $user_prompt_service = new ilUserProfilePromptService();
            $user_prompt_service->data()->saveLastUserPrompt($this->user->getId());
        }

        $this->ctrl->setParameterByClass('ilpersonalprofilegui', 'prompted', '1');
        $this->ctrl->redirectByClass(['ildashboardgui', 'ilpersonalprofilegui'], 'showPersonalData');
    }

Here is the call graph for this function:

isInFulfillment()

ilUserProfileStartUpStep::isInFulfillment

(

)

Definition at line 48 of file class.ilUserProfileStartUpStep.php.

References ILIAS\Repository\ctrl().

Referenced by shouldInterceptRequest().

                                     : bool
    {
        $baseClass = $this->profile_request->getBaseClass();
        if ($baseClass === '' || strtolower($baseClass) !== 'ildashboardgui') {
            return false;
        }

        return (
            strtolower($this->ctrl->getCmdClass()) === 'ilpersonalprofilegui'
            && in_array(
                strtolower($this->ctrl->getCmd()),
                [
                    'savepersonaldata',
                    'showpersonaldata',
                    'showprofile',
                    'showpublicprofile',
                    'savepublicprofile'
                ]
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

shouldInterceptRequest()

ilUserProfileStartUpStep::shouldInterceptRequest

(

)

Definition at line 70 of file class.ilUserProfileStartUpStep.php.

References ilLoggerFactory\getLogger(), IL_CAL_DATETIME, IL_CAL_DAY, isInFulfillment(), ilProfilePromptSettings\MODE_ONCE_AFTER_LOGIN, ilProfilePromptSettings\MODE_REPEAT, ilUtil\now(), and ILIAS\Repository\user().

                                            : bool
    {
        $user_log = ilLoggerFactory::getLogger('user');

        $user_prompt_service = new ilUserProfilePromptService();
        $prompt_settings = $user_prompt_service->data()->getSettings();
        $user_prompt = $user_prompt_service->data()->getUserPrompt($this->user->getId());

        $user_log->debug('Check Profile');

        if ($this->isInFulfillment()) {
            return false;
        }

        // profile incomplete
        if ($this->user->getProfileIncomplete()) {
            $user_log->debug('Is Incomplete');
            return true;
        }
        // if profile is not shared yet
        if (in_array($this->user->getPref('public_profile'), ['y', 'g'])) {
            return false;
        }

        $user_log->debug('Is not public');
        // x days after first login
        if ($prompt_settings->getMode() === ilProfilePromptSettings::MODE_ONCE_AFTER_LOGIN) {
            $user_log->debug('Mode: X days after login');
            // if user has logged in and not received a prompt yet
            if ($user_prompt->getFirstLogin() === '' || $user_prompt->getLastPrompt() !== '') {
                return false;
            }
            $user_log->debug('User has logged in and not prompted yet');
            // check if first login + days < now
            $deadline = new ilDateTime($user_prompt->getFirstLogin(), IL_CAL_DATETIME);
            $deadline->increment(IL_CAL_DAY, $prompt_settings->getDays());
            $user_log->debug('Check Deadline: ' . $deadline->get(IL_CAL_DATETIME) .
                ' < now: ' . ilUtil::now());
            if ($deadline->get(IL_CAL_DATETIME) < ilUtil::now()) {
                $user_log->debug('Deadline is due');
                $this->update_prompt = true;
                return true;
            }
        }

        // repeat every x days
        if ($prompt_settings->getMode() === ilProfilePromptSettings::MODE_REPEAT) {
            $user_log->debug('Mode: Repeat all x days');
            // check if max(first login,last prompted) + days < now
            $deadline = max($user_prompt->getFirstLogin(), $user_prompt->getLastPrompt());
            if ($deadline == '') {
                return false;
            }
            $user_log->debug('User logged in already.');
            $deadline_as_il_data = new ilDateTime($deadline, IL_CAL_DATETIME);
            $deadline_as_il_data->increment(IL_CAL_DAY, $prompt_settings->getDays());
            $user_log->debug('Check Deadline: ' . $deadline_as_il_data->get(IL_CAL_DATETIME) .
                ' < now: ' . ilUtil::now());
            if ($deadline_as_il_data->get(IL_CAL_DATETIME) < ilUtil::now()) {
                $user_log->debug('Deadline is due');
                $this->update_prompt = true;
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

shouldStoreRequestTarget()

ilUserProfileStartUpStep::shouldStoreRequestTarget

(

)

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

                                              : bool
    {
        return true;
    }

Field Documentation

$ctrl

ilCtrl ilUserProfileStartUpStep::$ctrl

private

Definition at line 27 of file class.ilUserProfileStartUpStep.php.

Referenced by __construct().

$profile_request

ILIAS User ProfileGUIRequest ilUserProfileStartUpStep::$profile_request

protected

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

$update_prompt

bool ilUserProfileStartUpStep::$update_prompt = false

protected

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

$user

ilObjUser ilUserProfileStartUpStep::$user

private

Definition at line 26 of file class.ilUserProfileStartUpStep.php.

Referenced by __construct().

---

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

• Services/User/classes/ProfilePrompt/class.ilUserProfileStartUpStep.php