ILIAS\User\Profile\Prompt\StartUpStep Class Reference

Inheritance diagram for ILIAS\User\Profile\Prompt\StartUpStep:

Collaboration diagram for ILIAS\User\Profile\Prompt\StartUpStep:

Public Member Functions
	__construct (private readonly \ilObjUser $user, private readonly \ilCtrl $ctrl, \ilDBInterface $db, Language $lng, HTTPServices $http, Refinery $refinery)
	shouldStoreRequestTarget ()
	isInFulfillment ()
	shouldInterceptRequest ()
	execute ()
Public Member Functions inherited from ILIAS\Init\StartupSequence\StartUpSequenceStep
	shouldStoreRequestTarget ()
	shouldInterceptRequest ()
	isInFulfillment ()
	execute ()

Private Attributes
const	LOGGING_DATE_TIME_FORMAT = 'Y-m-d H:i:s'
ilLogger	$logger
readonly GUIRequest	$profile_request
readonly Repository	$repository
bool	$update_prompt = false

Detailed Description

Definition at line 30 of file StartUpStep.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Profile\Prompt\StartUpStep::__construct	(	private readonly \ilObjUser	$user,
		private readonly \ilCtrl	$ctrl,
		\ilDBInterface	$db,
		Language	$lng,
		HTTPServices	$http,
		Refinery	$refinery
	)

Definition at line 39 of file StartUpStep.php.

References ilLoggerFactory\getLogger(), ILIAS\Repository\logger(), and ILIAS\UI\examples\Deck\repository().

      {
        $this->logger = \ilLoggerFactory::getLogger('user');
        $this->profile_request = new GUIRequest(
            $http,
            $refinery
        );
        $this->repository = new Repository(
            $db,
            $lng,
            new \ilSetting('user')
        );
    }

Here is the call graph for this function:

Member Function Documentation

execute()

ILIAS\User\Profile\Prompt\StartUpStep::execute

(

)

Definition at line 140 of file StartUpStep.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\logger(), ILIAS\UI\examples\Deck\repository(), and ILIAS\Repository\user().

                             : void
    {
        if ($this->update_prompt) {
            $this->logger->debug('Update last prompt date for user :' . $this->user->getId());
            $this->repository->updateLastUserPrompt($this->user->getId());
        }

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

Here is the call graph for this function:

isInFulfillment()

ILIAS\User\Profile\Prompt\StartUpStep::isInFulfillment

(

)

Definition at line 64 of file StartUpStep.php.

References ILIAS\Repository\ctrl().

Referenced by ILIAS\User\Profile\Prompt\StartUpStep\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()

ILIAS\User\Profile\Prompt\StartUpStep::shouldInterceptRequest

(

)

Definition at line 86 of file StartUpStep.php.

References ILIAS\User\Profile\Prompt\StartUpStep\isInFulfillment(), ILIAS\Repository\logger(), ILIAS\User\Profile\Prompt\Settings\MODE_ONCE_AFTER_LOGIN, ILIAS\User\Profile\Prompt\Settings\MODE_REPEAT, null, ILIAS\UI\examples\Deck\repository(), and ILIAS\Repository\user().

                                            : bool
    {
        $prompt_settings = $this->repository->getSettings();
        $user_prompt = $this->repository->getUserPrompt($this->user->getId());

        $this->logger->debug('Check Profile');

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

        if ($this->user->getProfileIncomplete()) {
            $this->logger->debug('Is Incomplete');
            return true;
        }

        if (in_array($this->user->getPref('public_profile'), ['y', 'g'])) {
            return false;
        }

        $this->logger->debug('Is not public');
        if ($prompt_settings->getMode() === Settings::MODE_ONCE_AFTER_LOGIN) {
            $this->logger->debug('Mode: X days after login');
            if ($user_prompt->getFirstLogin() === null || $user_prompt->getLastPrompt() !== null) {
                return false;
            }
            $this->logger->debug('User has logged in and not prompted yet');
            $deadline = $user_prompt->getFirstLogin()
                ->add(new \DateInterval("P{$prompt_settings->getDays()}D"));
            if ($deadline->getTimestamp() < time()) {
                $this->logger->debug('Deadline is due');
                $this->update_prompt = true;
                return true;
            }
        }

        if ($prompt_settings->getMode() === Settings::MODE_REPEAT) {
            $this->logger->debug('Mode: Repeat all x days');

            $last_interaction_date = max($user_prompt->getFirstLogin(), $user_prompt->getLastPrompt());
            if ($last_interaction_date === null) {
                return false;
            }
            $this->logger->debug('User logged in already.');
            $deadline = $last_interaction_date->add(new \DateInterval("P{$prompt_settings->getDays()}D"));
            if ($deadline->getTimestamp() < time()) {
                $this->logger->debug('Deadline is due');
                $this->update_prompt = true;
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

shouldStoreRequestTarget()

ILIAS\User\Profile\Prompt\StartUpStep::shouldStoreRequestTarget

(

)

Definition at line 59 of file StartUpStep.php.

                                              : bool
    {
        return true;
    }

Field Documentation

$logger

ilLogger ILIAS\User\Profile\Prompt\StartUpStep::$logger

private

Definition at line 33 of file StartUpStep.php.

$profile_request

readonly GUIRequest ILIAS\User\Profile\Prompt\StartUpStep::$profile_request

private

Definition at line 35 of file StartUpStep.php.

$repository

readonly Repository ILIAS\User\Profile\Prompt\StartUpStep::$repository

private

Definition at line 36 of file StartUpStep.php.

$update_prompt

bool ILIAS\User\Profile\Prompt\StartUpStep::$update_prompt = false

private

Definition at line 37 of file StartUpStep.php.

LOGGING_DATE_TIME_FORMAT

const ILIAS\User\Profile\Prompt\StartUpStep::LOGGING_DATE_TIME_FORMAT = 'Y-m-d H:i:s'

private

Definition at line 32 of file StartUpStep.php.

---

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

• components/ILIAS/User/src/Profile/Prompt/StartUpStep.php