Class ilMMTopItemGUI ilMMTopItemGUI: ilObjMainMenuGUI ilMMTopItemGUI: ilMMItemTranslationGUI. More...

Inheritance diagram for ilMMTopItemGUI:

Collaboration diagram for ilMMTopItemGUI:

Public Member Functions
	executeCommand ()

Public Member Functions inherited from ilMMAbstractItemGUI
	__construct (protected ilMMTabHandling $tab_handling)
	ilMMAbstractItemGUI constructor. More...

Data Fields
const	CMD_VIEW_TOP_ITEMS = 'subtab_topitems'

const	CMD_ADD = 'topitem_add'

const	CMD_RESTORE = 'restore'

const	CMD_CREATE = 'topitem_create'

const	CMD_EDIT = 'topitem_edit'

const	CMD_DELETE = 'delete'

const	CMD_CONFIRM_DELETE = 'topitem_confirm_delete'

const	CMD_TRANSLATE = 'topitem_translate'

const	CMD_UPDATE = 'topitem_update'

const	CMD_SAVE_TABLE = 'save_table'

const	CMD_CANCEL = 'cancel'

const	CMD_RENDER_INTERRUPTIVE = 'render_interruptive_modal'

const	CMD_UPLOAD = 'upload'

const	CMD_SELECT_PARENT = 'selectParent'

const	CMD_MOVE = 'move'

Data Fields inherited from ilMMAbstractItemGUI
const	IDENTIFIER = 'identifier'

const	CMD_FLUSH = 'flush'

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilTree	$tree

Protected Member Functions
	cancel ()

Protected Member Functions inherited from ilMMAbstractItemGUI
	determineCommand (string $standard, string $delete)

	getMMItemFromRequest ()

	flush ()

	cancel ()

Private Member Functions
	dispatchCommand (string $cmd)

	saveTable ()

	index ()

	doubleCancel ()

	add (Container $DIC)

	create (Container $DIC)

	edit (Container $DIC)

	update (Container $DIC)

	delete ()

	restore ()

	selectParent ()

	move ()

	getMoveForm ()

Additional Inherited Members
Protected Attributes inherited from ilMMAbstractItemGUI
UIServices	$ui

Services	$http

ilMMItemRepository	$repository

ilToolbarGUI	$toolbar

ilTabsGUI	$tabs

ilCtrl	$ctrl

ilObjMainMenuAccess	$access

Detailed Description

Class ilMMTopItemGUI ilMMTopItemGUI: ilObjMainMenuGUI ilMMTopItemGUI: ilMMItemTranslationGUI.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 31 of file class.ilMMTopItemGUI.php.

Member Function Documentation

◆ add()

ilMMTopItemGUI::add ( Container $DIC )

private

Parameters

$DIC

Returns: string

Exceptions

Throwable

Definition at line 212 of file class.ilMMTopItemGUI.php.

References Vendor\Package\$f, ilMMAbstractItemGUI\$lng, ilMMAbstractItemGUI\$repository, ILIAS\DI\Container\ctrl(), ILIAS\DI\Container\http(), ILIAS\UI\examples\Deck\repository(), and ILIAS\DI\Container\ui().

Referenced by dispatchCommand().

                                         : string
     {
         $f = new ilMMTopItemFormGUI($DIC->ctrl(), $DIC->ui()->factory(), $DIC->ui()->renderer(), $this->lng, $DIC->http(), $this->repository->getItemFacade(), $this->repository);
 
         return $f->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancel()

ilMMTopItemGUI::cancel ( )

protected

Definition at line 197 of file class.ilMMTopItemGUI.php.

References ILIAS\Repository\ctrl().

Referenced by create(), delete(), dispatchCommand(), move(), restore(), saveTable(), and update().

                                : void
     {
         $this->ctrl->redirectByClass(self::class, self::CMD_VIEW_TOP_ITEMS);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilMMTopItemGUI::create ( Container $DIC )

private

Parameters

Container $DIC

Returns: string

Exceptions

Throwable

Definition at line 224 of file class.ilMMTopItemGUI.php.

References Vendor\Package\$f, ilMMAbstractItemGUI\$lng, ilMMAbstractItemGUI\$repository, cancel(), ILIAS\DI\Container\ctrl(), ILIAS\DI\Container\http(), ILIAS\UI\examples\Deck\repository(), and ILIAS\DI\Container\ui().

Referenced by dispatchCommand().

                                            : string
     {
         $f = new ilMMTopItemFormGUI($DIC->ctrl(), $DIC->ui()->factory(), $DIC->ui()->renderer(), $this->lng, $DIC->http(), $this->repository->getItemFacade(), $this->repository);
         if ($f->save()) {
             $this->cancel();
         }
 
         return $f->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilMMTopItemGUI::delete ( )

private

Definition at line 266 of file class.ilMMTopItemGUI.php.

References cancel(), ilMMAbstractItemGUI\getMMItemFromRequest(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

                              : void
     {
         $item = $this->getMMItemFromRequest();
         if ($item->isDeletable()) {
             $this->repository->deleteItem($item);
         }
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_topitem_deleted"), true);
         $this->cancel();
     }

Here is the call graph for this function:

◆ dispatchCommand()

ilMMTopItemGUI::dispatchCommand ( string $cmd )

private

Definition at line 51 of file class.ilMMTopItemGUI.php.

References $DIC, ILIAS\Repository\access(), add(), cancel(), create(), edit(), ilMMAbstractItemGUI\flush(), index(), move(), restore(), saveTable(), selectParent(), ilObjMainMenuGUI\TAB_MAIN, and update().

Referenced by executeCommand().

                                                  : string
     {
         global $DIC;
         switch ($cmd) {
             case self::CMD_VIEW_TOP_ITEMS:
                 $this->access->checkAccessAndThrowException("visible,read");
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, $cmd);
 
                 return $this->index();
             case self::CMD_ADD:
                 $this->access->checkAccessAndThrowException('write');
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, self::CMD_VIEW_TOP_ITEMS, true, self::class);
 
                 return $this->add($DIC);
             case self::CMD_CREATE:
                 $this->access->checkAccessAndThrowException('write');
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, self::CMD_VIEW_TOP_ITEMS, true, self::class);
 
                 return $this->create($DIC);
             case self::CMD_EDIT:
                 $this->access->checkAccessAndThrowException('write');
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, self::CMD_VIEW_TOP_ITEMS, true, self::class);
 
                 return $this->edit($DIC);
             case self::CMD_UPDATE:
                 $this->access->checkAccessAndThrowException('write');
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, self::CMD_VIEW_TOP_ITEMS, true, self::class);
 
                 return $this->update($DIC);
             case self::CMD_SAVE_TABLE:
                 $this->access->checkAccessAndThrowException('write');
                 $this->saveTable();
 
                 break;
             case self::CMD_DELETE:
                 $this->access->checkAccessAndThrowException('write');
                 $this->delete();
                 break;
             case self::CMD_CANCEL:
                 $this->cancel();
                 break;
             case self::CMD_RESTORE:
                 $this->access->checkAccessAndThrowException('write');
 
                 $this->restore();
                 break;
             case self::CMD_SELECT_PARENT:
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, self::CMD_VIEW_TOP_ITEMS, true, self::class);
                 $this->access->checkAccessAndThrowException('write');
                 return $this->selectParent();
             case self::CMD_FLUSH:
                 $this->access->checkAccessAndThrowException('write');
                 $this->flush();
                 break;
             case self::CMD_UPLOAD:
                 $this->access->checkAccessAndThrowException('write');
                 return $this->selectParent();
             case self::CMD_MOVE:
                 $this->access->checkAccessAndThrowException('write');
                 $this->move();
                 break;
         }
 
         return "";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doubleCancel()

ilMMTopItemGUI::doubleCancel ( )

private

Definition at line 202 of file class.ilMMTopItemGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
     {
         $this->ctrl->redirectByClass(self::class, self::CMD_CANCEL);
     }

Here is the call graph for this function:

◆ edit()

ilMMTopItemGUI::edit ( Container $DIC )

private

Parameters

$DIC

Returns: string

Exceptions

Throwable

Definition at line 239 of file class.ilMMTopItemGUI.php.

References Vendor\Package\$f, ilMMAbstractItemGUI\$lng, ilMMAbstractItemGUI\$repository, ILIAS\DI\Container\ctrl(), ilMMAbstractItemGUI\getMMItemFromRequest(), ILIAS\DI\Container\http(), and ILIAS\DI\Container\ui().

Referenced by dispatchCommand().

                                          : string
     {
         $f = new ilMMTopItemFormGUI($DIC->ctrl(), $DIC->ui()->factory(), $DIC->ui()->renderer(), $this->lng, $DIC->http(), $this->getMMItemFromRequest(), $this->repository);
 
         return $f->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilMMTopItemGUI::executeCommand ( )

Definition at line 130 of file class.ilMMTopItemGUI.php.

References ILIAS\Repository\ctrl(), ilMMAbstractItemGUI\determineCommand(), dispatchCommand(), ilMMAbstractItemGUI\getMMItemFromRequest(), ILIAS\UI\examples\Deck\repository(), and ilObjMainMenuGUI\TAB_MAIN.

                                     : void
     {
         $next_class = $this->ctrl->getNextClass();
 
         if ($next_class === '') {
             $cmd = $this->determineCommand(self::CMD_VIEW_TOP_ITEMS, self::CMD_DELETE);
             $this->tpl->setContent($this->dispatchCommand($cmd));
 
             return;
         }
 
         switch ($next_class) {
             case strtolower(ilMMItemTranslationGUI::class):
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, self::CMD_VIEW_TOP_ITEMS, true);
                 $g = new ilMMItemTranslationGUI($this->getMMItemFromRequest(), $this->repository);
                 $this->ctrl->forwardCommand($g);
                 break;
             default:
                 break;
         }
     }

Here is the call graph for this function:

◆ getMoveForm()

ilMMTopItemGUI::getMoveForm ( )

private

Returns: Standard

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

References Vendor\Package\$f, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), and ILIAS\Repository\ui().

Referenced by move(), and selectParent().

                                   : Standard
     {
         $this->ctrl->saveParameter($this, self::IDENTIFIER);
         $f = $this->ui->factory();
 
         $parent = $f->input()->field()->select($this->lng->txt('select_parent'), $this->repository->getPossibleParentsForFormAndTable())->withRequired(true);
 
         return $f->input()->container()->form()->standard($this->ctrl->getFormAction($this, self::CMD_MOVE), [$parent]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

ilMMTopItemGUI::index ( )

private

Returns: string

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

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

Referenced by dispatchCommand().

                             : string
     {
         if ($this->access->hasUserPermissionTo('write')) {
             // ADD NEW
             $btn_add = $this->ui->factory()->button()->standard(
                 $this->lng->txt(self::CMD_ADD),
                 $this->ctrl->getLinkTarget($this, self::CMD_ADD)
             );
             $this->toolbar->addComponent($btn_add);
 
             // RESTORE
             $restoration_modal = $this->ui->factory()->modal()->interruptive(
                 $this->lng->txt(self::CMD_RESTORE),
                 $this->lng->txt('msg_restore_confirm'),
                 $this->ctrl->getLinkTarget($this, self::CMD_RESTORE)
             )->withActionButtonLabel($this->lng->txt('restore'));
             $btn_restore = $this->ui->factory()->button()->standard(
                 $this->lng->txt(self::CMD_RESTORE),
                 ''
             )->withOnClick(
                 $restoration_modal->getShowSignal()
             );
             $this->toolbar->addComponent($btn_restore);
             $this->toolbar->addComponent($restoration_modal);
 
             // REMOVE LOST ITEMS
             if ($this->repository->hasLostItems()) {
                 $btn_flush = $this->ui->factory()->button()->standard(
                     $this->lng->txt(self::CMD_FLUSH),
                     $this->ctrl->getLinkTarget($this, self::CMD_FLUSH)
                 );
                 $this->toolbar->addComponent($btn_flush);
             }
         }
 
         // TABLE
         $table = new ilMMTopItemTableGUI($this, new ilMMItemRepository(), $this->access);
         $table->setShowRowsSelector(false);
 
         return $table->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ move()

ilMMTopItemGUI::move ( )

private

Definition at line 296 of file class.ilMMTopItemGUI.php.

References $data, Vendor\Package\$f, cancel(), ilMMAbstractItemGUI\getMMItemFromRequest(), getMoveForm(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

Referenced by dispatchCommand().

                            : void
     {
         $form = $this->getMoveForm();
         $form = $form->withRequest($this->http->request());
 
         $item = $this->getMMItemFromRequest();
 
         $data = $form->getData();
         if ($item->isInterchangeable() && isset($data[0])) {
             $f = $this->repository->getItemFacadeForIdentificationString($data[0]);
             $item->setParent($data[0]);
             $this->repository->updateItem($item);
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_moved'), true);
         } else {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_not_moved'), true);
         }
 
         $this->cancel();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restore()

ilMMTopItemGUI::restore ( )

private

Definition at line 277 of file class.ilMMTopItemGUI.php.

References cancel(), ActiveRecord\flushDB(), and ILIAS\Repository\lng().

Referenced by dispatchCommand().

                               : void
     {
         ilMMItemStorage::flushDB();
         ilMMCustomItemStorage::flushDB();
         ilMMItemTranslationStorage::flushDB();
         ilMMTypeActionStorage::flushDB();
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_restored'), true);
 
         $this->cancel();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveTable()

ilMMTopItemGUI::saveTable ( )

private

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

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

Referenced by dispatchCommand().

                                 : void
     {
         global $DIC;
         $r = $DIC->http()->request()->getParsedBody();
         foreach ($r[self::IDENTIFIER] as $identification_string => $data) {
             $item = $this->repository->getItemFacadeForIdentificationString($this->unhash($identification_string));
             $item->setPosition((int) ($data['position'] ?? 999));
             $item->setActiveStatus((bool) ($data['active'] ?? false));
             $this->repository->updateItem($item);
         }
         $this->cancel();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selectParent()

ilMMTopItemGUI::selectParent ( )

private

Definition at line 289 of file class.ilMMTopItemGUI.php.

References getMoveForm(), and ILIAS\Repository\ui().

Referenced by dispatchCommand().

                                    : string
     {
         $form = $this->getMoveForm();
 
         return $this->ui->renderer()->render($form);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilMMTopItemGUI::update ( Container $DIC )

private

Parameters

Container $DIC

Returns: string

Exceptions

Throwable

Definition at line 251 of file class.ilMMTopItemGUI.php.

References Vendor\Package\$f, ilMMAbstractItemGUI\$lng, ilMMAbstractItemGUI\$repository, cancel(), ILIAS\DI\Container\ctrl(), ilMMAbstractItemGUI\getMMItemFromRequest(), ILIAS\DI\Container\http(), and ILIAS\DI\Container\ui().

Referenced by dispatchCommand().

                                            : string
     {
         $item = $this->getMMItemFromRequest();
         if ($item->isEditable()) {
             $f = new ilMMTopItemFormGUI($DIC->ctrl(), $DIC->ui()->factory(), $DIC->ui()->renderer(), $this->lng, $DIC->http(), $item, $this->repository);
             if ($f->save()) {
                 $this->cancel();
             }
 
             return $f->getHTML();
         }
 
         return "";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ CMD_ADD

const ilMMTopItemGUI::CMD_ADD = 'topitem_add'

Definition at line 36 of file class.ilMMTopItemGUI.php.

Referenced by ilMMTopItemFormGUI\initForm().

◆ CMD_CANCEL

const ilMMTopItemGUI::CMD_CANCEL = 'cancel'

Definition at line 45 of file class.ilMMTopItemGUI.php.

◆ CMD_CONFIRM_DELETE

const ilMMTopItemGUI::CMD_CONFIRM_DELETE = 'topitem_confirm_delete'

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

Referenced by ilMMTopItemTableGUI\fillRow().

◆ CMD_CREATE

const ilMMTopItemGUI::CMD_CREATE = 'topitem_create'

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

Referenced by ilMMTopItemFormGUI\initForm().

◆ CMD_DELETE

const ilMMTopItemGUI::CMD_DELETE = 'delete'

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

Referenced by ilMMTopItemTableGUI\fillRow().

◆ CMD_EDIT

const ilMMTopItemGUI::CMD_EDIT = 'topitem_edit'

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

Referenced by ilMMTopItemTableGUI\fillRow(), and ilMMTopItemFormGUI\initForm().

◆ CMD_MOVE

const ilMMTopItemGUI::CMD_MOVE = 'move'

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

Referenced by ilMMTopItemTableGUI\fillRow().

◆ CMD_RENDER_INTERRUPTIVE

const ilMMTopItemGUI::CMD_RENDER_INTERRUPTIVE = 'render_interruptive_modal'

Definition at line 46 of file class.ilMMTopItemGUI.php.

◆ CMD_RESTORE

const ilMMTopItemGUI::CMD_RESTORE = 'restore'

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

◆ CMD_SAVE_TABLE

const ilMMTopItemGUI::CMD_SAVE_TABLE = 'save_table'

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

Referenced by ilMMTopItemTableGUI\__construct().

◆ CMD_SELECT_PARENT

const ilMMTopItemGUI::CMD_SELECT_PARENT = 'selectParent'

Definition at line 48 of file class.ilMMTopItemGUI.php.

Referenced by ilMMTopItemTableGUI\fillRow().

◆ CMD_TRANSLATE

const ilMMTopItemGUI::CMD_TRANSLATE = 'topitem_translate'

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

Referenced by ilMMTopItemTableGUI\fillRow(), and ilMMSubItemTableGUI\initColumns().

◆ CMD_UPDATE

const ilMMTopItemGUI::CMD_UPDATE = 'topitem_update'

Definition at line 43 of file class.ilMMTopItemGUI.php.

Referenced by ilMMTopItemFormGUI\initForm().

◆ CMD_UPLOAD

const ilMMTopItemGUI::CMD_UPLOAD = 'upload'

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

◆ CMD_VIEW_TOP_ITEMS

const ilMMTopItemGUI::CMD_VIEW_TOP_ITEMS = 'subtab_topitems'

Definition at line 35 of file class.ilMMTopItemGUI.php.

Referenced by ilMMTabHandling\initTabs().

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

components/ILIAS/MainMenu/classes/Administration/class.ilMMTopItemGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add()

◆ cancel()

◆ create()

◆ delete()

◆ dispatchCommand()

◆ doubleCancel()

◆ edit()

◆ executeCommand()

◆ getMoveForm()

◆ index()

◆ move()

◆ restore()

◆ saveTable()

◆ selectParent()

◆ update()

Field Documentation

◆ CMD_ADD

◆ CMD_CANCEL

◆ CMD_CONFIRM_DELETE

◆ CMD_CREATE

◆ CMD_DELETE

◆ CMD_EDIT

◆ CMD_MOVE

◆ CMD_RENDER_INTERRUPTIVE

◆ CMD_RESTORE

◆ CMD_SAVE_TABLE

◆ CMD_SELECT_PARENT

◆ CMD_TRANSLATE

◆ CMD_UPDATE

◆ CMD_UPLOAD

◆ CMD_VIEW_TOP_ITEMS