LastVisited.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\User\Settings\User;
 
use ILIAS\User\Settings\SettingDefinition;
use ILIAS\User\Settings\AvailablePages;
use ILIAS\User\Settings\AvailableSections;
use ILIAS\Language\Language;
use ILIAS\UI\Component\Input\Field\Factory as FieldFactory;
use ILIAS\UI\Component\Input\Input;
use ILIAS\Refinery\Factory as Refinery;
 
class LastVisited implements SettingDefinition
{
    private readonly ?\ilNavigationHistory $navigation_history;
 
    public function __construct()
    {
        global $DIC;
        $this->navigation_history = $DIC['ilNavigationHistory'] ?? null;
    }
 
    public function getIdentifier(): string
    {
        return 'last_visited';
    }
 
    public function isAvailable(): bool
    {
        return true;
    }
 
    public function getLabel(Language $lng): string
    {
        return $lng->txt($this->getIdentifier());
    }
 
    public function getSettingsPage(): AvailablePages
    {
        return AvailablePages::MainSettings;
    }
 
    public function getSection(): AvailableSections
    {
        return AvailableSections::Additional;
    }
 
    public function getInput(
        FieldFactory $field_factory,
        Language $lng,
        Refinery $refinery,
        \ilSetting $settings,
        ?\ilObjUser $user = null
    ): Input {
        return $field_factory->select(
            $lng->txt('user_store_last_visited'),
            [
                0 => $lng->txt('user_lv_keep_entries'),
                1 => $lng->txt('user_lv_keep_only_for_session'),
                2 => $lng->txt('user_lv_do_not_store')
            ]
        )->withRequired(true)
        ->withValue(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : 0
        );
    }
 
    public function getLegacyInput(
        Language $lng,
        \ilSetting $settings,
        ?\ilObjUser $user = null
    ): \ilFormPropertyGUI {
        $input = new \ilSelectInputGUI($lng->txt('user_store_last_visited'));
        $options = [
            0 => $lng->txt('user_lv_keep_entries'),
            1 => $lng->txt('user_lv_keep_only_for_session'),
            2 => $lng->txt('user_lv_do_not_store')
        ];
        $input->setOptions($options);
        $input->setValue(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : 0
        );
        return $input;
    }
 
    public function getDefaultValueForDisplay(
        Language $lng,
        \ilSetting $settings
    ): string {
        return $lng->txt('user_lv_keep_entries');
    }
 
    public function hasUserPersonalizedSetting(
        \ilSetting $settings,
        \ilObjUser $user
    ): bool {
        return $this->retrieveValueFromUser($user) !== 0;
    }
 
    public function persistUserInput(
        \ilObjUser $user,
        mixed $input
    ): \ilObjUser {
        $user->setPref('store_last_visited', $input ?? '0');
        if ((int) $input > 0) {
            $this->navigation_history->deleteDBEntries();
            if ($input === '2') {
                $this->navigation_history->deleteSessionEntries();
            }
        }
        return $user;
    }
 
    public function retrieveValueFromUser(\ilObjUser $user): int
    {
        return (int) ($user->getPref('store_last_visited') ?? 0);
    }
}