ilShibbolethSettingsForm Class Reference

Class ilShibbolethSettingsForm. More...

Collaboration diagram for ilShibbolethSettingsForm:

Public Member Functions
	__construct (private readonly int $ref_id, private readonly object $parentObject, protected ilShibbolethSettings $settings, protected readonly string $action, protected readonly string $show_command='')
	getHTML ()
	initForm ()
	setValuesByPost ()
	saveObject ()

Protected Member Functions
	txt (string $var)
	infoTxt (string $var)
	fillObject ()
	getRoles (int $filter=ilRbacReview::FILTER_ALL_GLOBAL)

Protected Attributes
ilCtrl	$ctrl
StandardForm	$form = null
ilLanguage	$lng
ilRbacReview	$rbac_review
Refinery	$refinery
Renderer	$renderer
RequestInterface	$request
UIFactory	$ui
ilRbacSystem	$rbac_system

Detailed Description

Class ilShibbolethSettingsForm.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 31 of file class.ilShibbolethSettingsForm.php.

Constructor & Destructor Documentation

__construct()

ilShibbolethSettingsForm::__construct	(	private readonly int	$ref_id,
		private readonly object	$parentObject,
		protected ilShibbolethSettings	$settings,
		protected readonly string	$action,
		protected readonly string	$show_command = ''
	)

Definition at line 43 of file class.ilShibbolethSettingsForm.php.

      {
        global $DIC;
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->rbac_review = $DIC->rbac()->review();
        $this->refinery = $DIC->refinery();
        $this->renderer = $DIC->ui()->renderer();
        $this->request = $DIC->http()->request();
        $this->ui = $DIC->ui()->factory();
        $this->rbac_system = $DIC->rbac()->system();
 
        $this->initForm();
    }

References $DIC, ILIAS\Repository\ctrl(), initForm(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), renderer(), and ILIAS\Repository\ui().

Here is the call graph for this function:

Member Function Documentation

fillObject()

ilShibbolethSettingsForm::fillObject ( )

protected

Definition at line 243 of file class.ilShibbolethSettingsForm.php.

                                   : bool
    {
        return $this->form->getData() !== null;
    }

References ILIAS\Repository\form().

Referenced by saveObject().

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilShibbolethSettingsForm::getHTML

(

)

Definition at line 73 of file class.ilShibbolethSettingsForm.php.

                             : string
    {
        return $this->renderer->render($this->form);
    }

References ILIAS\Repository\form(), and renderer().

Here is the call graph for this function:

getRoles()

ilShibbolethSettingsForm::getRoles ( int  $filter = ilRbacReview::FILTER_ALL_GLOBAL )

protected

Returns

array<int|string, string>

Definition at line 260 of file class.ilShibbolethSettingsForm.php.

                                                                            : array
    {
        $opt = [];
        foreach ($this->rbac_review->getRolesByFilter($filter) as $role) {
            $opt[$role['obj_id']] = $role['title'] . ' (' . $role['obj_id'] . ')';
        }
 
        return $opt;
    }

Referenced by initForm().

Here is the caller graph for this function:

infoTxt()

ilShibbolethSettingsForm::infoTxt ( string  $var )

protected

Definition at line 68 of file class.ilShibbolethSettingsForm.php.

                                           : string
    {
        return $this->txt($var . '_info');
    }

References txt().

Here is the call graph for this function:

initForm()

ilShibbolethSettingsForm::initForm

(

)

@noRector

Definition at line 78 of file class.ilShibbolethSettingsForm.php.

                              : void
    {
        $field = $this->ui->input()->field();
        $custom_trafo = fn(callable $c): Transformation => $this->refinery->custom()->transformation($c);
        $active = $field->checkbox($this->txt('shib_active'), $this->lng->txt("auth_shib_instructions"))
                        ->withValue($this->settings->isActive())
                        ->withAdditionalTransformation($custom_trafo(function ($v): void {
                            $this->settings->setActive((bool) $v);
                        }));
 
        $auth_allow_local = $field->checkbox($this->txt('auth_allow_local'))
                                  ->withValue($this->settings->isLocalAuthAllowed())
                                  ->withAdditionalTransformation($custom_trafo(function ($v): void {
                                      $this->settings->setAllowLocalAuth((bool) $v);
                                  }));
 
        $account_creation = $field->switchableGroup(
            [
                ilShibbolethSettings::ACCOUNT_CREATION_ENABLED => $field->group(
                    [],
                    $this->lng->txt("shib_account_creation_enabled"),
                    $this->lng->txt("shib_account_creation_enabled_info")
                ),
                ilShibbolethSettings::ACCOUNT_CREATION_WITH_APPROVAL => $field->group(
                    [],
                    $this->lng->txt("shib_account_creation_with_approval"),
                    $this->lng->txt("shib_account_creation_with_approval_info")
                ),
                ilShibbolethSettings::ACCOUNT_CREATION_DISABLED => $field->group(
                    [],
                    $this->lng->txt("shib_account_creation_disabled"),
                    $this->lng->txt("shib_account_creation_disabled_info")
                )
            ],
            $this->lng->txt("shib_account_creation"),
            $this->lng->txt("shib_account_creation_info")
        )->withValue(
            $this->settings->getAccountCreation()
        )->withRequired(
            true
        )->withAdditionalTransformation($custom_trafo(function ($v): void {
            $this->settings->setAccountCreation((string) $v[0]);
        }));
 
        $default_user_role = $field->select($this->txt('shib_user_default_role'), $this->getRoles())
                                   ->withRequired(true)
                                   ->withValue($this->settings->getDefaultRole())
                                   ->withAdditionalTransformation($custom_trafo(function ($v): void {
                                       $this->settings->setDefaultRole((int) $v);
                                   }));
 
        $basic_section = $field->section([
            $active,
            $auth_allow_local,
            $account_creation,
            $default_user_role,
        ], $this->txt('shib'));
 
        // Federation
        $federation_name = $field->text($this->txt('shib_federation_name'))
                                 ->withRequired(true)
                                 ->withValue($this->settings->getFederationName())
                                 ->withAdditionalTransformation($custom_trafo(function ($v): void {
                                     $this->settings->setFederationName((string) $v);
                                 }));
 
        $login_type = $field->switchableGroup([
            'internal_wayf' => $field->group([
                $field->textarea('', $this->txt('shib_idp_list'))
                      ->withValue($this->settings->getIdPList())
                      ->withAdditionalTransformation($custom_trafo(function ($v): void {
                          $this->settings->setIdPList((string) $v);
                      }))
            ], $this->txt('shib_login_internal_wayf')),
            'external_wayf' => $field->group([
                $field->text('', $this->txt('shib_login_button'))
                      ->withValue($this->settings->getLoginButton())
                      ->withAdditionalTransformation($custom_trafo(function ($v): void {
                          $this->settings->setLoginButton((string) $v);
                      }))
            ], $this->txt('shib_login_external_wayf')),
            'embedded_wayf' => $field->group([], $this->txt('shib_login_embedded_wayf'))
                                     ->withByline($this->txt('shib_login_embedded_wayf_description')),
        ], $this->txt('shib_login_type'))
                            ->withRequired(true)
                            ->withValue($this->settings->getOrganisationSelectionType())
                            ->withAdditionalTransformation($custom_trafo(function ($v): void {
                                $this->settings->setOrganisationSelectionType($v[0]);
                            }));
 
        $instructions = $field->textarea($this->txt('auth_login_instructions'))
                              ->withValue($this->settings->get('login_instructions', ''))
                              ->withAdditionalTransformation($custom_trafo(function ($v): void {
                                  $this->settings->set('login_instructions', htmlspecialchars_decode($v));
                              }));
 
        $data_manipulation = $field->text($this->txt('shib_data_conv'))
                                   ->withValue($this->settings->get('data_conv'))
                                   ->withAdditionalTransformation($custom_trafo(function ($v): void {
                                       $this->settings->set('data_conv', (string) $v);
                                   }));
 
        $federation_section = $field->section([
            $federation_name,
            $login_type,
            $instructions,
            $data_manipulation
        ], '');
 
        // User Fields
        $fields = [];
        $fields[] = $field->text($this->txt('shib_login'))
                          ->withValue($this->settings->get('shib_login'))
                          ->withRequired(true)
                          ->withAdditionalTransformation($custom_trafo(function ($v): void {
                              $this->settings->set('shib_login', (string) $v);
                          }));
        foreach ($this->settings->getUserFields() as $field_name => $required) {
            $fields[] = $field->text($this->txt($field_name))
                              ->withValue($this->settings->get($field_name))
                              ->withRequired($required)
                              ->withAdditionalTransformation($custom_trafo(function ($v) use ($field_name): void {
                                  $this->settings->set($field_name, (string) $v);
                              }));
            $fields[] = $field->checkbox($this->txt('shib_update'))
                              ->withValue((bool) $this->settings->get('update_' . $field_name))
                              ->withAdditionalTransformation($custom_trafo(function ($v) use ($field_name): void {
                                  $this->settings->set('update_' . $field_name, (string) $v);
                              }));
        }
 
        $user_fields = $field->section(
            $fields,
            ''
        );
 
        // COMPLETE FORM
        $access = $this->rbac_system->checkAccess('write', $this->ref_id);
        if (!$access) {
            $basic_section = $basic_section->withDisabled(true);
            $federation_section = $federation_section->withDisabled(true);
            $user_fields = $user_fields->withDisabled(true);
        }
 
        $this->form = $this->ui->input()->container()->form()->standard(
            $this->ctrl->getFormAction($this->parentObject, $access ? $this->action : $this->show_command),
            [
                $basic_section,
                $federation_section,
                $user_fields
            ]
        );
 
        if (!$access) {
            $this->form = $this->form->withSubmitLabel($this->lng->txt('refresh'));
        }
    }

References $c, ilShibbolethSettings\ACCOUNT_CREATION_DISABLED, ilShibbolethSettings\ACCOUNT_CREATION_ENABLED, ilShibbolethSettings\ACCOUNT_CREATION_WITH_APPROVAL, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), getRoles(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), txt(), and ILIAS\Repository\ui().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

saveObject()

ilShibbolethSettingsForm::saveObject

(

)

Definition at line 248 of file class.ilShibbolethSettingsForm.php.

                                : bool
    {
        if (!$this->fillObject()) {
            return false;
        }
        $this->settings->store();
        return true;
    }

References fillObject(), and ILIAS\Repository\settings().

Here is the call graph for this function:

setValuesByPost()

ilShibbolethSettingsForm::setValuesByPost

(

)

Definition at line 237 of file class.ilShibbolethSettingsForm.php.

                                     : void
    {
        $request = $this->request->withParsedBody(array_map('htmlspecialchars', $this->request->getParsedBody()));
        $this->form = $this->form->withRequest($request);
    }

References $request, and ILIAS\Repository\form().

Here is the call graph for this function:

txt()

ilShibbolethSettingsForm::txt ( string  $var )

protected

Definition at line 63 of file class.ilShibbolethSettingsForm.php.

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

References ILIAS\Repository\lng().

Referenced by infoTxt(), and initForm().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ilShibbolethSettingsForm::$ctrl

protected

Definition at line 33 of file class.ilShibbolethSettingsForm.php.

$form

StandardForm ilShibbolethSettingsForm::$form = null

protected

Definition at line 34 of file class.ilShibbolethSettingsForm.php.

$lng

ilLanguage ilShibbolethSettingsForm::$lng

protected

Definition at line 35 of file class.ilShibbolethSettingsForm.php.

$rbac_review

ilRbacReview ilShibbolethSettingsForm::$rbac_review

protected

Definition at line 36 of file class.ilShibbolethSettingsForm.php.

$rbac_system

ilRbacSystem ilShibbolethSettingsForm::$rbac_system

protected

Definition at line 41 of file class.ilShibbolethSettingsForm.php.

$refinery

Refinery ilShibbolethSettingsForm::$refinery

protected

Definition at line 37 of file class.ilShibbolethSettingsForm.php.

$renderer

Renderer ilShibbolethSettingsForm::$renderer

protected

Definition at line 38 of file class.ilShibbolethSettingsForm.php.

$request

RequestInterface ilShibbolethSettingsForm::$request

protected

Definition at line 39 of file class.ilShibbolethSettingsForm.php.

Referenced by setValuesByPost().

$ui

UIFactory ilShibbolethSettingsForm::$ui

protected

Definition at line 40 of file class.ilShibbolethSettingsForm.php.

---

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

• components/ILIAS/AuthShibboleth/classes/Config/class.ilShibbolethSettingsForm.php