Inheritance diagram for ilFooterGroupsGUI:

Collaboration diagram for ilFooterGroupsGUI:

Public Member Functions
	__construct (Pons $pons,)

	getTokensToKeep ()

	getCurrentItem ()

	create ()

	update ()

	executeCommand ()

Public Member Functions inherited from ILIAS\GlobalScreen\GUI\AbstractPonsGUI
	__construct (protected Pons $pons)

	__construct (Pons $pons)

	executeCommand ()

	getTokensToKeep ()

	getCurrentItem ()

Data Fields
const	CMD_TOGGLE_ACTIVATION = 'toggleActivation'

const	CMD_ADD = 'add'

const	CMD_CREATE = 'create'

const	CMD_EDIT = 'edit'

const	CMD_UPDATE = 'update'

const	CMD_RESET = 'reset'

const	CMD_SAVE_ORDER = 'saveOrder'

const	GSFO_ID = 'gsfo_group_id'

const	CMD_CONFIRM_RESET = 'confirmReset'

const	CMD_CONFIRM_DELETE = 'confirmDelete'

const	CMD_DELETE = 'delete'

Data Fields inherited from ILIAS\GlobalScreen\GUI\PonsGUI
const	CMD_DEFAULT = 'index'

Private Member Functions
	addButtons ()

	index ()

	confirmReset ()

	toggleActivation ()

	confirmDelete ()

	delete ()

	add ()

	edit ()

	reset ()

	saveOrder ()

Private Attributes
GroupsRepository	$repository

Factory	$ui_factory

ilCtrlInterface	$ctrl

ServerRequestInterface	$request

Container	$dic

TokenContainer	$group_token

Translator	$translator

Detailed Description

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

@ilCtrl_isCalledBy ilFooterGroupsGUI: ilObjFooterAdministrationGUI @ilCtrl_Calls ilFooterGroupsGUI: ilPermissionGUI @ilCtrl_Calls ilFooterGroupsGUI: ILIAS\GlobalScreen\GUI\I18n\MultiLanguageGUI

Definition at line 47 of file class.ilFooterGroupsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilFooterGroupsGUI::__construct ( Pons $pons )

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

Definition at line 112 of file class.ilFooterGroupsGUI.php.

      {
        parent::__construct($pons);
        global $DIC;
        $this->dic = $DIC;
        $this->translator = $pons->i18n();
        $this->ui_factory = $this->dic->ui()->factory();
        $this->repository = new GroupsRepositoryDB(
            $this->dic->database(),
            new ilFooterCustomGroupsProvider($this->dic)
        );
        $this->group_token = $this->pons->in()->buildToken('group', 'id');
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\GlobalScreen\GUI\Pons\i18n(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilFooterGroupsGUI::add ( )

private

Definition at line 346 of file class.ilFooterGroupsGUI.php.

                          : void
    {
        $form = new GroupForm(
            $this->repository,
            $this->translator
        );
 
        $action = (string) $this->pons->flow()->getHereAsURI(self::CMD_CREATE);
 
        $this->pons->out()->outAsyncAsModal(
            $this->translator->translate('group_add'),
            $action,
            $form->get($action)
        );
    }

References ILIAS\UI\examples\Deck\repository().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addButtons()

ilFooterGroupsGUI::addButtons ( )

private

Definition at line 141 of file class.ilFooterGroupsGUI.php.

                                 : array
    {
        $modal = $this->ui_factory
            ->modal()
            ->roundtrip(
                $this->translator->translate('group_add'),
                null
            )
            ->withAsyncRenderUrl(
                (string) $this->pons->flow()->getHereAsURI(self::CMD_ADD)
            );
 
        $confirm_reset = $this->ui_factory
            ->prompt()
            ->standard(
                $this->pons->flow()->getHereAsURI(self::CMD_CONFIRM_RESET),
            );
 
        $this->dic
            ->toolbar()
            ->addComponent(
                $this->ui_factory
                    ->button()
                    ->primary(
                        $this->translator->translate('group_add'),
                        '#'
                    )
                    ->withOnClick($modal->getShowSignal())
                    ->withHelpTopics(
                        ...$this->ui_factory->helpTopics('gsfo_button_add')
                    )
            );
        $this->dic
            ->toolbar()
            ->addComponent(
                $this->ui_factory
                    ->button()
                    ->standard(
                        $this->translator->translate('reset_footer'),
                        '#'
                    )
                    ->withOnClick($confirm_reset->getShowSignal())
                    ->withHelpTopics(
                        ...$this->ui_factory->helpTopics('gsfo_button_reset')
                    )
            );
 
        return [$modal, $confirm_reset];
    }

References ILIAS\Repository\button(), and ILIAS\UI\examples\MainControls\Slate\Notification\standard().

Referenced by index().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDelete()

ilFooterGroupsGUI::confirmDelete ( )

private

Definition at line 261 of file class.ilFooterGroupsGUI.php.

                                    : void
    {
        $items = [];
 
        $nok = $this->pons->out()->nok();
        $ok = $this->pons->out()->ok();
 
        $from_request = $this->pons->in()->getAllFromRequest($this->group_token);
 
        if (($from_request[0] ?? null) === Input::ALL_OBJECTS) {
            $from_request = array_map(
                fn(TranslatableItem $item): string => $item->getId(),
                iterator_to_array($this->repository->all())
            );
        }
 
        foreach ($from_request as $id) {
            $group = $this->repository->get($id);
            $id = $this->hash($id);
            if ($group === null) {
                continue;
            }
            if ($group->isCore()) {
                $items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
                    $id,
                    $group->getTitle(),
                    $this->translator->translate('info_not_deletable_core') .
                    $this->pons->out()->ui()->renderer()->render(
                        $nok
                    )
                );
                continue;
            }
            if ($group->getItems() > 0) {
                $items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
                    $id,
                    $group->getTitle(),
                    $this->translator->translate('info_not_deletable_not_empty') .
                    $this->pons->out()->ui()->renderer()->render($nok)
                );
                continue;
            }
 
            $items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
                $id,
                $group->getTitle(),
                $this->pons->out()->ui()->renderer()->render($ok)
            );
        }
 
        $this->pons->out()->outAsyncAsModal(
            $this->pons->i18n()->translate('group_delete'),
            (string) $this->pons->flow()->getHereAsURI(self::CMD_DELETE),
            ...$items
        );
    }

References $id, ILIAS\GlobalScreen\GUI\I18n\MultiLanguage\TranslatableItem\getId(), and ILIAS\UI\examples\Deck\repository().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmReset()

ilFooterGroupsGUI::confirmReset ( )

private

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

                                   : void
    {
        $this->pons->out()->outAsync(
            $this->ui_factory->prompt()->state()->show(
                $this->ui_factory->messageBox()->confirmation(
                    $this->translator->translate('confirm_reset')
                )->withButtons(
                    [
                        $this->ui_factory->button()->standard(
                            $this->translator->translate('reset'),
                            (string) $this->pons->flow()->getHereAsURI(self::CMD_RESET)
                        )
                    ]
                )
            )
        );
    }

Referenced by executeCommand().

Here is the caller graph for this function:

◆ create()

ilFooterGroupsGUI::create ( )

Definition at line 363 of file class.ilFooterGroupsGUI.php.

                            : void
    {
        $form = new GroupForm(
            $this->repository,
            $this->translator
        );
        $target = (string) $this->pons->flow()->getHereAsURI(self::CMD_CREATE);
        if ($form->store(
            $this->pons->in()->request(),
            $target
        )) {
            $this->pons->flow()->redirect(self::CMD_DEFAULT);
        }
        $this->pons->out()->out(
            $form->get(
                $target
            )
        );
    }

References ILIAS\UI\examples\Deck\repository().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilFooterGroupsGUI::delete ( )

private

Definition at line 319 of file class.ilFooterGroupsGUI.php.

                             : void
    {
        $from_request = $this->pons->in()->getAllFromRequest($this->group_token);
 
        if (($from_request[0] ?? null) === Input::ALL_OBJECTS) {
            $from_request = array_map(
                fn(TranslatableItem $item): string => $item->getId(),
                iterator_to_array($this->repository->all())
            );
        }
 
        foreach ($from_request as $id) {
            $group = $this->repository->get($id);
            if ($group === null) {
                continue;
            }
            if ($group->isCore()) {
                continue;
            }
            $this->repository->delete($group);
        }
 
        $this->pons->out()->success($this->translator->translate('group_deleted'));
        $this->pons->flow()->redirect(self::CMD_DEFAULT);
    }

References $id, ILIAS\GlobalScreen\GUI\I18n\MultiLanguage\TranslatableItem\getId(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

◆ edit()

ilFooterGroupsGUI::edit ( )

private

Definition at line 384 of file class.ilFooterGroupsGUI.php.

                           : void
    {
        $id = $this->pons->in()->getFirstFromRequest($this->group_token);
        $this->pons->in()->keepTokens($this);
 
        $group = $this->repository->get($id);
 
        $form = new GroupForm(
            $this->repository,
            $this->translator,
            $group
        );
 
        $target = (string) $this->pons->flow()->getHereAsURI(self::CMD_UPDATE);
        $this->pons->out()->outAsyncAsModal(
            $this->translator->translate('group_edit'),
            $target,
            $form->get($target)
        );
    }

References $id, and ILIAS\UI\examples\Deck\repository().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilFooterGroupsGUI::executeCommand ( )

Returns: bool true if you handled this command aka you were the CtrlClass, otherwise false

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

Definition at line 460 of file class.ilFooterGroupsGUI.php.

                                    : bool
    {
        if ($this->pons->handle(ilObjFooterAdministrationGUI::TAB_GROUPS)) {
            return true;
        }
        match ($this->pons->flow()->getCommand(self::CMD_DEFAULT)) {
            self::CMD_DEFAULT => $this->index(),
            self::CMD_ADD => $this->add(),
            self::CMD_CREATE => $this->create(),
            self::CMD_EDIT => $this->edit(),
            self::CMD_UPDATE => $this->update(),
            self::CMD_CONFIRM_RESET => $this->confirmReset(),
            self::CMD_CONFIRM_DELETE => $this->confirmDelete(),
            self::CMD_DELETE => $this->delete(),
            self::CMD_TOGGLE_ACTIVATION => $this->toggleActivation(),
            self::CMD_RESET => $this->reset(),
            self::CMD_SAVE_ORDER => $this->saveOrder(),
            default => $this->pons->out()->outString(
                'Unknown command: ' . $this->pons->flow()->getCommand(self::CMD_DEFAULT)
            ),
        };
        return true;
    }

References add(), confirmDelete(), confirmReset(), create(), edit(), index(), reset(), saveOrder(), ilObjFooterAdministrationGUI\TAB_GROUPS, toggleActivation(), and update().

Here is the call graph for this function:

◆ getCurrentItem()

ilFooterGroupsGUI::getCurrentItem ( )

Implements ILIAS\GlobalScreen\GUI\I18n\SupportsTranslationGUI.

Definition at line 134 of file class.ilFooterGroupsGUI.php.

                                    : TranslatableItem
    {
        return $this->repository->get(
            $this->pons->in()->getFirstFromRequest($this->group_token)
        );
    }

References ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

◆ getTokensToKeep()

ilFooterGroupsGUI::getTokensToKeep ( )

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

Definition at line 127 of file class.ilFooterGroupsGUI.php.

                                     : array
    {
        return [
            $this->group_token->token(),
        ];
    }

◆ index()

ilFooterGroupsGUI::index ( )

private

Definition at line 192 of file class.ilFooterGroupsGUI.php.

                            : void
    {
        // Add new
        $components = [];
        if ($this->pons->access()->hasUserPermissionTo('write')) {
            $components = $this->addButtons();
        }
        // Sync
        $this->repository->syncWithGlobalScreen(
            $this->dic->globalScreen()->collector()->footer()
        );
 
        // Table
        $table = new GroupsTable(
            $this->pons,
            $this->repository,
            $this->group_token
        );
 
        $this->pons->out()->out(
            $table->get(),
            ...$components
        );
    }

References $components, addButtons(), and ILIAS\UI\examples\Deck\repository().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

ilFooterGroupsGUI::reset ( )

private

Definition at line 433 of file class.ilFooterGroupsGUI.php.

                            : never
    {
        $this->repository->reset(
            $this->dic->globalScreen()->collector()->footer()
        );
        $entries_repo = new EntriesRepositoryDB($this->dic->database(), new ilFooterCustomGroupsProvider($this->dic));
        $entries_repo->reset($this->dic->globalScreen()->collector()->footer());
 
        $translations = new TranslationsRepositoryDB($this->dic->database());
        $translations->reset();
 
        $this->pons->out()->success($this->translator->translate('reset_success'));
        $this->pons->flow()->redirect(self::CMD_DEFAULT);
    }

References ILIAS\UI\examples\Deck\repository().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveOrder()

ilFooterGroupsGUI::saveOrder ( )

private

Definition at line 449 of file class.ilFooterGroupsGUI.php.

                                : void
    {
        foreach ($this->pons->in()->request()->getParsedBody() as $hashed_id => $position) {
            $item = $this->repository->get($this->unhash($hashed_id));
            $item = $item->withPosition((int) $position);
            $this->repository->store($item);
        }
        $this->pons->out()->success($this->pons->i18n()->translate('order_saved'));
        $this->pons->flow()->redirect(self::CMD_DEFAULT);
    }

References ILIAS\UI\examples\Deck\repository().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toggleActivation()

ilFooterGroupsGUI::toggleActivation ( )

private

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

                                       : void
    {
        $from_request = $this->pons->in()->getAllFromRequest($this->group_token);
 
        if (($from_request[0] ?? null) === Input::ALL_OBJECTS) {
            $from_request = array_map(
                fn(TranslatableItem $item): string => $item->getId(),
                iterator_to_array($this->repository->all())
            );
        }
 
        foreach ($from_request as $id) {
            $group = $this->repository->get($id);
            if ($group === null) {
                continue;
            }
            $this->repository->store($group->withActive(!$group->isActive()));
        }
 
        $this->pons->out()->success($this->translator->translate('group_activation_toggled'));
        $this->pons->flow()->redirect(self::CMD_DEFAULT);
    }

References $id, ILIAS\GlobalScreen\GUI\I18n\MultiLanguage\TranslatableItem\getId(), and ILIAS\UI\examples\Deck\repository().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilFooterGroupsGUI::update ( )

Definition at line 406 of file class.ilFooterGroupsGUI.php.

                            : void
    {
        $id = $this->pons->in()->getFirstFromRequest($this->group_token);
 
        $group = $this->repository->get($id);
 
        $form = new GroupForm(
            $this->repository,
            $this->translator,
            $group
        );
 
        $target = (string) $this->pons->flow()->getHereAsURI(self::CMD_EDIT);
        if ($form->store(
            $this->pons->in()->request(),
            $target
        )) {
            $this->pons->flow()->redirect(self::CMD_DEFAULT);
        }
        $this->pons->out()->out(
            $form->get(
                $target
            )
        );
    }