TimeFormat.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Calendar\UserSettings;
 
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 TimeFormat implements SettingDefinition
{
    public function getIdentifier(): string
    {
        return 'time_format';
    }
 
    public function isAvailable(): bool
    {
        return true;
    }
 
    public function getLabel(Language $lng): string
    {
        return $lng->txt('cal_user_time_format');
    }
 
    public function getSettingsPage(): AvailablePages
    {
        return AvailablePages::MainSettings;
    }
 
    public function getSection(): AvailableSections
    {
        return AvailableSections::DateTime;
    }
 
    public function getInput(
        FieldFactory $field_factory,
        Language $lng,
        Refinery $refinery,
        \ilSetting $settings,
        ?\ilObjUser $user = null
    ): Input {
        $lng->loadLanguageModule('dateplaner');
        return $field_factory->select(
            $lng->txt('cal_user_time_format'),
            $this->buildOptions(),
            $lng->txt('cal_time_format_info')
        )->withRequired(true)
        ->withValue(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : \ilCalendarSettings::_getInstance()->getDefaultTimeZone()
        );
    }
 
    public function getLegacyInput(
        Language $lng,
        \ilSetting $settings,
        ?\ilObjUser $user = null
    ): \ilFormPropertyGUI {
        $lng->loadLanguageModule('dateplaner');
        $input = new \ilSelectInputGUI($lng->txt('cal_user_time_format'));
        $input->setOptions($this->buildOptions());
        $input->setInfo($lng->txt('cal_time_format_info'));
        $input->setValue(
            $user !== null
                ? $this->retrieveValueFromUser($user)
                : \ilCalendarSettings::_getInstance()->getDefaultTimeFormat()
        );
        return $input;
    }
 
    public function getDefaultValueForDisplay(
        Language $lng,
        \ilSetting $settings
    ): string {
        return $this->buildOptions()[\ilCalendarSettings::_getInstance()->getDefaultTimeFormat()];
    }
 
    public function hasUserPersonalizedSetting(
        \ilSetting $settings,
        \ilObjUser $user
    ): bool {
        return $this->retrieveValueFromUser($user) !== \ilCalendarSettings::_getInstance()->getDefaultTimeFormat();
    }
 
    public function persistUserInput(
        \ilObjUser $user,
        mixed $input
    ): \ilObjUser {
        $calendar_settings = \ilCalendarUserSettings::_getInstance($user->getId());
        $calendar_settings->setTimeFormat(
            $input !== null ? (int) $input : \ilCalendarSettings::_getInstance()->getDefaultTimeFormat()
        );
        $calendar_settings->save();
        return $user;
    }
 
    public function retrieveValueFromUser(\ilObjUser $user): int
    {
        return (int) $user->getTimeFormat();
    }
 
    private function buildOptions(): array
    {
        return [
            \ilCalendarSettings::TIME_FORMAT_24 => '13:00',
            \ilCalendarSettings::TIME_FORMAT_12 => '1:00pm'
        ];
    }
}