Collaboration diagram for ilFooterEntriesGUI:

Public Member Functions
	__construct (private Container $dic, private Translator $translator, private ilObjFooterUIHandling $ui_handling, private Group $group, private GroupsRepository $groups_repository)

	create ()

	update ()

	executeCommand ()

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	GSFO_ID = 'gsfo_entry_id'

Protected Member Functions
	index ()

	add ()

	addButtons ()

	saveCurrentEntry ()

	edit ()

	toggleActivation ()

	reset ()

	confirmDelete ()

	selectMove ()

	getMoveForm ()

	move ()

Private Member Functions
	saveOrder ()

	delete ()

Private Attributes
EntriesRepository	$repository

Factory	$ui_factory

ilCtrlInterface	$ctrl

ServerRequestInterface	$request

Detailed Description

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

ilFooterEntriesGUI: ilFooterGroupsGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilFooterEntriesGUI::__construct	(	private Container	$dic,
		private Translator	$translator,
		private ilObjFooterUIHandling	$ui_handling,
		private Group	$group,
		private GroupsRepository	$groups_repository
	)

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

References ILIAS\Repository\ctrl(), and ILIAS\UI\examples\Deck\repository().

       {
         $this->ui_factory = $this->dic->ui()->factory();
         $this->ctrl = $this->dic->ctrl();
         $this->request = $this->dic->http()->request();
         $this->repository = new EntriesRepositoryDB(
             $this->dic->database(),
             new ilFooterCustomGroupsProvider($dic)
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilFooterEntriesGUI::add ( )

protected

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

References ILIAS\Repository\ctrl(), and ILIAS\UI\examples\Deck\repository().

                             : void
     {
         $form = new EntryForm(
             $this->repository,
             $this->translator,
             $this->group
         );
 
         $target = $this->ctrl->getFormAction($this, self::CMD_CREATE);
         $this->ui_handling->outAsyncAsModal(
             $this->translator->translate('add', 'entries'),
             $target,
             $form->get($target)
         );
     }

Here is the call graph for this function:

◆ addButtons()

ilFooterEntriesGUI::addButtons ( )

protected

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

References ILIAS\Repository\button(), and ILIAS\Repository\ctrl().

Referenced by index().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDelete()

ilFooterEntriesGUI::confirmDelete ( )

protected

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

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

                                       : void
     {
         $items = [];
 
         foreach ($this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID) 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->ui_handling->render($this->nok($this->ui_factory))
                 );
                 continue;
             }
             $items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
                 $id,
                 $entry->getTitle(),
                 $this->ui_handling->render($this->ok($this->ui_factory))
             );
         }
 
         $this->ui_handling->outAsyncAsModal(
             $this->translator->translate('entry_delete'),
             $this->ctrl->getFormAction($this, 'delete'),
             ...$items
         );
     }

Here is the call graph for this function:

◆ create()

ilFooterEntriesGUI::create ( )

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

References ILIAS\Repository\ctrl(), and ILIAS\UI\examples\Deck\repository().

                             : void
     {
         $form = new EntryForm(
             $this->repository,
             $this->translator,
             $this->group
         );
         if ($form->store(
             $this->request,
             $this->ctrl->getFormAction($this, self::CMD_CREATE)
         )) {
             $this->ctrl->redirect($this, self::CMD_DEFAULT);
         }
         $this->ui_handling->out(
             $form->get(
                 $this->ctrl->getFormAction($this, self::CMD_CREATE)
             )
         );
     }

Here is the call graph for this function:

◆ delete()

ilFooterEntriesGUI::delete ( )

private

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

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

                              : void
     {
         foreach ($this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID) as $id) {
             $item = $this->repository->get($id);
             $this->repository->delete($item);
         }
 
         $this->ui_handling->sendMessageAndRedirect(
             'success',
             $this->translator->translate('entry_deleted'),
             $this->ctrl->getLinkTarget($this, self::CMD_DEFAULT)
         );
     }

Here is the call graph for this function:

◆ edit()

ilFooterEntriesGUI::edit ( )

protected

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

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

                              : void
     {
         $id = $this->saveCurrentEntry();
         $entry = $this->repository->get($id);
 
         $form = new EntryForm(
             $this->repository,
             $this->translator,
             $this->group,
             $entry
         );
 
         $target = $this->ctrl->getFormAction($this, self::CMD_UPDATE);
         $this->ui_handling->outAsyncAsModal(
             $this->translator->translate('edit', 'entries'),
             $target,
             $form->get($target)
         );
     }

Here is the call graph for this function:

◆ executeCommand()

ilFooterEntriesGUI::executeCommand ( )

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

References ILIAS\Repository\ctrl(), index(), and ILIAS\UI\examples\Deck\repository().

                                     : void
     {
         $this->ui_handling->requireReadable();
 
         $next_class = $this->ctrl->getNextClass($this) ?? '';
         $cmd = $this->ctrl->getCmd(self::CMD_DEFAULT);
 
         switch (strtolower($next_class)) {
             case strtolower(ilFooterTranslationGUI::class):
                 $item = $this->repository->get(
                     $this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID)[0]
                 );
                 $back_target = null;
                 if ($this->request->getQueryParams()['async'] ?? false) {
                     $back_target = $this->ui_handling->buildURI($this->ctrl->getLinkTarget($this, self::CMD_DEFAULT));
                 }
                 $translation = new ilFooterTranslationGUI(
                     $this->dic,
                     $this->translator,
                     $this->ui_handling,
                     $item,
                     $back_target
                 );
 
                 $this->ctrl->forwardCommand($translation);
 
                 return;
             default:
                 switch ($cmd) {
                     case self::CMD_DEFAULT:
                         $this->ui_handling->requireReadable();
                         $this->index();
                         break;
                     case self::CMD_ADD:
                     case self::CMD_CREATE:
                     case self::CMD_EDIT:
                     case self::CMD_UPDATE:
                     default:
                         $this->ui_handling->backToMainTab();
                         $this->ui_handling->requireWritable();
                         $this->$cmd();
                 }
         }
     }

Here is the call graph for this function:

◆ getMoveForm()

ilFooterEntriesGUI::getMoveForm ( )

protected

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

References ILIAS\Repository\ctrl().

Referenced by move(), and selectMove().

                                     : Standard
     {
         $parents = [];
 
         foreach ($this->groups_repository->all() as $group) {
             $parents[$group->getId()] = $group->getTitle();
         }
 
         $factory = $this->ui_factory->input();
         return $factory
             ->container()
             ->form()
             ->standard(
                 $this->ctrl->getFormAction($this, 'move'),
                 [
                     'parent' => $factory
                         ->field()
                         ->select(
                             $this->translator->translate('parent', 'entries'),
                             $parents
                         )
                         ->withRequired(true)
                         ->withValue($this->group->getId())
                 ]
             );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

ilFooterEntriesGUI::index ( )

protected

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

References $components, addButtons(), ilFooterTranslationGUI\CMD_DEFAULT, ILIAS\Repository\ctrl(), and ILIAS\UI\examples\Deck\repository().

Referenced by executeCommand().

                               : void
     {
         // Add new
         $components = [];
         if ($this->ui_handling->hasPermission('write')) {
             $components = $this->addButtons();
         }
         // Sync
         $this->repository->syncWithGlobalScreen(
             $this->dic->globalScreen()->collector()->footer()
         );
         // Table
         $table = new EntriesTable(
             $this->group,
             $this->repository,
             new TranslationsRepositoryDB($this->dic->database()),
             $this->translator,
             $this->ui_handling->hasPermission('write')
         );
 
         $this->ui_handling->out(
             $table->get(
                 $this->ui_handling->getHereAsURI(self::CMD_SAVE_ORDER),
                 $this->ui_handling->buildURI(
                     $this->ctrl->getLinkTargetByClass(
                         ilFooterTranslationGUI::class,
                         ilFooterTranslationGUI::CMD_DEFAULT
                     )
                 )
             ),
             ...$components
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ move()

ilFooterEntriesGUI::move ( )

protected

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

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

                              : void
     {
         $new_parent = $this->getMoveForm()->withRequest($this->request)->getData()['parent'] ?? null;
         $id = $this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID)[0];
         $entry = $this->repository->get($id);
         $entry = $entry->withParent($new_parent);
         $this->repository->store($entry);
         $this->ui_handling->sendMessageAndRedirect(
             'success',
             $this->translator->translate('entry_moved'),
             $this->ctrl->getLinkTarget($this, self::CMD_DEFAULT)
         );
     }

Here is the call graph for this function:

◆ reset()

ilFooterEntriesGUI::reset ( )

protected

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

References ILIAS\Repository\ctrl(), and ILIAS\UI\examples\Deck\repository().

                               : void
     {
         $this->repository->reset(
             $this->dic->globalScreen()->collector()->footer()
         );
         $this->ui_handling->sendMessageAndRedirect(
             'success',
             $this->translator->translate('reset_success'),
             $this->ctrl->getLinkTarget($this, self::CMD_DEFAULT)
         );
     }

Here is the call graph for this function:

◆ saveCurrentEntry()

ilFooterEntriesGUI::saveCurrentEntry ( )

protected

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

References $id.

Referenced by edit(), and selectMove().

                                          : mixed
     {
         $id = $this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID)[0];
         $this->ui_handling->saveIdentificationsToRequest(
             $this,
             self::GSFO_ID,
             $id
         );
         return $id;
     }

Here is the caller graph for this function:

◆ saveOrder()

ilFooterEntriesGUI::saveOrder ( )

private

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

References ILIAS\Repository\ctrl(), and ILIAS\UI\examples\Deck\repository().

                                 : void
     {
         foreach ($this->request->getParsedBody() as $hashed_id => $position) {
             $this->repository->updatePositionById($this->unhash($hashed_id), (int) $position);
         }
         $this->ctrl->redirect($this, self::CMD_DEFAULT);
     }

Here is the call graph for this function:

◆ selectMove()

ilFooterEntriesGUI::selectMove ( )

protected

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

References $id, ILIAS\Repository\ctrl(), getMoveForm(), and saveCurrentEntry().

                                    : void
     {
         $id = $this->saveCurrentEntry();
         $form = $this->getMoveForm();
 
         $this->ui_handling->outAsyncAsModal(
             $this->translator->translate('select_parent', 'entries'),
             $this->ctrl->getFormAction($this, 'move'),
             $form
         );
     }

Here is the call graph for this function:

◆ toggleActivation()

ilFooterEntriesGUI::toggleActivation ( )

protected

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

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

                                          : void
     {
         foreach ($this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID) as $id) {
             $entry = $this->repository->get($id);
             $this->repository->store($entry->withActive(!$entry->isActive()));
         }
 
         $this->ui_handling->sendMessageAndRedirect(
             'success',
             $this->translator->translate('group_activation_toggled'),
             $this->ctrl->getLinkTarget($this, self::CMD_DEFAULT)
         );
     }

Here is the call graph for this function:

◆ update()

ilFooterEntriesGUI::update ( )

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

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

                             : void
     {
         $id = $this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID)[0];
         $entry = $this->repository->get($id);
 
         $form = new EntryForm(
             $this->repository,
             $this->translator,
             $this->group,
             $entry
         );
         $target = $this->ctrl->getFormAction($this, self::CMD_CREATE);
         if ($form->store(
             $this->request,
             $target
         )) {
             $this->ctrl->redirect($this, self::CMD_DEFAULT);
         }
         $this->ui_handling->out(
             $form->get($target)
         );
     }