Inheritance diagram for ilMMBaseGUI:

Collaboration diagram for ilMMBaseGUI:

Public Member Functions
	__construct (protected Pons $pons)

	getCurrentItem ()

	getMutlipleItems ()

	getTokensToKeep ()

	executeCommand ()

	getCurrentItem ()

Public Member Functions inherited from ILIAS\GlobalScreen\GUI\PonsGUI
	__construct (Pons $pons)

	executeCommand ()

	getTokensToKeep ()

Data Fields
const	CMD_DEFAULT = 'index'

const	CMD_ADD = 'add'

const	CMD_CREATE = 'create'

const	CMD_EDIT = 'edit'

const	CMD_DELETE = 'delete'

const	CMD_CONFIRM_DELETE = 'confirmDelete'

const	CMD_UPDATE = 'update'

const	CMD_ACTIVATE = 'activate'

const	CMD_DEACTIVATE = 'deactivate'

const	CMD_SAVE_ORDER = 'saveOrder'

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

Protected Member Functions
	keepTokens ()

	delete ()

	confirmDelete ()

	activate ()

	deactivate ()

	toggle (bool $activation)

	saveOrder ()

Protected Attributes
ilMMItemRepository	$repository

UIServices	$ui

Translator	$lng

Access	$access

Flow	$flow

ilToolbarGUI	$toolbar

Private Member Functions
	add ()

	edit ()

	create ()

	update ()

Detailed Description

Definition at line 30 of file class.ilMMBaseGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMMBaseGUI::__construct ( protected Pons $pons )

Definition at line 82 of file class.ilMMBaseGUI.php.

    {
        $this->ui = $this->pons->out()->ui();
        $this->lng = $this->pons->i18n();
        $this->repository = new ilMMItemRepository();
        $this->access = $this->pons->access();
        $this->flow = $this->pons->flow();
        $this->toolbar = $this->pons->out()->toolbar();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilMMBaseGUI::activate ( )

protected

Definition at line 182 of file class.ilMMBaseGUI.php.

                                 : void
    {
        $this->toggle(true);
    }

References toggle().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add()

ilMMBaseGUI::add ( )

private

Definition at line 125 of file class.ilMMBaseGUI.php.

                          : void
    {
        $this->form(false);
    }

References ILIAS\Repository\form().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDelete()

ilMMBaseGUI::confirmDelete ( )

protected

Definition at line 161 of file class.ilMMBaseGUI.php.

                                      : void
    {
        $this->keepTokens();
        $items = [];
        foreach ($this->getMutlipleItems() as $item) {
            $items[] = $this->ui->factory()->modal()->interruptiveItem()->standard(
                $this->hash($item->identification()->serialize()),
                $item->getDefaultTitle()
            );
        }
 
        $this->pons->out()->outAsyncAsConfirmation(
            $this->lng->txt('delete'),
            $this->lng->txt('confirm_delete'),
            $this->lng->txt('delete'),
            $this->flow->getHereAsURI(self::CMD_DELETE),
            ...$items
        );
    }

References getMutlipleItems(), keepTokens(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilMMBaseGUI::create ( )

private

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

                             : void
    {
        $this->form(true);
    }

References ILIAS\Repository\form().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deactivate()

ilMMBaseGUI::deactivate ( )

protected

Definition at line 188 of file class.ilMMBaseGUI.php.

                                   : void
    {
        $this->toggle(false);
    }

References toggle().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilMMBaseGUI::delete ( )

protected

Definition at line 149 of file class.ilMMBaseGUI.php.

                               : void
    {
        foreach ($this->getMutlipleItems() as $item) {
            if ($item->isDeletable()) {
                $this->repository->deleteItem($item);
            }
        }
        $this->pons->out()->success($this->lng->txt("msg_topitem_deleted"), true);
        $this->pons->flow()->redirect(self::CMD_DEFAULT);
    }

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

Here is the call graph for this function:

◆ edit()

ilMMBaseGUI::edit ( )

private

Definition at line 131 of file class.ilMMBaseGUI.php.

                           : void
    {
        $this->form(false);
    }

References ILIAS\Repository\form().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilMMBaseGUI::executeCommand ( )

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

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

Reimplemented in ilMMSubItemGUI, and ilMMTopItemGUI.

Definition at line 106 of file class.ilMMBaseGUI.php.

                                    : bool
    {
        match ($cmd = $this->pons->flow()->getCommand(self::CMD_DEFAULT)) {
            self::CMD_DEFAULT => $this->index(),
            self::CMD_ADD => $this->add(),
            self::CMD_EDIT => $this->edit(),
            self::CMD_CREATE => $this->create(),
            self::CMD_UPDATE => $this->update(),
            self::CMD_ACTIVATE => $this->activate(),
            self::CMD_DEACTIVATE => $this->deactivate(),
            self::CMD_CONFIRM_DELETE => $this->confirmDelete(),
            self::CMD_DELETE => $this->delete(),
            self::CMD_SAVE_ORDER => $this->saveOrder(),
            default => $this->pons->out()->outString('Command not found:' . $cmd)
        };
        return true;
    }

References activate(), add(), confirmDelete(), create(), deactivate(), edit(), saveOrder(), and update().

Here is the call graph for this function:

◆ getCurrentItem()

ilMMBaseGUI::getCurrentItem ( )

abstract

Implements ILIAS\GlobalScreen\GUI\I18n\SupportsTranslationGUI.

Reimplemented in ilMMSubItemGUI, and ilMMTopItemGUI.

◆ getMutlipleItems()

ilMMBaseGUI::getMutlipleItems ( )

abstract

Returns: ilMMItemFacadeInterface[]

Reimplemented in ilMMSubItemGUI, and ilMMTopItemGUI.

Referenced by confirmDelete(), delete(), and toggle().

Here is the caller graph for this function:

◆ getTokensToKeep()

ilMMBaseGUI::getTokensToKeep ( )

abstract

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

Reimplemented in ilMMSubItemGUI, and ilMMTopItemGUI.

◆ keepTokens()

ilMMBaseGUI::keepTokens ( )

protected

Definition at line 92 of file class.ilMMBaseGUI.php.

                                   : void
    {
        $this->pons->in()->keepTokens($this);
    }

Referenced by confirmDelete(), ilMMSubItemGUI\confirmMove(), and ilMMTopItemGUI\selectParent().

Here is the caller graph for this function:

◆ saveOrder()

ilMMBaseGUI::saveOrder ( )

protected

Definition at line 225 of file class.ilMMBaseGUI.php.

                                  : void
    {
        foreach ($this->pons->in()->request()->getParsedBody() as $hashed_id => $position) {
            $item = $this->repository->getItemFacadeForIdentificationString($this->unhash($hashed_id));
            $item->setPosition((int) $position);
            $this->repository->updateItem($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:

◆ toggle()

ilMMBaseGUI::toggle ( bool $activation )

protected

Definition at line 194 of file class.ilMMBaseGUI.php.

                                               : void
    {
        $not_changed = [];
        $changed = [];
 
        foreach ($this->getMutlipleItems() as $item) {
            if (!$item->canBeDeactivated()) {
                $not_changed[] = $item->getDefaultTitle();
                continue;
            }
            $item->setActiveStatus($activation);
            $item->update();
            $changed[] = $item->getDefaultTitle();
        }
        if ($changed !== []) {
            $this->pons->out()->success(
                $this->lng->t('msg_success'),
                true
            );
        }
 
        if ($not_changed !== []) {
            $this->pons->out()->error(
                $this->lng->t('msg_not_changed', null, [implode(', ', $not_changed)]),
                true
            );
        }
        $this->flow->redirect(self::CMD_DEFAULT);
    }

References getMutlipleItems(), and ILIAS\Repository\lng().

Referenced by activate(), and deactivate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilMMBaseGUI::update ( )

private

Definition at line 143 of file class.ilMMBaseGUI.php.

                             : void
    {
        $this->form(true);
    }

References ILIAS\Repository\form().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $access

Access ilMMBaseGUI::$access

protected

Definition at line 78 of file class.ilMMBaseGUI.php.

◆ $flow

Flow ilMMBaseGUI::$flow

protected

Definition at line 79 of file class.ilMMBaseGUI.php.

◆ $lng

Translator ilMMBaseGUI::$lng

protected

Definition at line 77 of file class.ilMMBaseGUI.php.

◆ $repository

ilMMItemRepository ilMMBaseGUI::$repository

protected

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

◆ $toolbar

ilToolbarGUI ilMMBaseGUI::$toolbar

protected

Definition at line 80 of file class.ilMMBaseGUI.php.

◆ $ui

UIServices ilMMBaseGUI::$ui

protected

Definition at line 76 of file class.ilMMBaseGUI.php.

◆ CMD_ACTIVATE

const ilMMBaseGUI::CMD_ACTIVATE = 'activate'

Definition at line 65 of file class.ilMMBaseGUI.php.

Referenced by ilMMSubItemTableComponent\get(), and ilMMTopItemTableComponent\get().

◆ CMD_ADD

const ilMMBaseGUI::CMD_ADD = 'add'

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

◆ CMD_CONFIRM_DELETE

const ilMMBaseGUI::CMD_CONFIRM_DELETE = 'confirmDelete'

Definition at line 57 of file class.ilMMBaseGUI.php.

Referenced by ilMMSubItemTableComponent\get(), and ilMMTopItemTableComponent\get().

◆ CMD_CREATE

const ilMMBaseGUI::CMD_CREATE = 'create'

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

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

◆ CMD_DEACTIVATE

const ilMMBaseGUI::CMD_DEACTIVATE = 'deactivate'

Definition at line 69 of file class.ilMMBaseGUI.php.

Referenced by ilMMSubItemTableComponent\get(), and ilMMTopItemTableComponent\get().

◆ CMD_DEFAULT

const ilMMBaseGUI::CMD_DEFAULT = 'index'

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

Referenced by ilMMTopItemTableComponent\get(), and ilMMTopItemTableComponent\getRows().

◆ CMD_DELETE

const ilMMBaseGUI::CMD_DELETE = 'delete'

Definition at line 53 of file class.ilMMBaseGUI.php.

◆ CMD_EDIT

const ilMMBaseGUI::CMD_EDIT = 'edit'

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

Referenced by ilMMSubItemTableComponent\get(), and ilMMTopItemTableComponent\get().

◆ CMD_SAVE_ORDER

const ilMMBaseGUI::CMD_SAVE_ORDER = 'saveOrder'

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

Referenced by ilMMSubItemTableComponent\get(), and ilMMTopItemTableComponent\get().

◆ CMD_UPDATE

const ilMMBaseGUI::CMD_UPDATE = 'update'

Definition at line 61 of file class.ilMMBaseGUI.php.

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

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activate()

◆ add()

◆ confirmDelete()

◆ create()

◆ deactivate()

◆ delete()

◆ edit()

◆ executeCommand()

◆ getCurrentItem()

◆ getMutlipleItems()

◆ getTokensToKeep()

◆ keepTokens()

◆ saveOrder()

◆ toggle()

◆ update()

Field Documentation

◆ $access

◆ $flow

◆ $lng

◆ $repository

◆ $toolbar

◆ $ui

◆ CMD_ACTIVATE

◆ CMD_ADD

◆ CMD_CONFIRM_DELETE

◆ CMD_CREATE

◆ CMD_DEACTIVATE

◆ CMD_DEFAULT

◆ CMD_DELETE

◆ CMD_EDIT

◆ CMD_SAVE_ORDER

◆ CMD_UPDATE