ILIAS\User\Profile\Prompt\Settings Class Reference

Profile prompt settings. More...

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

Public Member Functions
	__construct (private int $mode, private ?int $days, private array $info_texts, private array $prompt_texts)
	getDays ()
	getMode ()
	getInfoTexts ()
	getPromptTexts ()
	getInfoText (string $lang)
	getPromptText (string $lang)
	withFormData (array $data)
	toForm (UIFactory $ui_factory, \ilLanguage $lng, Refinery $refinery)

Data Fields
const	MODE_INCOMPLETE_ONLY = 0
const	MODE_ONCE_AFTER_LOGIN = 1
const	MODE_REPEAT = 2

Private Member Functions
	buildLangTextAreaInputs (FieldFactory $field_factory, \ilLanguage $lng, \Closure $value_closure)
	buildPromptingSettingsInputs (FieldFactory $field_factory, \ilLanguage $lng, Refinery $refinery)
	buildPromptModeInput (FieldFactory $field_factory, \ilLanguage $lng, Refinery $refinery)

Detailed Description

Profile prompt settings.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 32 of file Settings.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Profile\Prompt\Settings::__construct	(	private int	$mode,
		private ?int	$days,
		private array	$info_texts,
		private array	$prompt_texts
	)

Parameters

array<string,string>	$info_texts
array<string,string>	$promp_texts

Definition at line 42 of file Settings.php.

      {
    }

Member Function Documentation

buildLangTextAreaInputs()

ILIAS\User\Profile\Prompt\Settings::buildLangTextAreaInputs ( FieldFactory  $field_factory, \ilLanguage  $lng, \Closure  $value_closure  )

private

Returns

array<>

Definition at line 126 of file Settings.php.

References $c, ilLanguage\getInstalledLanguages(), ilLanguage\txt(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by ILIAS\User\Profile\Prompt\Settings\buildPromptingSettingsInputs(), and ILIAS\User\Profile\Prompt\Settings\toForm().

     : array {
        return array_reduce(
            $lng->getInstalledLanguages(),
            function (array $c, string $v) use ($field_factory, $lng, $value_closure): array {
                $c[$v] = $field_factory
                    ->textarea($lng->txt("meta_l_{$v}"))
                    ->withValue($value_closure($v));
                return $c;
            },
            []
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildPromptingSettingsInputs()

ILIAS\User\Profile\Prompt\Settings::buildPromptingSettingsInputs ( FieldFactory  $field_factory, \ilLanguage  $lng, Refinery  $refinery  )

private

Returns

array<>

Definition at line 146 of file Settings.php.

References $lang, ILIAS\User\Profile\Prompt\Settings\buildLangTextAreaInputs(), ILIAS\User\Profile\Prompt\Settings\buildPromptModeInput(), ilLanguage\txt(), and ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation().

Referenced by ILIAS\User\Profile\Prompt\Settings\toForm().

     : array {
        $trafo = $refinery->custom()->transformation(
            function ($vs) {
                return array_filter($vs);
            }
        );
        return [
            'prompt_mode' => $this->buildPromptModeInput($field_factory, $lng, $refinery),
            'prompt_texts' => $field_factory->section(
                $this->buildLangTextAreaInputs(
                    $field_factory,
                    $lng,
                    fn(string $lang): string => $this->prompt_texts[$lang] ?? ''
                ),
                $lng->txt('user_profile_prompt_text'),
                $lng->txt('user_profile_prompt_text_info')
            )->withAdditionalTransformation($trafo)
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildPromptModeInput()

ILIAS\User\Profile\Prompt\Settings::buildPromptModeInput ( FieldFactory  $field_factory, \ilLanguage  $lng, Refinery  $refinery  )

private

Definition at line 170 of file Settings.php.

References ILIAS\User\Profile\Prompt\Settings\getDays(), ILIAS\User\Profile\Prompt\Settings\getMode(), ILIAS\User\Profile\Prompt\Settings\MODE_INCOMPLETE_ONLY, ILIAS\User\Profile\Prompt\Settings\MODE_ONCE_AFTER_LOGIN, ILIAS\User\Profile\Prompt\Settings\MODE_REPEAT, null, ilLanguage\txt(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by ILIAS\User\Profile\Prompt\Settings\buildPromptingSettingsInputs().

     : SwitchableGroup {
        $trafo = $refinery->custom()->transformation(
            static fn(array $vs): array => [
                    'mode' => $refinery->kindlyTo()->int()->transform($vs[0]),
                    'days' => $vs[1]['days'] ?? null
                ]
        );
        return $field_factory->switchableGroup(
            [
                Settings::MODE_INCOMPLETE_ONLY => $field_factory->group(
                    [],
                    $lng->txt('user_prompt_incomplete'),
                    $lng->txt('user_prompt_incomplete_info')
                ),
                Settings::MODE_ONCE_AFTER_LOGIN => $field_factory->group(
                    [
                            'days' => $field_factory
                                ->numeric($lng->txt('days'))
                                ->withRequired(true)
                                ->withAdditionalTransformation($refinery->int()->isGreaterThan(0))
                                ->withValue($this->getDays())
                        ],
                    $lng->txt('user_prompt_once_after_login'),
                    $lng->txt('user_prompt_once_after_login_info')
                ),
                Settings::MODE_REPEAT => $field_factory->group(
                    [
                            'days' => $field_factory
                                ->numeric($lng->txt('days'))
                                ->withRequired(true)
                                ->withAdditionalTransformation($refinery->int()->isGreaterThan(0))
                                ->withValue($this->getDays())
                        ],
                    $lng->txt('user_prompt_repeat'),
                    $lng->txt('user_prompt_repeat_info')
                ),
            ],
            $lng->txt('user_prompting_recurrence')
        )->withAdditionalTransformation($trafo)
        ->withValue($this->getMode());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDays()

ILIAS\User\Profile\Prompt\Settings::getDays

(

)

Definition at line 50 of file Settings.php.

Referenced by ILIAS\User\Profile\Prompt\Settings\buildPromptModeInput(), and ILIAS\User\Profile\Prompt\Repository\saveSettings().

                             : ?int
    {
        return $this->days;
    }

Here is the caller graph for this function:

getInfoText()

ILIAS\User\Profile\Prompt\Settings::getInfoText

(

string

$lang

)

Definition at line 76 of file Settings.php.

References $lang.

                                             : string
    {
        return $this->info_texts[$lang] ?? '';
    }

getInfoTexts()

ILIAS\User\Profile\Prompt\Settings::getInfoTexts

(

)

Returns

array<string>

Definition at line 63 of file Settings.php.

Referenced by ILIAS\User\Profile\Prompt\Repository\saveSettings().

                                  : array
    {
        return $this->info_texts;
    }

Here is the caller graph for this function:

getMode()

ILIAS\User\Profile\Prompt\Settings::getMode

(

)

Definition at line 55 of file Settings.php.

Referenced by ILIAS\User\Profile\Prompt\Settings\buildPromptModeInput(), and ILIAS\User\Profile\Prompt\Repository\saveSettings().

                             : int
    {
        return $this->mode;
    }

Here is the caller graph for this function:

getPromptText()

ILIAS\User\Profile\Prompt\Settings::getPromptText

(

string

$lang

)

Definition at line 81 of file Settings.php.

References $lang.

                                               : string
    {
        return $this->prompt_texts[$lang] ?? '';
    }

getPromptTexts()

ILIAS\User\Profile\Prompt\Settings::getPromptTexts

(

)

Returns

array<string>

Definition at line 71 of file Settings.php.

Referenced by ILIAS\User\Profile\Prompt\Repository\saveSettings().

                                    : array
    {
        return $this->prompt_texts;
    }

Here is the caller graph for this function:

toForm()

ILIAS\User\Profile\Prompt\Settings::toForm	(	UIFactory	$ui_factory,
		\ilLanguage	$lng,
		Refinery	$refinery
	)

Returns

array<>

Definition at line 99 of file Settings.php.

References $lang, $lng, ILIAS\UI\examples\Layout\Page\Standard\$refinery, ILIAS\User\Profile\Prompt\Settings\buildLangTextAreaInputs(), ILIAS\User\Profile\Prompt\Settings\buildPromptingSettingsInputs(), ilLanguage\loadLanguageModule(), and ilLanguage\txt().

     : array {
        $lng->loadLanguageModule('meta');

        return [
            'profile_info' => $ui_factory->input()->field()->section(
                $this->buildLangTextAreaInputs(
                    $ui_factory->input()->field(),
                    $lng,
                    fn(string $lang): string => $this->info_texts[$lang] ?? ''
                ),
                $lng->txt('user_profile_info_std'),
                $lng->txt('user_profile_info_text_info')
            ),
            'prompting_settings' => $ui_factory->input()->field()->section(
                $this->buildPromptingSettingsInputs($ui_factory->input()->field(), $lng, $refinery),
                $lng->txt('user_prompting_settings')
            )
        ];
    }

Here is the call graph for this function:

withFormData()

ILIAS\User\Profile\Prompt\Settings::withFormData

(

array

$data

)

Definition at line 86 of file Settings.php.

                                             : self
    {
        $clone = clone $this;
        $clone->mode = $data['prompting_settings']['prompt_mode']['mode'];
        $clone->days = $data['prompting_settings']['prompt_mode']['days'];
        $clone->info_texts = $data['profile_info'];
        $clone->prompt_texts = $data['prompting_settings']['prompt_texts'];
        return $clone;
    }

Field Documentation

MODE_INCOMPLETE_ONLY

const ILIAS\User\Profile\Prompt\Settings::MODE_INCOMPLETE_ONLY = 0

Definition at line 34 of file Settings.php.

Referenced by ILIAS\User\Profile\Prompt\Settings\buildPromptModeInput().

MODE_ONCE_AFTER_LOGIN

const ILIAS\User\Profile\Prompt\Settings::MODE_ONCE_AFTER_LOGIN = 1

Definition at line 35 of file Settings.php.

Referenced by ILIAS\User\Profile\Prompt\Settings\buildPromptModeInput(), and ILIAS\User\Profile\Prompt\StartUpStep\shouldInterceptRequest().

MODE_REPEAT

const ILIAS\User\Profile\Prompt\Settings::MODE_REPEAT = 2

Definition at line 36 of file Settings.php.

Referenced by ILIAS\User\Profile\Prompt\Settings\buildPromptModeInput(), and ILIAS\User\Profile\Prompt\StartUpStep\shouldInterceptRequest().

---

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

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