ILIAS\User\Settings\StartingPoint\Setting Class Reference

Inheritance diagram for ILIAS\User\Settings\StartingPoint\Setting:

Collaboration diagram for ILIAS\User\Settings\StartingPoint\Setting:

Public Member Functions
	__construct ()
	getIdentifier ()
	isAvailable ()
	If this function returns false the setting will not be shown, even if it's PropertyAttributes would allow it to be. More...
	getLabel (Language $lng)
	getSettingsPage ()
	getSection ()
	getInput (FieldFactory $field_factory, Language $lng, Refinery $refinery, \ilSetting $settings, ?\ilObjUser $user=null)
	getLegacyInput (Language $lng, \ilSetting $settings, ?\ilObjUser $user=null)
	You don't need to add a post_var to the input as the User will handle this for you, thus you can also not rely on the post_var anywhere else, as it will be changed. More...
	getDefaultValueForDisplay (Language $lng, \ilSetting $settings)
	hasUserPersonalizedSetting (\ilSetting $settings, \ilObjUser $user)
	persistUserInput (\ilObjUser $user, mixed $input, ?\ilPropertyFormGUI $form=null)
	validateUserChoice (\ilGlobalTemplateInterface $tpl, Language $lng, \ilPropertyFormGUI $form)
	retrieveValueFromUser (\ilObjUser $user)
Public Member Functions inherited from ILIAS\User\Settings\SettingDefinition
	isAvailable ()
	If this function returns false the setting will not be shown, even if it's PropertyAttributes would allow it to be. More...
	getSettingsPage ()
	getDefaultValueForDisplay (Language $lng, \ilSetting $settings)
	hasUserPersonalizedSetting (\ilSetting $settings, \ilObjUser $user)
	getInput (FieldFactory $field_factory, Language $lng, Refinery $refinery, \ilSetting $settings, ?\ilObjUser $user=null)
	getLegacyInput (Language $lng, \ilSetting $settings, ?\ilObjUser $user=null)
	You don't need to add a post_var to the input as the User will handle this for you, thus you can also not rely on the post_var anywhere else, as it will be changed. More...
	persistUserInput (\ilObjUser $user, mixed $input)
	getIdentifier ()
	getLabel (Language $lng)
	getSection ()
	retrieveValueFromUser (\ilObjUser $user)

Private Member Functions
	buildValidateObjectConstraint (Refinery $refinery, Language $lng)
	buildValueSetterArray (int $starting_point_id, ?int $object_ref_id)

Private Attributes
readonly Repository	$starting_point_repository

Detailed Description

Definition at line 33 of file Setting.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Settings\StartingPoint\Setting::__construct

(

)

Definition at line 37 of file Setting.php.

    {
        $this->starting_point_repository = LocalDIC::dic()[Repository::class];
    }

References ILIAS\User\LocalDIC\dic().

Here is the call graph for this function:

Member Function Documentation

buildValidateObjectConstraint()

ILIAS\User\Settings\StartingPoint\Setting::buildValidateObjectConstraint ( Refinery  $refinery, Language  $lng  )

private

Definition at line 241 of file Setting.php.

     : CustomConstraint {
        return $refinery->custom()->constraint(
            function (array $v): bool {
                if ($v[0] !== Repository::START_REPOSITORY_OBJ) {
                    return true;
                }
                if (!is_int($v[1]['usr_start_ref_id']) || !\ilObject::_exists($v[1]['usr_start_ref_id'], true)) {
                    return false;
                }
                return true;
            },
            $lng->txt('obj_ref_id_not_exist')
        );
    }

buildValueSetterArray()

ILIAS\User\Settings\StartingPoint\Setting::buildValueSetterArray ( int  $starting_point_id, ?int  $object_ref_id  )

private

Definition at line 267 of file Setting.php.

     : int|array {
        if ($starting_point_id !== Repository::START_REPOSITORY_OBJ) {
            return $starting_point_id;
        }
 
        return [
            0 => $starting_point_id,
            1 => [
                'usr_start_ref_id' => $object_ref_id
            ]
        ];
    }

getDefaultValueForDisplay()

ILIAS\User\Settings\StartingPoint\Setting::getDefaultValueForDisplay	(	Language	$lng,
		\ilSetting	$settings
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 179 of file Setting.php.

     : string {
        $default_starting_point = $this->starting_point_repository->getSystemDefaultStartingPointType();
        $starting_point = $this->starting_point_repository->getPossibleStartingPoints()[$default_starting_point];
        if ($default_starting_point !== Repository::START_REPOSITORY_OBJ
            || ($ref_id = $this->starting_point_repository->getSystemDefaultStartingObject()) === null
            || ($obj_id = \ilObject::_lookupObjId($ref_id)) === 0) {
            return $starting_point;
        }
        return $lng->txt('obj_' . \ilObject::_lookupType($obj_id)) . ' - ' . \ilObject::_lookupTitle($obj_id);
    }

getIdentifier()

ILIAS\User\Settings\StartingPoint\Setting::getIdentifier

(

)

Implements ILIAS\User\Property.

Definition at line 42 of file Setting.php.

                                   : string
    {
        return 'starting_point';
    }

Referenced by ILIAS\User\Settings\StartingPoint\Setting\getLabel().

Here is the caller graph for this function:

getInput()

ILIAS\User\Settings\StartingPoint\Setting::getInput	(	FieldFactory	$field_factory,
		Language	$lng,
		Refinery	$refinery,
		\ilSetting	$settings,
		?\ilObjUser	$user = null
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 67 of file Setting.php.

     : Input {
        $starting_point_id = null;
        $object_ref_id = null;
        if ($user !== null) {
            [
                'starting_point_id' => $starting_point_id ,
                'object_id' => $object_ref_id
            ] = $this->retrieveValueFromUser($user);
        }
        $possible_starting_points = $this->starting_point_repository->getPossibleStartingPoints();
        return $field_factory->switchableGroup(
            array_reduce(
                array_keys($possible_starting_points),
                static function (array $c, int $v) use (
                    $field_factory,
                    $lng,
                    $possible_starting_points,
                    $object_ref_id
                ): array {
                    $c[$v] = $field_factory->group(
                        $v === Repository::START_REPOSITORY_OBJ
                            ? [
                                'usr_start_ref_id' => $field_factory->numeric(
                                    $lng->txt('adm_user_starting_point_ref_id'),
                                    $object_ref_id === null || ($start_obj_id = \ilObject::_lookupObjId($object_ref_id)) === 0
                                        ? $lng->txt('adm_user_starting_point_ref_id_info')
                                        : $lng->txt('obj_' . \ilObject::_lookupType($start_obj_id))
                                                . ': ' . \ilObject::_lookupTitle($start_obj_id)
                                )->withRequired(true)
                            ] : [],
                        $lng->txt($possible_starting_points[$v])
                    );
                    return $c;
                },
                [
                    0 => $field_factory->group(
                        [],
                        $lng->txt('adm_user_starting_point_inherit'),
                        $lng->txt('adm_user_starting_point_inherit_info')
                    )
                ]
            ),
            $lng->txt('adm_user_starting_point'),
            $lng->txt('adm_user_starting_point_info')
        )->withAdditionalTransformation(
            $this->buildValidateObjectConstraint($refinery, $lng)
        )->withAdditionalTransformation(
            $refinery->custom()->transformation(
                static fn(array $v): array => [
                    'starting_point_id' => $refinery->kindlyTo()->int()->transform($v[0]),
                    'object_id' => $v[1]['usr_start_ref_id'] ?? null
                ]
            )
        )->withValue(
            $this->buildValueSetterArray(
                $starting_point_id,
                $object_ref_id
            )
        );
    }

References ILIAS\User\Settings\StartingPoint\Setting\retrieveValueFromUser().

Here is the call graph for this function:

getLabel()

ILIAS\User\Settings\StartingPoint\Setting::getLabel

(

Language

$lng

)

Implements ILIAS\User\Property.

Definition at line 52 of file Setting.php.

                                           : string
    {
        return $lng->txt($this->getIdentifier());
    }

References $lng, and ILIAS\User\Settings\StartingPoint\Setting\getIdentifier().

Here is the call graph for this function:

getLegacyInput()

ILIAS\User\Settings\StartingPoint\Setting::getLegacyInput	(	Language	$lng,
		\ilSetting	$settings,
		?\ilObjUser	$user = null
	)

You don't need to add a post_var to the input as the User will handle this for you, thus you can also not rely on the post_var anywhere else, as it will be changed.

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 134 of file Setting.php.

     : \ilFormPropertyGUI {
        $starting_point_id = null;
        $object_ref_id = null;
        if ($user !== null) {
            ['starting_point_id' => $starting_point_id , 'object_id' => $object_ref_id] = $this->retrieveValueFromUser($user);
        }
        $input = new \ilRadioGroupInputGUI($lng->txt('adm_user_starting_point'));
        $input->setInfo($lng->txt('adm_user_starting_point_info'));
        $inherit_starting_point = new \ilRadioOption($lng->txt('adm_user_starting_point_inherit'), '0');
        $inherit_starting_point->setInfo($lng->txt('adm_user_starting_point_inherit_info'));
        $input->addOption($inherit_starting_point);
        foreach ($this->starting_point_repository->getPossibleStartingPoints() as $value => $caption) {
            if ($value === Repository::START_REPOSITORY_OBJ) {
                continue;
            }
            $input->addOption(new \ilRadioOption($lng->txt($caption), (string) $value));
        }
        $input->setValue((string) $starting_point_id);
 
        $starting_point_repository = new \ilRadioOption(
            $lng->txt('adm_user_starting_point_object'),
            (string) Repository::START_REPOSITORY_OBJ
        );
        $repository_object_id = new \ilTextInputGUI($lng->txt('adm_user_starting_point_ref_id'), 'usr_start_ref_id');
        $repository_object_id->setInfo($lng->txt('adm_user_starting_point_ref_id_info'));
        $repository_object_id->setRequired(true);
        $repository_object_id->setSize(5);
        if ($object_ref_id !== null) {
            $repository_object_id->setValue($object_ref_id);
            if (($start_obj_id = \ilObject::_lookupObjId($object_ref_id)) !== 0) {
                $repository_object_id->setInfo(
                    $lng->txt('obj_' . \ilObject::_lookupType($start_obj_id)) .
                    ': ' . \ilObject::_lookupTitle($start_obj_id)
                );
            }
        }
        $starting_point_repository->addSubItem($repository_object_id);
        $input->addOption($starting_point_repository);
        return $input;
    }

getSection()

ILIAS\User\Settings\StartingPoint\Setting::getSection

(

)

Implements ILIAS\User\Property.

Definition at line 62 of file Setting.php.

                                : AvailableSections
    {
        return AvailableSections::Additional;
    }

References ILIAS\User\Settings\Additional.

getSettingsPage()

ILIAS\User\Settings\StartingPoint\Setting::getSettingsPage

(

)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 57 of file Setting.php.

                                     : AvailablePages
    {
        return AvailablePages::MainSettings;
    }

hasUserPersonalizedSetting()

ILIAS\User\Settings\StartingPoint\Setting::hasUserPersonalizedSetting	(	\ilSetting	$settings,
		\ilObjUser	$user
	)

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 193 of file Setting.php.

     : bool {
        return $this->starting_point_repository->isPersonalStartingPointEnabledForUser($user);
    }

isAvailable()

ILIAS\User\Settings\StartingPoint\Setting::isAvailable

(

)

If this function returns false the setting will not be shown, even if it's PropertyAttributes would allow it to be.

This is meant e.g. to check if the chat server is configured or the badges enabled. Settings that are not available will also not be available on the table to define their PropertyAttributes

Implements ILIAS\User\Settings\SettingDefinition.

Definition at line 47 of file Setting.php.

                                 : bool
    {
        return true;
    }

persistUserInput()

ILIAS\User\Settings\StartingPoint\Setting::persistUserInput	(	\ilObjUser	$user,
		mixed	$input,
		?\ilPropertyFormGUI	$form = null
	)

Definition at line 200 of file Setting.php.

     : \ilObjUser {
        if ($input === null) {
            $starting_point_id = 0;
            $object_ref_id = null;
        } elseif (is_array($input)) {
            ['starting_point_id' => $starting_point_id , 'object_id' => $object_ref_id] = $input;
        } else {
            $starting_point_id = (int) $input;
            $object_ref_id_input = $form->getInput('usr_start_ref_id');
            $object_ref_id = $object_ref_id_input === '' ? null : (int) $object_ref_id_input;
        }
        $this->starting_point_repository->setPersonalStartingPointForUser(
            $user,
            $starting_point_id,
            $object_ref_id
        );
        return $user;
    }

retrieveValueFromUser()

ILIAS\User\Settings\StartingPoint\Setting::retrieveValueFromUser

(

\ilObjUser

$user

)

Implements ILIAS\User\Property.

Definition at line 259 of file Setting.php.

                                                           : array
    {
        return [
            'starting_point_id' => $this->starting_point_repository->getPersonalStartingPointForUser($user),
            'object_id' => $this->starting_point_repository->getPersonalStartingObjectForUser($user)
        ];
    }

Referenced by ILIAS\User\Settings\StartingPoint\Setting\getInput().

Here is the caller graph for this function:

validateUserChoice()

ILIAS\User\Settings\StartingPoint\Setting::validateUserChoice	(	\ilGlobalTemplateInterface	$tpl,
		Language	$lng,
		\ilPropertyFormGUI	$form
	)

Definition at line 223 of file Setting.php.

     : bool {
        if ($form->getInput($this->getIdentifier()) !== Repository::START_REPOSITORY_OBJ) {
            return true;
        }
 
        $ref_id = $form->getInput('usr_start_ref_id');
        if (!is_numeric($ref_id) || !\ilObject::_exists((int) $ref_id, true)) {
            $tpl->setOnScreenMessage('failure', $lng->txt('obj_ref_id_not_exist'), true);
            return false;
        }
 
        return true;
    }

Field Documentation

$starting_point_repository

readonly Repository ILIAS\User\Settings\StartingPoint\Setting::$starting_point_repository

private

Definition at line 35 of file Setting.php.

---

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

• components/ILIAS/User/src/Settings/StartingPoint/Setting.php