Inheritance diagram for ilFooterEntriesGUI:

Collaboration diagram for ilFooterEntriesGUI:

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_DEFAULT = 'index'

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	CMD_CONFIRM_DELETE = 'confirmDelete'

const	CMD_DELETE = 'delete'

const	GSFO_ID = 'gsfo_entry_id'

const	CMD_TOGGLE_ACTIVATION = 'toggleActivation'

const string	CMD_SELECT_MOVE = 'selectMove'

const string	CMD_MOVE = 'move'

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

Private Member Functions
	index ()

	add ()

	addButtons ()

	saveCurrentEntry ()

	edit ()

	toggleActivation ()

	confirmDelete ()

	delete ()

	saveOrder ()

	buildTargetSelectorForm (URI $post_url)

	selectMove ()

Private Attributes
EntriesRepository	$repository

Factory	$ui_factory

ilCtrlInterface	$ctrl

ServerRequestInterface	$request

Translator	$translator

Container	$dic

TokenContainer	$group_token

TokenContainer	$entry_token

Group	$group

GroupsRepositoryDB	$groups_repository

Detailed Description

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

@ilCtrl_isCalledBy ilFooterEntriesGUI: ilFooterGroupsGUI @ilCtrl_Calls ilFooterEntriesGUI: ILIAS\GlobalScreen\GUI\I18n\MultiLanguageGUI

Definition at line 49 of file class.ilFooterEntriesGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilFooterEntriesGUI::__construct ( Pons $pons )

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

Definition at line 111 of file class.ilFooterEntriesGUI.php.

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

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()

ilFooterEntriesGUI::add ( )

private

Definition at line 179 of file class.ilFooterEntriesGUI.php.

                          : void
    {
        $form = new EntryForm(
            $this->repository,
            $this->translator,
            $this->group
        );
 
        $target = $this->pons->flow()->getHereAsURI(self::CMD_CREATE);
        $this->pons->out()->outAsyncAsModal(
            $this->translator->translate('add', 'entries'),
            $target,
            $form->get((string) $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:

◆ addButtons()

ilFooterEntriesGUI::addButtons ( )

private

Definition at line 195 of file class.ilFooterEntriesGUI.php.

                                 : array
    {
        $modal = $this->ui_factory->modal()->roundtrip(
            $this->translator->translate('add', 'entries'),
            null
        )->withAsyncRenderUrl(
            (string) $this->pons->flow()->getHereAsURI(self::CMD_ADD)
        );
 
        $this->dic->toolbar()->addComponent(
            $this->ui_factory
                ->button()
                ->primary(
                    $this->translator->translate('add', 'entries'),
                    '#'
                )
                ->withOnClick($modal->getShowSignal())
        );
 
        return [$modal];
    }

References ILIAS\Repository\button().

Referenced by index().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTargetSelectorForm()

ilFooterEntriesGUI::buildTargetSelectorForm ( URI $post_url )

private

Definition at line 404 of file class.ilFooterEntriesGUI.php.

                                                           : Standard
    {
        // determine parent group
        $all_groups = $this->groups_repository->all();
 
        $selection = [];
        foreach ($all_groups as $group) {
            if ($this->group !== null && $group->getId() === $this->group->getId()) {
                continue;
            }
            $selection[$this->hash($group->getId())] = $group->getTitle();
        }
 
        return $this->pons->out()->ui()->factory()->input()->container()->form()->standard(
            (string) $post_url,
            [
                $this->pons->out()->ui()->factory()->input()->field()->select(
                    $this->pons->i18n()->t('target_group', 'entries'),
                    $selection
                )->withRequired(true)
            ]
        );
    }

References $group, ILIAS\GlobalScreen\UI\Footer\Groups\Group\getId(), and ILIAS\GlobalScreen\UI\Footer\Groups\Group\getTitle().

Here is the call graph for this function:

◆ confirmDelete()

ilFooterEntriesGUI::confirmDelete ( )

private

Definition at line 317 of file class.ilFooterEntriesGUI.php.

                                    : void
    {
        $items = [];
 
        $from_request = $this->pons->in()->getAllFromRequest($this->entry_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) {
            $entry = $this->repository->get($id);
            if ($entry === null) {
                continue;
            }
            if ($entry->isCore()) {
                $items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
                    $id,
                    $entry->getTitle(),
                    $this->translator->translate('info_not_deletable_core') .
                    $this->pons->out()->render($this->pons->out()->nok())
                );
                continue;
            }
            $items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
                $this->hash($entry->getId()),
                $entry->getTitle(),
                $this->pons->out()->render($this->pons->out()->ok())
            );
        }
 
        $this->pons->out()->outAsyncAsModal(
            $this->translator->translate('entry_delete'),
            $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:

◆ create()

ilFooterEntriesGUI::create ( )

Definition at line 226 of file class.ilFooterEntriesGUI.php.

                            : void
    {
        $form = new EntryForm(
            $this->repository,
            $this->translator,
            $this->group
        );
        $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()

ilFooterEntriesGUI::delete ( )

private

Definition at line 359 of file class.ilFooterEntriesGUI.php.

                             : void
    {
        $from_request = $this->pons->in()->getAllFromRequest($this->entry_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())
            );
        }
 
        $successful_deletions = 0;
        foreach ($from_request as $id) {
            $item = $this->repository->get($id);
            if ($item === null) {
                continue;
            }
            if ($item->isCore()) {
                continue;
            }
            $this->repository->delete($item);
            $successful_deletions++;
        }
 
        if ($successful_deletions === 0) {
            $this->pons->out()->error($this->translator->translate('entry_deleted_failed'), true);
            $this->pons->flow()->redirect(self::CMD_DEFAULT);
            return;
        }
        $this->pons->out()->success($this->translator->translate('entry_deleted'), true);
        $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()

ilFooterEntriesGUI::edit ( )

private

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

                           : void
    {
        $id = $this->saveCurrentEntry();
        $entry = $this->repository->get($id);
 
        $form = new EntryForm(
            $this->repository,
            $this->translator,
            $this->group,
            $entry
        );
 
        $target = (string) $this->pons->flow()->getHereAsURI(self::CMD_UPDATE);
        $this->pons->out()->outAsyncAsModal(
            $this->translator->translate('edit', 'entries'),
            $target,
            $form->get($target)
        );
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilFooterEntriesGUI::executeCommand ( )

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

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

Definition at line 471 of file class.ilFooterEntriesGUI.php.

                                    : bool
    {
        if ($this->pons->handle(ilObjFooterAdministrationGUI::TAB_SUB_ITEMS)) {
            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_DELETE => $this->confirmDelete(),
            self::CMD_DELETE => $this->delete(),
            self::CMD_TOGGLE_ACTIVATION => $this->toggleActivation(),
            self::CMD_SAVE_ORDER => $this->saveOrder(),
            self::CMD_SELECT_MOVE => $this->selectMove(),
            self::CMD_MOVE => $this->move(),
            default => $this->pons->out()->outString(
                'Unknown command: ' . $this->pons->flow()->getCommand(self::CMD_DEFAULT)
            ),
        };
        return true;
    }

References add(), confirmDelete(), create(), edit(), index(), saveOrder(), selectMove(), ilObjFooterAdministrationGUI\TAB_SUB_ITEMS, toggleActivation(), and update().

Here is the call graph for this function:

◆ getCurrentItem()

ilFooterEntriesGUI::getCurrentItem ( )

Implements ILIAS\GlobalScreen\GUI\I18n\SupportsTranslationGUI.

Definition at line 145 of file class.ilFooterEntriesGUI.php.

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

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

Here is the call graph for this function:

◆ getTokensToKeep()

ilFooterEntriesGUI::getTokensToKeep ( )

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

Definition at line 137 of file class.ilFooterEntriesGUI.php.

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

◆ index()

ilFooterEntriesGUI::index ( )

private

Definition at line 153 of file class.ilFooterEntriesGUI.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 EntriesTable(
            $this->pons,
            $this->group,
            $this->repository,
            $this->entry_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:

◆ saveCurrentEntry()

ilFooterEntriesGUI::saveCurrentEntry ( )

private

Definition at line 217 of file class.ilFooterEntriesGUI.php.

                                       : mixed
    {
        $id = $this->pons->in()->getFirstFromRequest($this->entry_token);
        $this->pons->in()->keep($this->entry_token);
 
        return $id;
    }

References $id.

Referenced by edit().

Here is the caller graph for this function:

◆ saveOrder()

ilFooterEntriesGUI::saveOrder ( )

private

Definition at line 393 of file class.ilFooterEntriesGUI.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:

◆ selectMove()

ilFooterEntriesGUI::selectMove ( )

private

Definition at line 429 of file class.ilFooterEntriesGUI.php.

                                 : void
    {
        $this->pons->in()->keepTokens($this);
 
        $post_url = $this->pons->flow()->getHereAsURI(self::CMD_MOVE);
        $this->pons->out()->outAsyncAsModal(
            $this->pons->i18n()->t(self::CMD_MOVE),
            $post_url,
            $this->buildTargetSelectorForm($post_url)
        );
    }

Referenced by executeCommand().

Here is the caller graph for this function:

◆ toggleActivation()

ilFooterEntriesGUI::toggleActivation ( )

private

Definition at line 293 of file class.ilFooterEntriesGUI.php.

                                       : void
    {
        $from_request = $this->pons->in()->getAllFromRequest($this->entry_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) {
            $entry = $this->repository->get($id);
            if ($entry === null) {
                continue;
            }
            $this->repository->store($entry->withActive(!$entry->isActive()));
        }
 
        $this->pons->out()->success($this->translator->translate('group_activation_toggled'), true);
        $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()

ilFooterEntriesGUI::update ( )

Definition at line 269 of file class.ilFooterEntriesGUI.php.

                            : void
    {
        $id = $this->pons->in()->getFirstFromRequest($this->entry_token);
        $entry = $this->repository->get($id);
 
        $form = new EntryForm(
            $this->repository,
            $this->translator,
            $this->group,
            $entry
        );
        $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)
        );
    }