ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
ilShibbolethSettingsForm Class Reference

Class ilShibbolethSettingsForm. More...

+ Collaboration diagram for ilShibbolethSettingsForm:

Public Member Functions

 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
 
ILIAS UI Factory $ui
 
ILIAS UI Renderer $renderer
 
ILIAS UI Component Input Container Form Standard $form = null
 
string $action
 
Psr Http Message RequestInterface $request
 
ilLanguage $lng
 
ilShibbolethSettings $settings
 

Private Attributes

 $refinery
 

Detailed Description

Class ilShibbolethSettingsForm.

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

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

Member Function Documentation

◆ fillObject()

ilShibbolethSettingsForm::fillObject ( )
protected

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

References ILIAS\Repository\form().

Referenced by saveObject().

214  : bool
215  {
216  return $this->form->getData() === true;
217  }
ILIAS\Repository\form
form( $class_path, string $cmd, string $submit_caption="")
Definition: trait.GlobalDICGUIServices.php:126
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getHTML()

ilShibbolethSettingsForm::getHTML ( )

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

References ILIAS\Repository\form().

69  : string
70  {
71  return $this->renderer->render($this->form);
72  }
ILIAS\Repository\form
form( $class_path, string $cmd, string $submit_caption="")
Definition: trait.GlobalDICGUIServices.php:126
+ 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 231 of file class.ilShibbolethSettingsForm.php.

References $DIC.

Referenced by initForm().

231  : array
232  {
233  global $DIC;
234  $opt = [];
235  foreach ($DIC->rbac()->review()->getRolesByFilter($filter) as $role) {
236  $opt[$role['obj_id']] = $role['title'] . ' (' . $role['obj_id'] . ')';
237  }
238 
239  return $opt;
240  }
$DIC
global $DIC
Definition: feed.php:28
+ Here is the caller graph for this function:

◆ infoTxt()

ilShibbolethSettingsForm::infoTxt ( string  $var)
protected

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

References txt().

64  : string
65  {
66  return $this->txt($var . '_info');
67  }
+ Here is the call graph for this function:

◆ initForm()

ilShibbolethSettingsForm::initForm ( )

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

References Vendor\Package\$c, ILIAS\Repository\form(), getRoles(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), txt(), ILIAS\Repository\ui(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

74  : void
75  {
76  $field = $this->ui->input()->field();
77  $custom_trafo = fn (callable $c) => $this->refinery->custom()->transformation($c);
79  $read_me_link = "./Services/AuthShibboleth/README.SHIBBOLETH.txt";
80  $active = $field->checkbox($this->txt('shib_active'), $this->lng->txt("auth_shib_instructions"))
81  ->withValue($this->settings->isActive())
82  ->withAdditionalTransformation($custom_trafo(function ($v): void {
83  $this->settings->setActive((bool) $v);
84  }));
85 
86  $auth_allow_local = $field->checkbox($this->txt('auth_allow_local'))
87  ->withValue($this->settings->isLocalAuthAllowed())
88  ->withAdditionalTransformation($custom_trafo(function ($v): void {
89  $this->settings->setAllowLocalAuth((bool) $v);
90  }));
91 
92  $admin_must_activate = $field->checkbox(
93  $this->txt('shib_activate_new'),
94  $this->lng->txt("shib_activate_new_info")
95  )->withValue($this->settings->adminMustActivate())
96  ->withAdditionalTransformation(
97  $custom_trafo(function ($v): void {
98  $this->settings->setAdminMustActivate((bool) $v);
99  })
100  );
101 
102  $default_user_role = $field->select($this->txt('shib_user_default_role'), $this->getRoles())
103  ->withRequired(true)
104  ->withValue($this->settings->getDefaultRole())
105  ->withAdditionalTransformation($custom_trafo(function ($v): void {
106  $this->settings->setDefaultRole((int) $v);
107  }));
108 
109  $basic_section = $field->section([
110  $active,
111  $auth_allow_local,
112  $admin_must_activate,
113  $default_user_role,
114  ], $this->txt('shib'));
115 
116  // Federation
117  $federation_name = $field->text($this->txt('shib_federation_name'))
118  ->withRequired(true)
119  ->withValue($this->settings->getFederationName())
120  ->withAdditionalTransformation($custom_trafo(function ($v): void {
121  $this->settings->setFederationName((string) $v);
122  }));
123 
124  $login_type = $field->switchableGroup([
125  'internal_wayf' => $field->group([
126  $field->textarea('', $this->txt('shib_idp_list'))
127  ->withValue($this->settings->getIdPList())
128  ->withAdditionalTransformation($custom_trafo(function ($v): void {
129  $this->settings->setIdPList((string) $v);
130  }))
131  ], $this->txt('shib_login_internal_wayf')),
132  'external_wayf' => $field->group([
133  $field->text('', $this->txt('shib_login_button'))
134  ->withValue($this->settings->getLoginButton())
135  ->withAdditionalTransformation($custom_trafo(function ($v): void {
136  $this->settings->setLoginButton((string) $v);
137  }))
138  ], $this->txt('shib_login_external_wayf')),
139  'embedded_wayf' => $field->group([], $this->txt('shib_login_embedded_wayf'))
140  ->withByline($this->txt('shib_login_embedded_wayf_description')),
141  ], $this->txt('shib_login_type'))
142  ->withRequired(true)
143  ->withValue($this->settings->getOrganisationSelectionType())
144  ->withAdditionalTransformation($custom_trafo(function ($v): void {
145  $this->settings->setOrganisationSelectionType($v[0]);
146  }));
147 
148  $instructions = $field->textarea($this->txt('auth_login_instructions'))
149  ->withValue($this->settings->get('login_instructions', ''))
150  ->withAdditionalTransformation($custom_trafo(function ($v): void {
151  $this->settings->set('login_instructions', htmlspecialchars_decode($v));
152  }));
153 
154  $data_manipulation = $field->text($this->txt('shib_data_conv'))
155  ->withValue($this->settings->get('data_conv'))
156  ->withAdditionalTransformation($custom_trafo(function ($v): void {
157  $this->settings->set('data_conv', (string) $v);
158  }));
159 
160  $federation_section = $field->section([
161  $federation_name,
162  $login_type,
163  $instructions,
164  $data_manipulation
165  ], '');
166 
167  // User Fields
168  $fields = [];
169  $fields[] = $field->text($this->txt('shib_login'))
170  ->withValue($this->settings->get('shib_login'))
171  ->withRequired(true)
172  ->withAdditionalTransformation($custom_trafo(function ($v): void {
173  $this->settings->set('shib_login', (string) $v);
174  }));
175  foreach ($this->settings->getUserFields() as $field_name => $required) {
176  $fields[] = $field->text($this->txt($field_name))
177  ->withValue($this->settings->get($field_name))
178  ->withRequired($required)
179  ->withAdditionalTransformation($custom_trafo(function ($v) use ($field_name): void {
180  $this->settings->set($field_name, (string) $v);
181  }));
182  $fields[] = $field->checkbox($this->txt('shib_update'))
183  ->withValue((bool) $this->settings->get('update_' . $field_name))
184  ->withAdditionalTransformation($custom_trafo(function ($v) use ($field_name): void {
185  $this->settings->set('update_' . $field_name, (string) $v);
186  }));
187  }
188 
189  $user_fields = $field->section(
190  $fields,
191  ''
192  );
193 
194  // COMPLETE FORM
195 
196  $this->form = $this->ui->input()->container()->form()->standard(
197  $this->action,
198  [
199  $basic_section,
200  $federation_section,
201  $user_fields
202  ]
203  )->withAdditionalTransformation($this->refinery->custom()->transformation(function ($v) {
204  return true;
205  }));
206  }
ILIAS\UI\Implementation\Component\Input\withValue
withValue($value)
Get an input like this with another value displayed on the client side.
Definition: Group.php:58
ILIAS\Repository\form
form( $class_path, string $cmd, string $submit_caption="")
Definition: trait.GlobalDICGUIServices.php:126
ilShibbolethSettingsForm\getRoles
getRoles(int $filter=ilRbacReview::FILTER_ALL_GLOBAL)
Definition: class.ilShibbolethSettingsForm.php:231
+ Here is the call graph for this function:

◆ saveObject()

ilShibbolethSettingsForm::saveObject ( )

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

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

219  : bool
220  {
221  if (!$this->fillObject()) {
222  return false;
223  }
224  $this->settings->store();
225  return true;
226  }
+ Here is the call graph for this function:

◆ setValuesByPost()

ilShibbolethSettingsForm::setValuesByPost ( )

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

References ILIAS\Repository\form().

Referenced by ilAuthShibbolethSettingsGUI\save().

208  : void
209  {
210  $request = $this->request->withParsedBody(array_map('htmlspecialchars', $this->request->getParsedBody()));
211  $this->form = $this->form->withRequest($request);
212  }
ilShibbolethSettingsForm\$request
Psr Http Message RequestInterface $request
Definition: class.ilShibbolethSettingsForm.php:38
ILIAS\Repository\form
form( $class_path, string $cmd, string $submit_caption="")
Definition: trait.GlobalDICGUIServices.php:126
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ txt()

ilShibbolethSettingsForm::txt ( string  $var)
protected

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

References ILIAS\Repository\lng().

Referenced by infoTxt(), and initForm().

59  : string
60  {
61  return $this->lng->txt($var);
62  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $action

string ilShibbolethSettingsForm::$action
protected

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

◆ $ctrl

ilCtrl ilShibbolethSettingsForm::$ctrl
protected

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

◆ $form

ILIAS UI Component Input Container Form Standard ilShibbolethSettingsForm::$form = null
protected

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

◆ $lng

ilLanguage ilShibbolethSettingsForm::$lng
protected

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

◆ $refinery

ilShibbolethSettingsForm::$refinery
private

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

◆ $renderer

ILIAS UI Renderer ilShibbolethSettingsForm::$renderer
protected

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

◆ $request

Psr Http Message RequestInterface ilShibbolethSettingsForm::$request
protected

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

◆ $settings

ilShibbolethSettings ilShibbolethSettingsForm::$settings
protected

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

◆ $ui

ILIAS UI Factory ilShibbolethSettingsForm::$ui
protected

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

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