Collaboration diagram for ILIAS\File\Icon\IconFormUI:

Public Member Functions
	__construct (private Icon $icon, private string $mode, private IconRepositoryInterface $icon_repo)

	getIconForm ()

	transformCheckboxInputValueToBool ($checkbox_input_value)

Data Fields
const	MODE_CREATE = 'create'

const	MODE_EDIT = 'edit'

const	FORM_ICON_CREATION = 'form_icon_creation'

const	FORM_ICON_UPDATING = 'form_icon_updating'

const	INPUT_ICON = 'input_icon'

const	INPUT_DESC_ICON = 'input_desc_icon'

const	INPUT_ACTIVE = 'input_active'

const	INPUT_DESC_ACTIVE = 'input_desc_active'

const	INPUT_SUFFIXES = 'input_suffixes'

const	INPUT_DESC_SUFFIXES = 'input_desc_suffixes'

Protected Member Functions
	initIconForm ()

Private Attributes
ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs

Factory	$ui_factory

WrapperFactory	$wrapper

Standard	$icon_form

ILIAS Refinery Factory	$refinery

Detailed Description

Author: Lukas Zehnder lukas.nosp@m.@sr..nosp@m.solut.nosp@m.ions

Definition at line 31 of file IconFormUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\File\Icon\IconFormUI::__construct	(	private Icon	$icon,
		private string	$mode,
		private IconRepositoryInterface	$icon_repo
	)

Definition at line 52 of file IconFormUI.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\File\Icon\IconFormUI\initIconForm(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

       {
         global $DIC;
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->tabs = $DIC->tabs();
         $this->ui_factory = $DIC->ui()->factory();
         $this->wrapper = $DIC->http()->wrapper();
         $this->refinery = $DIC->refinery();
 
         $this->initIconForm();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getIconForm()

ILIAS\File\Icon\IconFormUI::getIconForm ( )

Definition at line 153 of file IconFormUI.php.

References ILIAS\File\Icon\IconFormUI\$icon_form.

                                  : Standard
     {
         return $this->icon_form;
     }

◆ initIconForm()

ILIAS\File\Icon\IconFormUI::initIconForm ( )

protected

Definition at line 68 of file IconFormUI.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\File\Icon\ilObjFileIconsOverviewGUI\CMD_CREATE, ILIAS\File\Icon\ilObjFileIconsOverviewGUI\CMD_INDEX, ILIAS\File\Icon\ilObjFileIconsOverviewGUI\CMD_UPDATE, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), ILIAS\File\Icon\IconFormUI\transformCheckboxInputValueToBool(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by ILIAS\File\Icon\IconFormUI\__construct().

                                      : void
     {
         $this->tabs->clearSubTabs();
         $this->tabs->clearTargets();
         $back_target = $this->ctrl->getLinkTargetByClass(
             ilObjFileIconsOverviewGUI::class,
             ilObjFileIconsOverviewGUI::CMD_INDEX
         );
         $this->tabs->setBackTarget($this->lng->txt('back'), $back_target);
 
         if ($this->mode === self::MODE_EDIT) {
             $form_title = $this->lng->txt(self::FORM_ICON_UPDATING);
             $form_action = $this->ctrl->getFormActionByClass(
                 ilObjFileIconsOverviewGUI::class,
                 ilObjFileIconsOverviewGUI::CMD_UPDATE
             );
         } else {
             $form_title = $this->lng->txt(self::FORM_ICON_CREATION);
             $form_action = $this->ctrl->getFormActionByClass(
                 ilObjFileIconsOverviewGUI::class,
                 ilObjFileIconsOverviewGUI::CMD_CREATE
             );
         }
 
         $rid = $this->icon->getRid();
         $this->ctrl->setParameterByClass(ilIconUploadHandlerGUI::class, 'rid', $rid);
         $icon_input = $this->ui_factory->input()->field()->file(
             new ilIconUploadHandlerGUI(),
             $this->lng->txt(self::INPUT_ICON),
             $this->lng->txt(self::INPUT_DESC_ICON)
         )->withAcceptedMimeTypes(
             [MimeType::IMAGE__SVG_XML]
         )->withRequired(
             true
         );
         if ($rid !== "") {
             $icon_input = $icon_input->withValue([$rid]);
         }
 
         $active_input = $this->ui_factory->input()->field()->checkbox(
             $this->lng->txt(self::INPUT_ACTIVE),
             $this->lng->txt(self::INPUT_DESC_ACTIVE)
         )->withValue(
             $this->icon->isActive()
         );
 
         $suffix_input = $this->ui_factory->input()->field()->text(
             $this->lng->txt(self::INPUT_SUFFIXES),
             $this->lng->txt(self::INPUT_DESC_SUFFIXES)
         )->withRequired(
             true
         )->withValue(
             $this->icon_repo->turnSuffixesArrayIntoString($this->icon->getSuffixes())
         )->withAdditionalTransformation(
             $this->refinery->custom()->transformation(fn($suffixes_input): array => $this->icon_repo->turnSuffixesStringIntoArray($suffixes_input))
         )->withAdditionalTransformation(
             $this->refinery->custom()->constraint(fn($suffixes_input): bool => $this->icon_repo->hasSuffixInputOnlyAllowedCharacters($suffixes_input), $this->lng->txt('msg_error_suffixes_with_forbidden_characters'))
         )->withAdditionalTransformation(
             $this->refinery->custom()->constraint(fn($suffixes_input): bool => $this->icon_repo->hasSuffixInputNoDuplicatesToItsOwnEntries($suffixes_input), $this->lng->txt('msg_error_duplicate_suffix_entries'))
         )->withAdditionalTransformation(
             $this->refinery->custom()->constraint(function ($suffixes_input): bool {
                 //retrieve the value of the active_input as it is needed for the causesNoActiveSuffixesConflict validation
                 $section = $this->icon_form->getInputs()[0];
                 $inputs = $section->getInputs();
                 $input_active = $inputs[self::INPUT_ACTIVE];
                 $field_is_active = $input_active->getName();
                 $to_bool = $this->refinery->custom()->transformation(fn($checkbox_input_value): bool => $this->transformCheckboxInputValueToBool($checkbox_input_value));
                 $post_is_active_value = $this->wrapper->post()->retrieve($field_is_active, $to_bool);
 
                 return $this->icon_repo->causesNoActiveSuffixesConflict(
                     $suffixes_input,
                     $post_is_active_value,
                     $this->icon
                 );
             }, $this->lng->txt('msg_error_active_suffixes_conflict'))
         );
 
         $section = $this->ui_factory->input()->field()->section([
             self::INPUT_ICON => $icon_input,
             self::INPUT_ACTIVE => $active_input,
             self::INPUT_SUFFIXES => $suffix_input
         ], $form_title);
         $this->icon_form = $this->ui_factory->input()->container()->form()->standard($form_action, [$section]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transformCheckboxInputValueToBool()

ILIAS\File\Icon\IconFormUI::transformCheckboxInputValueToBool ( $checkbox_input_value )

Definition at line 158 of file IconFormUI.php.

References null, and ILIAS\Repository\refinery().

Referenced by ILIAS\File\Icon\IconFormUI\initIconForm().

                                                                             : bool
     {
         if ($checkbox_input_value !== null) {
             $checkbox_input_value_str = $this->refinery->kindlyTo()->string()->transform($checkbox_input_value);
             if ($checkbox_input_value_str == "checked") {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ILIAS\File\Icon\IconFormUI::$ctrl

private

Definition at line 44 of file IconFormUI.php.

◆ $icon_form

Standard ILIAS\File\Icon\IconFormUI::$icon_form

private

Definition at line 49 of file IconFormUI.php.

Referenced by ILIAS\File\Icon\IconFormUI\getIconForm().

◆ $lng

ilLanguage ILIAS\File\Icon\IconFormUI::$lng

private

Definition at line 45 of file IconFormUI.php.

◆ $refinery

ILIAS Refinery Factory ILIAS\File\Icon\IconFormUI::$refinery

private

Definition at line 50 of file IconFormUI.php.

◆ $tabs

ilTabsGUI ILIAS\File\Icon\IconFormUI::$tabs

private

Definition at line 46 of file IconFormUI.php.

◆ $ui_factory

Factory ILIAS\File\Icon\IconFormUI::$ui_factory

private

Definition at line 47 of file IconFormUI.php.

◆ $wrapper

WrapperFactory ILIAS\File\Icon\IconFormUI::$wrapper

private

Definition at line 48 of file IconFormUI.php.

◆ FORM_ICON_CREATION

const ILIAS\File\Icon\IconFormUI::FORM_ICON_CREATION = 'form_icon_creation'

Definition at line 35 of file IconFormUI.php.

◆ FORM_ICON_UPDATING

const ILIAS\File\Icon\IconFormUI::FORM_ICON_UPDATING = 'form_icon_updating'

Definition at line 36 of file IconFormUI.php.

◆ INPUT_ACTIVE

const ILIAS\File\Icon\IconFormUI::INPUT_ACTIVE = 'input_active'

Definition at line 39 of file IconFormUI.php.

Referenced by ILIAS\File\Icon\ilObjFileIconsOverviewGUI\create(), and ILIAS\File\Icon\ilObjFileIconsOverviewGUI\update().

◆ INPUT_DESC_ACTIVE

const ILIAS\File\Icon\IconFormUI::INPUT_DESC_ACTIVE = 'input_desc_active'

Definition at line 40 of file IconFormUI.php.

◆ INPUT_DESC_ICON

const ILIAS\File\Icon\IconFormUI::INPUT_DESC_ICON = 'input_desc_icon'

Definition at line 38 of file IconFormUI.php.

◆ INPUT_DESC_SUFFIXES

const ILIAS\File\Icon\IconFormUI::INPUT_DESC_SUFFIXES = 'input_desc_suffixes'

Definition at line 42 of file IconFormUI.php.

◆ INPUT_ICON

const ILIAS\File\Icon\IconFormUI::INPUT_ICON = 'input_icon'

Definition at line 37 of file IconFormUI.php.

Referenced by ILIAS\File\Icon\ilObjFileIconsOverviewGUI\create(), and ILIAS\File\Icon\ilObjFileIconsOverviewGUI\update().

◆ INPUT_SUFFIXES

const ILIAS\File\Icon\IconFormUI::INPUT_SUFFIXES = 'input_suffixes'

Definition at line 41 of file IconFormUI.php.

Referenced by ILIAS\File\Icon\ilObjFileIconsOverviewGUI\create(), and ILIAS\File\Icon\ilObjFileIconsOverviewGUI\update().

◆ MODE_CREATE

const ILIAS\File\Icon\IconFormUI::MODE_CREATE = 'create'

Definition at line 33 of file IconFormUI.php.

Referenced by ILIAS\File\Icon\ilObjFileIconsOverviewGUI\create(), and ILIAS\File\Icon\ilObjFileIconsOverviewGUI\openCreationForm().

◆ MODE_EDIT

const ILIAS\File\Icon\IconFormUI::MODE_EDIT = 'edit'

Definition at line 34 of file IconFormUI.php.

Referenced by ILIAS\File\Icon\ilObjFileIconsOverviewGUI\openUpdatingForm(), and ILIAS\File\Icon\ilObjFileIconsOverviewGUI\update().

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

components/ILIAS/File/classes/Icons/IconFormUI.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getIconForm()

◆ initIconForm()

◆ transformCheckboxInputValueToBool()

Field Documentation

◆ $ctrl

◆ $icon_form

◆ $lng

◆ $refinery

◆ $tabs

◆ $ui_factory

◆ $wrapper

◆ FORM_ICON_CREATION

◆ FORM_ICON_UPDATING

◆ INPUT_ACTIVE

◆ INPUT_DESC_ACTIVE

◆ INPUT_DESC_ICON

◆ INPUT_DESC_SUFFIXES

◆ INPUT_ICON

◆ INPUT_SUFFIXES

◆ MODE_CREATE

◆ MODE_EDIT