ilMMSubitemFormGUI Class Reference

Class ilMMSubitemFormGUI. More...

Collaboration diagram for ilMMSubitemFormGUI:

Public Member Functions
	__construct (protected ilCtrl $ctrl, protected ILIAS\UI\Factory $ui_fa, protected Renderer $ui_re, protected ilLanguage $lng, private ilMMItemFacadeInterface $item_facade, private ilMMItemRepository $repository)
	ilMMSubitemFormGUI constructor. More...
	save ()
	getHTML ()

Data Fields
const	F_TITLE = "title"
const	F_TYPE = "type"
const	F_PARENT = "parent"
const	F_ACTIVE = "active"
const	F_ICON = "icon"
const	F_ROLE_BASED_VISIBILITY = "role_based_visibility"

Private Member Functions
	initForm ()
	getTypeGroups (Closure $f)

Private Attributes
Standard	$form

Detailed Description

Class ilMMSubitemFormGUI.

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

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

Constructor & Destructor Documentation

__construct()

ilMMSubitemFormGUI::__construct	(	protected ilCtrl	$ctrl,
		protected ILIAS\UI\Factory	$ui_fa,
		protected Renderer	$ui_re,
		protected ilLanguage	$lng,
		private ilMMItemFacadeInterface	$item_facade,
		private ilMMItemRepository	$repository
	)

ilMMSubitemFormGUI constructor.

Parameters

ilCtrl	$ctrl
Factory	$ui_fa
Renderer	$ui_re
ilLanguage	$lng
ilMMItemFacadeInterface	$item_facade
ilMMItemRepository	$repository

Definition at line 55 of file class.ilMMSubitemFormGUI.php.

References ILIAS\Repository\ctrl(), ilMMAbstractItemGUI\IDENTIFIER, and initForm().

      {
        if (!$this->item_facade->isEmpty()) {
            $this->ctrl->saveParameterByClass(ilMMSubItemGUI::class, ilMMAbstractItemGUI::IDENTIFIER);
        }

        $this->initForm();
    }

Here is the call graph for this function:

Member Function Documentation

getHTML()

ilMMSubitemFormGUI::getHTML

(

)

Definition at line 209 of file class.ilMMSubitemFormGUI.php.

References ILIAS\Repository\form().

                             : string
    {
        return $this->ui_re->render([$this->form]);
    }

Here is the call graph for this function:

getTypeGroups()

ilMMSubitemFormGUI::getTypeGroups ( Closure  $f )

private

Parameters

Closure

$f

Returns

array

Definition at line 218 of file class.ilMMSubitemFormGUI.php.

References Vendor\Package\$f, ILIAS\UI\Implementation\Component\Input\$inputs, and ILIAS\UI\examples\Deck\repository().

Referenced by initForm().

                                              : array
    {
        $type_groups = [];
        $type_informations = $this->repository->getPossibleSubItemTypesWithInformation();
        foreach ($type_informations as $classname => $information) {
            if ($this->item_facade->isEmpty()
                || (!$this->item_facade->isEmpty() && $classname === $this->item_facade->getType() && $this->item_facade->isCustom())
            ) { // https://mantis.ilias.de/view.php?id=24152
                $inputs = $this->repository->getTypeHandlerForType($classname)->getAdditionalFieldsForSubForm($this->item_facade->identification());
                $type_groups[$this->hash($classname)] = $f()->field()->group($inputs, $information->getTypeNameForPresentation());
            }
        }

        return $type_groups;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilMMSubitemFormGUI::initForm ( )

private

Definition at line 70 of file class.ilMMSubitemFormGUI.php.

References Vendor\Package\$f, $id, $txt, ilMMSubItemGUI\CMD_ADD, ilMMSubItemGUI\CMD_CREATE, ilMMSubItemGUI\CMD_EDIT, ilMMSubItemGUI\CMD_UPDATE, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), getTypeGroups(), ILIAS\Repository\lng(), null, ILIAS\UI\examples\Deck\repository(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by __construct().

                               : void
    {
        // TITLE
        $txt = (fn($id): string => $this->lng->txt($id));
        $f = (fn(): InputFactory => $this->ui_fa->input());

        $title = $f()->field()->text($txt('sub_title_default'), $txt('sub_title_default_byline'));
        if (!$this->item_facade->isEmpty()) {
            $title = $title->withValue($this->item_facade->getDefaultTitle());
        }
        $items[self::F_TITLE] = $title;

        // TYPE
        if (($this->item_facade->isEmpty() || $this->item_facade->isCustom())) {
            $type_groups = $this->getTypeGroups($f);
            $type = $f()->field()->switchableGroup($type_groups, $txt('sub_type'), $txt('sub_type_byline'))->withRequired(true);
            if (!$this->item_facade->isEmpty()) {
                $string = $this->item_facade->getType() === '' ? Link::class : $this->item_facade->getType();
                $type = $type->withValue($this->hash($string));
            } else {
                $type = $type->withValue($this->hash(Link::class));
            }
            $items[self::F_TYPE] = $type;
        }

        // ICON
        if ($this->item_facade->supportsCustomIcon()) {
            // ICON
            $icon = $f()->field()->file(new ilMMUploadHandlerGUI(), $txt('sub_icon'))
                        ->withByline($txt('sub_icon_byline'))
                        ->withAcceptedMimeTypes([MimeType::IMAGE__SVG_XML]);
            if ($this->item_facade->getIconID() !== null) {
                $icon = $icon->withValue([$this->item_facade->getIconID()]);
            }

            $items[self::F_ICON] = $icon;
        }

        // PARENT
        $parent = $f()->field()->select($txt('sub_parent'), $this->repository->getPossibleParentsForFormAndTable())
                      ->withRequired(true);

        $possible_parents = array_keys($this->repository->getPossibleParentsForFormAndTable());

        if (!$this->item_facade->isEmpty() && !$this->item_facade->isInLostItem() && in_array($this->item_facade->getParentIdentificationString(), $possible_parents)) {
            $parent = $parent->withValue($this->item_facade->getParentIdentificationString());
        } else {
            $parent = $parent->withValue(reset($possible_parents));
        }
        $items[self::F_PARENT] = $parent;

        // ACTIVE
        $active = $f()->field()->checkbox($txt('sub_active'), $txt('sub_active_byline'));
        $active = $active->withValue($this->item_facade->isActivated());
        $items[self::F_ACTIVE] = $active;

        // ROLE BASED VISIBILITY
        if ($this->item_facade->supportsRoleBasedVisibility()) {
            $access = new ilObjMainMenuAccess();
            $value_role_based_visibility = null;
            if ($this->item_facade->hasRoleBasedVisibility() && !empty($this->item_facade->getGlobalRoleIDs())) {
                // remove deleted roles, see https://mantis.ilias.de/view.php?id=34936
                $value_role_based_visibility[0] = array_intersect(
                    $this->item_facade->getGlobalRoleIDs(),
                    array_keys($access->getGlobalRoles())
                );
            }
            $role_based_visibility = $f()->field()->optionalGroup(
                [
                    $f()->field()->multiSelect(
                        $txt('sub_global_roles'),
                        $access->getGlobalRoles()
                    )->withRequired(false)
                ],
                $txt('sub_role_based_visibility'),
                $txt('sub_role_based_visibility_byline')
            )->withValue($value_role_based_visibility);
            $items[self::F_ROLE_BASED_VISIBILITY] = $role_based_visibility;
        }

        // RETURN FORM
        if ($this->item_facade->isEmpty()) {
            $section = $f()->field()->section($items, $txt(ilMMSubItemGUI::CMD_ADD), "");
            $this->form = $f()->container()->form()
                              ->standard($this->ctrl->getLinkTargetByClass(ilMMSubItemGUI::class, ilMMSubItemGUI::CMD_CREATE), [$section]);
        } else {
            $section = $f()->field()->section($items, $txt(ilMMSubItemGUI::CMD_EDIT), "");
            $this->form = $f()->container()->form()
                              ->standard($this->ctrl->getLinkTargetByClass(ilMMSubItemGUI::class, ilMMSubItemGUI::CMD_UPDATE), [$section]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilMMSubitemFormGUI::save

(

)

Definition at line 162 of file class.ilMMSubitemFormGUI.php.

References $data, $DIC, $r, ILIAS\Repository\form(), and ILIAS\UI\examples\Deck\repository().

                          : bool
    {
        global $DIC;
        $r = new ilMMItemRepository();
        $this->form = $this->form->withRequest($DIC->http()->request());
        $data = $this->form->getData();

        if (is_null($data)) {
            return false;
        }

        $role_based_visibility = $data[0][self::F_ROLE_BASED_VISIBILITY] ?? false;
        $this->item_facade->setDefaultTitle((string) $data[0][self::F_TITLE]);
        $this->item_facade->setActiveStatus((bool) $data[0][self::F_ACTIVE]);
        $this->item_facade->setRoleBasedVisibility((bool) $role_based_visibility);

        if ($role_based_visibility) {
            $this->item_facade->setGlobalRoleIDs((array) $role_based_visibility[0]);
        }
        if ((string) $data[0][self::F_PARENT] !== '' && (string) $data[0][self::F_PARENT] !== '0') {
            $this->item_facade->setParent((string) $data[0][self::F_PARENT]);
        }
        $this->item_facade->setIsTopItm(false);

        if ($this->item_facade->isEmpty()) {
            $type = $this->unhash((string) ($data[0][self::F_TYPE][0]));
            $this->item_facade->setType($type);
            $r->createItem($this->item_facade);
        }

        if ($this->item_facade->supportsCustomIcon()) {
            $icon = (string) ($data[0][self::F_ICON][0] ?? '');
            $this->item_facade->setIconID($icon);
        }

        if ($this->item_facade->isCustom()) {
            $type = $this->item_facade->getType();
            $type_specific_data = (array) $data[0][self::F_TYPE][1];
            $type_handler = $this->repository->getTypeHandlerForType($type);
            $type_handler->saveFormFields($this->item_facade->identification(), $type_specific_data);
        }

        $r->updateItem($this->item_facade);

        return true;
    }

Here is the call graph for this function:

Field Documentation

$form

Standard ilMMSubitemFormGUI::$form

private

Definition at line 44 of file class.ilMMSubitemFormGUI.php.

F_ACTIVE

const ilMMSubitemFormGUI::F_ACTIVE = "active"

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

F_ICON

const ilMMSubitemFormGUI::F_ICON = "icon"

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

F_PARENT

const ilMMSubitemFormGUI::F_PARENT = "parent"

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

F_ROLE_BASED_VISIBILITY

const ilMMSubitemFormGUI::F_ROLE_BASED_VISIBILITY = "role_based_visibility"

Definition at line 42 of file class.ilMMSubitemFormGUI.php.

F_TITLE

const ilMMSubitemFormGUI::F_TITLE = "title"

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

F_TYPE

const ilMMSubitemFormGUI::F_TYPE = "type"

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

---

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

• components/ILIAS/MainMenu/classes/Administration/class.ilMMSubitemFormGUI.php