SettingDefinition.php

Go to the documentation of this file.

<?php
 
namespace ILIAS\User\Settings;
 
use ILIAS\User\Property;
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;
 
interface SettingDefinition extends Property
{
    public function isAvailable(): bool;
 
    public function getSettingsPage(): AvailablePages;
 
    public function getDefaultValueForDisplay(
        Language $lng,
        \ilSetting $settings
    ): ?string;
 
    public function hasUserPersonalizedSetting(
        \ilSetting $settings,
        \ilObjUser $user
    ): bool;
 
    public function getInput(
        FieldFactory $field_factory,
        Language $lng,
        Refinery $refinery,
        \ilSetting $settings,
        ?\ilObjUser $user = null
    ): Input;
 
    public function getLegacyInput(
        Language $lng,
        \ilSetting $settings,
        ?\ilObjUser $user = null
    ): \ilFormPropertyGUI;
 
    public function persistUserInput(
        \ilObjUser $user,
        mixed $input
    ): \ilObjUser;
}