@ilCtrl_IsCalledBy ilMMSubItemGUI: ilMMTopItemGUI @ilCtrl_Calls ilMMSubItemGUI: ILIAS\GlobalScreen\GUI\I18n\MultiLanguageGUI More...

Inheritance diagram for ilMMSubItemGUI:

Collaboration diagram for ilMMSubItemGUI:

Public Member Functions
	__construct (Pons $pons)

	executeCommand ()

	getCurrentItem ()

	getMutlipleItems ()

	getTokensToKeep ()

Public Member Functions inherited from ilMMBaseGUI
	__construct (protected Pons $pons)

	getCurrentItem ()

	getMutlipleItems ()

	getTokensToKeep ()

	executeCommand ()

	getCurrentItem ()

	__construct (Pons $pons)

	executeCommand ()

	getTokensToKeep ()

Data Fields
const	CMD_CONFIRM_MOVE = 'confirmMove'

const	CMD_MOVE = 'MOVE'

Data Fields inherited from ilMMBaseGUI
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
	buildForm ()

	form (bool $save=false)

	index ()

Protected Member Functions inherited from ilMMBaseGUI
	keepTokens ()

	delete ()

	confirmDelete ()

	activate ()

	deactivate ()

	toggle (bool $activation)

	saveOrder ()

Private Member Functions
	confirmMove ()

	move ()

Private Attributes
TokenContainer	$sub_token

TokenContainer	$top_token

ilMMItemFacadeInterface	$parent_item = null

Additional Inherited Members
Protected Attributes inherited from ilMMBaseGUI
ilMMItemRepository	$repository

UIServices	$ui

Translator	$lng

Access	$access

Flow	$flow

ilToolbarGUI	$toolbar

Detailed Description

@ilCtrl_IsCalledBy ilMMSubItemGUI: ilMMTopItemGUI @ilCtrl_Calls ilMMSubItemGUI: ILIAS\GlobalScreen\GUI\I18n\MultiLanguageGUI

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

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

Constructor & Destructor Documentation

◆ __construct()

ilMMSubItemGUI::__construct ( Pons $pons )

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

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

    {
        parent::__construct($pons);
        $this->sub_token = $this->pons->in()->buildToken('sub', 'id');
        $this->top_token = $this->pons->in()->buildToken('top', 'id');
        $identification = $this->pons->in()->getFirstFromRequest($this->top_token->token());
        if ($identification === 'lost_items' || $identification === null) {
            $this->parent_item = null;
        } else {
            $this->parent_item = $this->repository->getItemFacadeForIdentificationString(
                $identification
            );
        }
    }

References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

Member Function Documentation

◆ buildForm()

ilMMSubItemGUI::buildForm ( )

protected

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

                                  : ilMMSubitemFormGUI
    {
        $item = $this->repository->getItemFacadeForIdentificationString(
            $this->pons->in()->getFirstFromRequest($this->sub_token->token())
        );
        return new ilMMSubitemFormGUI(
            $this->flow->ctrl(),
            $this->ui->factory(),
            $this->ui->renderer(),
            $this->lng,
            $this->pons->in()->request(),
            $item,
            $this->repository,
            $this->parent_item
        );
    }

References ILIAS\UI\examples\Deck\repository().

Referenced by form(), and index().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmMove()

ilMMSubItemGUI::confirmMove ( )

private

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

                                  : void
    {
        $this->keepTokens();
 
        $items = [];
        foreach ($this->getMutlipleItems() as $item) {
            $items[] = $this->ui->factory()->modal()->interruptiveItem()->standard(
                $this->hash($item->getId()),
                $item->getDefaultTitle(),
            );
        }
 
        $this->pons->out()->outAsyncAsConfirmation(
            $this->lng->t('move'),
            $this->lng->t('confirm_move'),
            $this->lng->t('move'),
            $this->flow->getLinkTarget($this, self::CMD_MOVE),
            ...$items
        );
    }

References getMutlipleItems(), ilMMBaseGUI\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:

◆ executeCommand()

ilMMSubItemGUI::executeCommand ( )

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

Reimplemented from ilMMBaseGUI.

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

                                    : bool
    {
        $this->pons->in()->keep($this->top_token->token());
        if ($this->pons->handle('sub_items')) {
            return true;
        }
 
        match ($this->pons->flow()->getCommand(self::CMD_DEFAULT)) {
            self::CMD_CONFIRM_MOVE => $this->confirmMove(),
            self::CMD_MOVE => $this->move(),
            default => parent::executeCommand()
        };
        return true;
    }

References confirmMove(), and move().

Here is the call graph for this function:

◆ form()

ilMMSubItemGUI::form ( bool $save = false )

protected

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

                                               : void
    {
        if (!$save) {
            $this->pons->in()->keep($this->sub_token->token());
        }
 
        $form = $this->buildForm();
 
        if ($save) {
            if ($form->save()) {
                $this->pons->out()->success($this->lng->t('item_updated'), true);
                $this->pons->flow()->redirect(self::CMD_DEFAULT);
            } else {
                $this->pons->in()->keep($this->sub_token->token());
                $this->pons->out()->out($form->get());
                return;
            }
        }
 
        $this->pons->out()->outAsyncAsModal(
            $this->lng->txt('subitem'),
            $this->flow->getLinkTarget($this, self::CMD_UPDATE),
            $form->get()
        );
    }

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

Here is the call graph for this function:

◆ getCurrentItem()

ilMMSubItemGUI::getCurrentItem ( )

Reimplemented from ilMMBaseGUI.

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

                                    : ilMMItemFacadeInterface
    {
        return $this->repository->getItemFacadeForIdentificationString(
            $this->pons->in()->getFirstFromRequest($this->sub_token->token())
        );
    }

References ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

◆ getMutlipleItems()

ilMMSubItemGUI::getMutlipleItems ( )

Returns: ilMMItemFacadeInterface[]

Reimplemented from ilMMBaseGUI.

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

                                      : array
    {
        $ids = $this->pons->in()->getAllFromRequest($this->sub_token->token());
        if (($ids[0] ?? null) === Input::ALL_OBJECTS) {
            return array_map(
                fn(array $data): \ilMMItemFacadeInterface => $this->repository->getItemFacadeForIdentificationString(
                    $data['identification']
                ),
                $this->repository->getSubItemsForTable($this->parent_item)
            );
        }
        return $this->repository->getItemFacadesForIdentificationStrings($ids);
    }

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

Referenced by confirmMove(), and move().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTokensToKeep()

ilMMSubItemGUI::getTokensToKeep ( )

Reimplemented from ilMMBaseGUI.

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

                                     : array
    {
        return [
            $this->top_token->token(),
            $this->sub_token->token(),
        ];
    }

◆ index()

ilMMSubItemGUI::index ( )

protected

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

                              : void
    {
        $write_access = $this->access->hasUserPermissionTo('write');
        if ($write_access && $this->parent_item !== null) {
            // ADD NEW
            $form = $this->buildForm();
            $add_modal = $this->ui->factory()->modal()->roundtrip(
                $this->lng->t('subitem_add'),
                null,
                $form->get()->getInputs(),
                $this->flow->getLinkTarget($this, self::CMD_CREATE)
            );
 
            $btn_add = $this->ui->factory()->button()->primary(
                $this->lng->t('subitem_add'),
                $add_modal->getShowSignal()
            );
            $this->toolbar->addComponent($add_modal);
            $this->toolbar->addComponent($btn_add);
        }
 
        $table = new ilMMSubItemTableComponent(
            $this->pons,
            $this->sub_token,
            $this->repository,
            $this->parent_item,
            $write_access
        );
 
        $this->pons->out()->out(...$table->get());
    }

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

Here is the call graph for this function:

◆ move()

ilMMSubItemGUI::move ( )

private

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

                           : void
    {
        $mutliple_items = $this->getMutlipleItems();
        if (empty($mutliple_items)) {
            $this->pons->out()->error($this->lng->t('msg_not_moved'), true);
            $this->pons->flow()->redirect(self::CMD_DEFAULT);
            return;
        }
        foreach ($mutliple_items as $item) {
            $item->setParent('');
            $this->repository->updateItem($item);
        }
 
        $this->pons->out()->success($this->lng->t('msg_moved'), true);
        $this->pons->flow()->redirect(self::CMD_DEFAULT);
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $parent_item

ilMMItemFacadeInterface ilMMSubItemGUI::$parent_item = null

private

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

◆ $sub_token

TokenContainer ilMMSubItemGUI::$sub_token

private

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

◆ $top_token

TokenContainer ilMMSubItemGUI::$top_token

private

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

◆ CMD_CONFIRM_MOVE

const ilMMSubItemGUI::CMD_CONFIRM_MOVE = 'confirmMove'

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

Referenced by ilMMSubItemTableComponent\get().

◆ CMD_MOVE

const ilMMSubItemGUI::CMD_MOVE = 'MOVE'

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

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

components/ILIAS/MainMenu/classes/Administration/SubItems/class.ilMMSubItemGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildForm()

◆ confirmMove()

◆ executeCommand()

◆ form()

◆ getCurrentItem()

◆ getMutlipleItems()

◆ getTokensToKeep()

◆ index()

◆ move()

Field Documentation

◆ $parent_item

◆ $sub_token

◆ $top_token

◆ CMD_CONFIRM_MOVE

◆ CMD_MOVE