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

Inheritance diagram for ilMMSubItemGUI:

Collaboration diagram for ilMMSubItemGUI:

Public Member Functions
	executeCommand ()

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

Data Fields
const	CMD_VIEW_SUB_ITEMS = 'subtab_subitems'

const	CMD_ADD = 'subitem_add'

const	CMD_CREATE = 'subitem_create'

const	CMD_CONFIRM_MOVE = 'confirm_move'

const	CMD_MOVE = 'move'

const	CMD_DELETE = 'delete'

const	CMD_CONFIRM_DELETE = 'subitem_confirm_delete'

const	CMD_EDIT = 'subitem_edit'

const	CMD_TRANSLATE = 'subitem_translate'

const	CMD_UPDATE = 'subitem_update'

const	CMD_SAVE_TABLE = 'save_table'

const	CMD_APPLY_FILTER = 'applyFilter'

const	CMD_RESET_FILTER = 'resetFilter'

const	CMD_RENDER_INTERRUPTIVE = 'render_interruptive_modal'

const	CMD_CANCEL = 'cancel'

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

	add ($DIC)

	create ($DIC)

	edit ($DIC)

	update ($DIC)

	applyFilter ()

	resetFilter ()

	index ()

	delete ()

	confirmDelete ()

	confirmMove ()

	move ()

Additional Inherited Members
Protected Attributes inherited from ilMMAbstractItemGUI
UIServices	$ui

Services	$http

ilMMItemRepository	$repository

ilToolbarGUI	$toolbar

ilMMTabHandling	$tab_handling

ilTabsGUI	$tabs

ilCtrl	$ctrl

ilObjMainMenuAccess	$access

Detailed Description

Class ilMMTopItemGUI ilMMSubItemGUI: ilObjMainMenuGUI ilMMSubItemGUI: ilMMItemTranslationGUI.

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

Definition at line 29 of file class.ilMMSubItemGUI.php.

Member Function Documentation

◆ add()

ilMMSubItemGUI::add ( $DIC )

private

Parameters

$DIC

Returns: string

Exceptions

Throwable

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

References $DIC, Vendor\Package\$f, ilMMAbstractItemGUI\$lng, ilMMAbstractItemGUI\$repository, and ILIAS\UI\examples\Deck\repository().

Referenced by dispatchCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyFilter()

ilMMSubItemGUI::applyFilter ( )

private

Definition at line 211 of file class.ilMMSubItemGUI.php.

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

Referenced by dispatchCommand().

                                   : void
     {
         $table = new ilMMSubItemTableGUI($this, $this->repository, $this->access);
         $table->writeFilterToSession();
 
         $this->cancel();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancel()

ilMMSubItemGUI::cancel ( )

protected

Definition at line 268 of file class.ilMMSubItemGUI.php.

References ILIAS\Repository\ctrl().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDelete()

ilMMSubItemGUI::confirmDelete ( )

private

Returns: string

Exceptions

Throwable

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

References $c, $i, ILIAS\Repository\ctrl(), ilMMAbstractItemGUI\getMMItemFromRequest(), and ILIAS\Repository\lng().

Referenced by dispatchCommand().

                                     : string
     {
         $this->ctrl->saveParameterByClass(self::class, self::IDENTIFIER);
         $i = $this->getMMItemFromRequest();
         $c = new ilConfirmationGUI();
         $c->addItem(self::IDENTIFIER, $this->hash($i->getId()), $i->getDefaultTitle());
         $c->setFormAction($this->ctrl->getFormActionByClass(self::class));
         $c->setConfirm($this->lng->txt(self::CMD_DELETE), self::CMD_DELETE);
         $c->setCancel($this->lng->txt(self::CMD_CANCEL), self::CMD_CANCEL);
         $c->setHeaderText($this->lng->txt(self::CMD_CONFIRM_DELETE));
 
         return $c->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmMove()

ilMMSubItemGUI::confirmMove ( )

private

Returns: string

Exceptions

Throwable

Definition at line 295 of file class.ilMMSubItemGUI.php.

References $c, $i, ILIAS\Repository\ctrl(), ilMMAbstractItemGUI\getMMItemFromRequest(), and ILIAS\Repository\lng().

Referenced by dispatchCommand().

                                   : string
     {
         $this->ctrl->saveParameterByClass(self::class, self::IDENTIFIER);
         $i = $this->getMMItemFromRequest();
         $c = new ilConfirmationGUI();
         $c->addItem(self::IDENTIFIER, $this->hash($i->getId()), $i->getDefaultTitle());
         $c->setFormAction($this->ctrl->getFormActionByClass(self::class));
         $c->setConfirm($this->lng->txt(self::CMD_MOVE), self::CMD_MOVE);
         $c->setCancel($this->lng->txt(self::CMD_CANCEL), self::CMD_CANCEL);
         $c->setHeaderText($this->lng->txt(self::CMD_CONFIRM_MOVE));
 
         return $c->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilMMSubItemGUI::create ( $DIC )

private

Parameters

$DIC

Returns: string

Exceptions

Throwable

Definition at line 174 of file class.ilMMSubItemGUI.php.

References $DIC, Vendor\Package\$f, ilMMAbstractItemGUI\$lng, ilMMAbstractItemGUI\$repository, cancel(), and ILIAS\UI\examples\Deck\repository().

Referenced by dispatchCommand().

                                  : string
     {
         $f = new ilMMSubitemFormGUI($DIC->ctrl(), $DIC->ui()->factory(), $DIC->ui()->renderer(), $this->lng, $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()

ilMMSubItemGUI::delete ( )

private

Definition at line 257 of file class.ilMMSubItemGUI.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_subitem_deleted"), true);
         $this->cancel();
     }

Here is the call graph for this function:

◆ dispatchCommand()

ilMMSubItemGUI::dispatchCommand ( string $cmd )

private

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

References $DIC, ILIAS\Repository\access(), add(), applyFilter(), cancel(), CMD_VIEW_SUB_ITEMS, confirmDelete(), confirmMove(), create(), edit(), ilMMAbstractItemGUI\flush(), index(), move(), resetFilter(), saveTable(), ilObjMainMenuGUI\TAB_MAIN, and update().

Referenced by executeCommand().

                                                  : string
     {
         global $DIC;
         switch ($cmd) {
             case self::CMD_ADD:
                 $this->access->checkAccessAndThrowException('write');
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, ilMMSubItemGUI::CMD_VIEW_SUB_ITEMS, true, self::class);
 
                 return $this->add($DIC);
             case self::CMD_CREATE:
                 $this->access->checkAccessAndThrowException('write');
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, ilMMSubItemGUI::CMD_VIEW_SUB_ITEMS, true, self::class);
 
                 return $this->create($DIC);
             case self::CMD_EDIT:
                 $this->access->checkAccessAndThrowException('write');
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, ilMMSubItemGUI::CMD_VIEW_SUB_ITEMS, true, self::class);
 
                 return $this->edit($DIC);
             case self::CMD_UPDATE:
                 $this->access->checkAccessAndThrowException('write');
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, ilMMSubItemGUI::CMD_VIEW_SUB_ITEMS, true, self::class);
 
                 return $this->update($DIC);
             case self::CMD_APPLY_FILTER:
                 $this->access->checkAccessAndThrowException('visible,read');
                 $this->applyFilter();
                 break;
             case self::CMD_RESET_FILTER:
                 $this->access->checkAccessAndThrowException('visible,read');
                 $this->resetFilter();
                 break;
             case self::CMD_VIEW_SUB_ITEMS:
                 $this->access->checkAccessAndThrowException('visible,read');
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, $cmd);
 
                 return $this->index();
             case self::CMD_SAVE_TABLE:
                 $this->access->checkAccessAndThrowException('write');
                 $this->saveTable();
                 break;
             case self::CMD_CONFIRM_DELETE:
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, ilMMSubItemGUI::CMD_VIEW_SUB_ITEMS, true, self::class);
                 $this->access->checkAccessAndThrowException('write');
 
                 return $this->confirmDelete();
             case self::CMD_CONFIRM_MOVE:
                 $this->tab_handling->initTabs(ilObjMainMenuGUI::TAB_MAIN, ilMMSubItemGUI::CMD_VIEW_SUB_ITEMS, true, self::class);
                 $this->access->checkAccessAndThrowException('write');
 
                 return $this->confirmMove();
             case self::CMD_MOVE:
                 $this->access->checkAccessAndThrowException('write');
                 $this->move();
                 break;
             case self::CMD_DELETE:
                 $this->access->checkAccessAndThrowException('write');
                 $this->delete();
                 break;
             case self::CMD_CANCEL:
                 $this->cancel();
                 break;
             case self::CMD_FLUSH:
                 $this->access->checkAccessAndThrowException('write');
                 $this->flush();
                 break;
         }
 
         return "";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edit()

ilMMSubItemGUI::edit ( $DIC )

private

Parameters

$DIC

Returns: string

Exceptions

Throwable

Definition at line 189 of file class.ilMMSubItemGUI.php.

References $DIC, Vendor\Package\$f, ilMMAbstractItemGUI\$lng, ilMMAbstractItemGUI\$repository, and ilMMAbstractItemGUI\getMMItemFromRequest().

Referenced by dispatchCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilMMSubItemGUI::executeCommand ( )

Definition at line 135 of file class.ilMMSubItemGUI.php.

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

                                     : void
     {
         $next_class = $this->ctrl->getNextClass();
 
         if ('' === $next_class) {
             $cmd = $this->determineCommand(self::CMD_VIEW_SUB_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_SUB_ITEMS, true, $this->ctrl->getCallHistory()[2][ilCtrlInterface::PARAM_CMD_CLASS] ?? '');
                 $g = new ilMMItemTranslationGUI($this->getMMItemFromRequest(), $this->repository);
                 $this->ctrl->forwardCommand($g);
                 break;
             default:
                 break;
         }
     }

Here is the call graph for this function:

◆ index()

ilMMSubItemGUI::index ( )

private

Returns: string

Definition at line 231 of file class.ilMMSubItemGUI.php.

References Vendor\Package\$b, ILIAS\Repository\access(), CMD_ADD, ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), and ILIAS\Repository\toolbar().

Referenced by dispatchCommand().

                             : string
     {
         // ADD NEW
         if ($this->access->hasUserPermissionTo('write')) {
             $b = ilLinkButton::getInstance();
             $b->setUrl($this->ctrl->getLinkTarget($this, ilMMSubItemGUI::CMD_ADD));
             $b->setCaption($this->lng->txt(ilMMSubItemGUI::CMD_ADD), false);
 
             $this->toolbar->addButtonInstance($b);
 
             // REMOVE LOST ITEMS
             if ($this->repository->hasLostItems()) {
                 $b = ilLinkButton::getInstance();
                 $b->setUrl($this->ctrl->getLinkTarget($this, self::CMD_FLUSH));
                 $b->setCaption($this->lng->txt(self::CMD_FLUSH), false);
                 $this->toolbar->addButtonInstance($b);
             }
         }
 
         // TABLE
         $table = new ilMMSubItemTableGUI($this, $this->repository, $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()

ilMMSubItemGUI::move ( )

private

Definition at line 309 of file class.ilMMSubItemGUI.php.

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

Referenced by dispatchCommand().

                            : void
     {
         $item = $this->getMMItemFromRequest();
         if ($item->isInterchangeable()) {
             $item->setParent('');
             $this->repository->updateItem($item);
         }
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_moved"), true);
         $this->cancel();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilMMSubItemGUI::resetFilter ( )

private

Definition at line 219 of file class.ilMMSubItemGUI.php.

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

Referenced by dispatchCommand().

                                   : void
     {
         $table = new ilMMSubItemTableGUI($this, $this->repository, $this->access);
         $table->resetFilter();
         $table->resetOffset();
 
         $this->cancel();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveTable()

ilMMSubItemGUI::saveTable ( )

private

Definition at line 120 of file class.ilMMSubItemGUI.php.

References $data, $DIC, cancel(), ILIAS\Repository\int(), 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));
             $position = (int) $data['position'];
             $item->setPosition($position);
             $item->setActiveStatus(isset($data['active']) && $data['active']);
             $item->setParent($this->unhash((string) $data['parent']));
             $this->repository->updateItem($item);
         }
         $this->cancel();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilMMSubItemGUI::update ( $DIC )

private

Parameters

$DIC

Returns: string

Exceptions

Throwable

Definition at line 201 of file class.ilMMSubItemGUI.php.

References $DIC, Vendor\Package\$f, ilMMAbstractItemGUI\$lng, ilMMAbstractItemGUI\$repository, cancel(), and ilMMAbstractItemGUI\getMMItemFromRequest().

Referenced by dispatchCommand().

                                  : string
     {
         $f = new ilMMSubitemFormGUI($DIC->ctrl(), $DIC->ui()->factory(), $DIC->ui()->renderer(), $this->lng, $this->getMMItemFromRequest(), $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:

Field Documentation

◆ CMD_ADD

const ilMMSubItemGUI::CMD_ADD = 'subitem_add'

Definition at line 34 of file class.ilMMSubItemGUI.php.

Referenced by index(), and ilMMSubitemFormGUI\initForm().

◆ CMD_APPLY_FILTER

const ilMMSubItemGUI::CMD_APPLY_FILTER = 'applyFilter'

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

◆ CMD_CANCEL

const ilMMSubItemGUI::CMD_CANCEL = 'cancel'

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

◆ CMD_CONFIRM_DELETE

const ilMMSubItemGUI::CMD_CONFIRM_DELETE = 'subitem_confirm_delete'

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

Referenced by ilMMSubItemTableGUI\initColumns().

◆ CMD_CONFIRM_MOVE

const ilMMSubItemGUI::CMD_CONFIRM_MOVE = 'confirm_move'

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

Referenced by ilMMSubItemTableGUI\initColumns().

◆ CMD_CREATE

const ilMMSubItemGUI::CMD_CREATE = 'subitem_create'

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

Referenced by ilMMSubitemFormGUI\initForm().

◆ CMD_DELETE

const ilMMSubItemGUI::CMD_DELETE = 'delete'

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

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

◆ CMD_EDIT

const ilMMSubItemGUI::CMD_EDIT = 'subitem_edit'

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

Referenced by ilMMSubItemTableGUI\initColumns(), and ilMMSubitemFormGUI\initForm().

◆ CMD_MOVE

const ilMMSubItemGUI::CMD_MOVE = 'move'

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

Referenced by ilMMSubItemTableGUI\initColumns().

◆ CMD_RENDER_INTERRUPTIVE

const ilMMSubItemGUI::CMD_RENDER_INTERRUPTIVE = 'render_interruptive_modal'

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

◆ CMD_RESET_FILTER

const ilMMSubItemGUI::CMD_RESET_FILTER = 'resetFilter'

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

◆ CMD_SAVE_TABLE

const ilMMSubItemGUI::CMD_SAVE_TABLE = 'save_table'

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

Referenced by ilMMSubItemTableGUI\__construct().

◆ CMD_TRANSLATE

const ilMMSubItemGUI::CMD_TRANSLATE = 'subitem_translate'

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

◆ CMD_UPDATE

const ilMMSubItemGUI::CMD_UPDATE = 'subitem_update'

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

Referenced by ilMMSubitemFormGUI\initForm().

◆ CMD_VIEW_SUB_ITEMS

const ilMMSubItemGUI::CMD_VIEW_SUB_ITEMS = 'subtab_subitems'

Definition at line 33 of file class.ilMMSubItemGUI.php.

Referenced by ilADNNotificationGUI\dispatchCommand(), dispatchCommand(), and ilMMTabHandling\initTabs().

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

Services/MainMenu/classes/Administration/class.ilMMSubItemGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add()

◆ applyFilter()

◆ cancel()

◆ confirmDelete()

◆ confirmMove()

◆ create()

◆ delete()

◆ dispatchCommand()

◆ edit()

◆ executeCommand()

◆ index()

◆ move()

◆ resetFilter()

◆ saveTable()

◆ update()

Field Documentation

◆ CMD_ADD

◆ CMD_APPLY_FILTER

◆ CMD_CANCEL

◆ CMD_CONFIRM_DELETE

◆ CMD_CONFIRM_MOVE

◆ CMD_CREATE

◆ CMD_DELETE

◆ CMD_EDIT

◆ CMD_MOVE

◆ CMD_RENDER_INTERRUPTIVE

◆ CMD_RESET_FILTER

◆ CMD_SAVE_TABLE

◆ CMD_TRANSLATE

◆ CMD_UPDATE

◆ CMD_VIEW_SUB_ITEMS