Collaboration diagram for ilFooterGroupsGUI:

Public Member Functions
	__construct (private Container $dic, private Translator $translator, private ilObjFooterUIHandling $ui_handling)

	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_group_id'

Protected Member Functions
	addButtons ()

	confirmReset ()

	index ()

	confirmDelete ()

	add ()

	edit ()

	toggleActivation ()

	reset ()

	editEntries ()

Private Member Functions
	delete ()

	saveOrder ()

Private Attributes
const	CMD_CONFIRM_RESET = 'confirmReset'

GroupsRepository	$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

ilFooterGroupsGUI: ilObjFooterAdministrationGUI ilFooterGroupsGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilFooterGroupsGUI::__construct	(	private Container	$dic,
		private Translator	$translator,
		private ilObjFooterUIHandling	$ui_handling
	)

Definition at line 59 of file class.ilFooterGroupsGUI.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 GroupsRepositoryDB(
             $this->dic->database(),
             new ilFooterCustomGroupsProvider($dic)
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilFooterGroupsGUI::add ( )

protected

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

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

                             : void
     {
         $form = new GroupForm(
             $this->repository,
             $this->translator
         );
 
         $action = $this->ctrl->getFormAction($this, self::CMD_CREATE);
 
         $this->ui_handling->outAsyncAsModal(
             $this->translator->translate('group_add'),
             $action,
             $form->get($action)
         );
     }

Here is the call graph for this function:

◆ addButtons()

ilFooterGroupsGUI::addButtons ( )

protected

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

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

Referenced by index().

                                    : array
     {
         $modal = $this->ui_factory->modal()->roundtrip(
             $this->translator->translate('group_add'),
             null
         )->withAsyncRenderUrl(
             $this->ctrl->getLinkTarget($this, self::CMD_ADD)
         );
 
         $confirm_reset = $this->ui_factory->prompt()->standard(
             $this->ui_handling->getHereAsURI(self::CMD_CONFIRM_RESET),
         );
 
         $this->dic->toolbar()->addComponent(
             $this->ui_factory
                 ->button()
                 ->primary(
                     $this->translator->translate('group_add'),
                     '#' //$this->ctrl->getLinkTarget($this, self::CMD_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'),
                     '#' //'$this->ctrl->getLinkTarget($this, self::CMD_RESET)
                 )
                 ->withOnClick($confirm_reset->getShowSignal())
                 ->withHelpTopics(...$this->ui_factory->helpTopics('gsfo_button_reset'))
         );
 
         return [$modal, $confirm_reset];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDelete()

ilFooterGroupsGUI::confirmDelete ( )

protected

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

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

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

Here is the call graph for this function:

◆ confirmReset()

ilFooterGroupsGUI::confirmReset ( )

protected

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

References ILIAS\Repository\ctrl().

                                      : void
     {
         $this->ui_handling->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'),
                             $this->ctrl->getLinkTarget($this, self::CMD_RESET)
                         )
                     ]
                 )
             )
         );
     }

Here is the call graph for this function:

◆ create()

ilFooterGroupsGUI::create ( )

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

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

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

ilFooterGroupsGUI::delete ( )

private

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

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

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

Here is the call graph for this function:

◆ edit()

ilFooterGroupsGUI::edit ( )

protected

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

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

                              : void
     {
         $id = $this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID)[0];
         $this->ui_handling->saveIdentificationsToRequest(
             $this,
             self::GSFO_ID,
             $id
         );
         $group = $this->repository->get($id);
 
         $form = new GroupForm(
             $this->repository,
             $this->translator,
             $group
         );
 
         $target = $this->ctrl->getFormAction($this, self::CMD_UPDATE);
         $this->ui_handling->outAsyncAsModal(
             $this->translator->translate('group_edit'),
             $target,
             $form->get($target)
         );
     }

Here is the call graph for this function:

◆ editEntries()

ilFooterGroupsGUI::editEntries ( )

protected

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

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

Referenced by executeCommand().

                                     : void
     {
         $id = $this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID)[0];
         $this->ui_handling->saveIdentificationsToRequest(
             ilFooterEntriesGUI::class,
             self::GSFO_ID,
             $id
         );
         $this->ctrl->redirectByClass(ilFooterEntriesGUI::class);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilFooterGroupsGUI::executeCommand ( )

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

References $id, ILIAS\Repository\ctrl(), editEntries(), 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;
             case strtolower(ilFooterEntriesGUI::class):
                 $id = $this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID)[0];
                 $this->ui_handling->saveIdentificationsToRequest(
                     ilFooterEntriesGUI::class,
                     self::GSFO_ID,
                     $id
                 );
                 $group = $this->repository->get($id);
 
                 $this->ctrl->forwardCommand(
                     new ilFooterEntriesGUI(
                         $this->dic,
                         $this->translator,
                         $this->ui_handling,
                         $group,
                         $this->repository
                     )
                 );
                 return;
             default:
                 switch ($cmd) {
                     case self::CMD_DEFAULT:
                         $this->ui_handling->requireReadable();
                         $this->index();
                         break;
                     case 'editEntries':
                         $this->ui_handling->requireReadable();
                         $this->editEntries();
                         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();
                         break;
                 }
         }
     }

Here is the call graph for this function:

◆ index()

ilFooterGroupsGUI::index ( )

protected

Definition at line 128 of file class.ilFooterGroupsGUI.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 GroupsTable(
             $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:

◆ reset()

ilFooterGroupsGUI::reset ( )

protected

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

References ILIAS\Repository\ctrl(), ILIAS\UI\examples\Deck\repository(), ILIAS\GlobalScreen\UI\Footer\Translation\TranslationsRepositoryDB\reset(), and ILIAS\GlobalScreen\UI\Footer\Entries\EntriesRepositoryDB\reset().

                               : void
     {
         $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->ui_handling->sendMessageAndRedirect(
             'success',
             $this->translator->translate('reset_success'),
             $this->ctrl->getLinkTarget($this, self::CMD_DEFAULT)
         );
     }

Here is the call graph for this function:

◆ saveOrder()

ilFooterGroupsGUI::saveOrder ( )

private

Definition at line 217 of file class.ilFooterGroupsGUI.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->ui_handling->sendMessageAndRedirect(
             'success',
             $this->translator->translate('order_saved'),
             $this->ctrl->getLinkTarget($this, self::CMD_DEFAULT)
         );
     }

Here is the call graph for this function:

◆ toggleActivation()

ilFooterGroupsGUI::toggleActivation ( )

protected

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

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

                                          : void
     {
         foreach ($this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID) as $id) {
             $group = $this->repository->get($id);
             $this->repository->store($group->withActive(!$group->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()

ilFooterGroupsGUI::update ( )

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

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

                             : void
     {
         $id = $this->ui_handling->getIdentificationsFromRequest(self::GSFO_ID)[0];
         $group = $this->repository->get($id);
 
         $form = new GroupForm(
             $this->repository,
             $this->translator,
             $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)
             )
         );
     }