Inheritance diagram for ShortlinkAdministrationGUI:

Collaboration diagram for ShortlinkAdministrationGUI:

Public Member Functions
	__construct (Pons $pons)

	executeCommand ()

	getTokensToKeep ()

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

	__construct (Pons $pons)

	executeCommand ()

	getTokensToKeep ()

Data Fields
const string	CMD_FORM = 'form'

const string	CMD_SAVE = 'save'

const string	CMD_CONFIRM_DELETE = 'confirmDelete'

const string	CMD_DELETE = 'delete'

const string	CMD_CONFIRM_TOGGLE = 'confirmToggle'

const string	CMD_TOGGLE = 'toggle'

const string	CMD_SAVE_ORDERING = 'saveOrdering'

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

Private Member Functions
	getForm ()

	save ()

	form ()

	index ()

	confirm (string $target_command, string $title, string $message, string $button_title,)

	confirmDelete ()

	delete ()

	confirmToggle ()

	toggle ()

	saveOrdering ()

	getAllIds ()

Private Attributes
ilToolbarGUI	$toolbar

Factory	$ui_factory

Repository	$repository

TokenContainer	$token

TargetLinkResolver	$link_resolver

Configuration	$configuration

Detailed Description

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

@ilCtrl_IsCalledBy ShortlinkAdministrationGUI: ilObjStaticUrlServiceGUI

Definition at line 43 of file ShortlinkAdministrationGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ShortlinkAdministrationGUI::__construct ( Pons $pons )

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

Definition at line 61 of file ShortlinkAdministrationGUI.php.

    {
        global $DIC;
        parent::__construct($pons);
        $this->toolbar = $pons->out()->toolbar();
        $this->ui_factory = $pons->out()->ui()->factory();
        $this->repository = new RepositoryDB(
            $DIC->database(),
            new ILIASTypeDataResolver(
                $DIC->repositoryTree()
            )
        );
        $this->link_resolver = new TargetLinkResolver(
            $DIC['static_url']->builder(),
            $DIC[\ILIAS\Data\Factory::class],
            $this->ui_factory,
        );
        $this->token = $this->pons->in()->buildToken('alias', 'id');
        $this->configuration = $DIC['static_url.config'];
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\GlobalScreen\GUI\Pons\out(), ILIAS\UI\examples\Deck\repository(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ confirm()

ShortlinkAdministrationGUI::confirm	(	string	$target_command,
		string	$title,
		string	$message,
		string	$button_title
	)

private

Definition at line 211 of file ShortlinkAdministrationGUI.php.

     : void {
        $items = [];
        $from_request = $this->getAllIds();
 
        $this->pons->out()->nok();
        $this->pons->out()->ok();
 
        foreach ($from_request as $id) {
            $shortlink = $this->repository->getById($id);
            if ($shortlink === null) {
                continue;
            }
            $id = $this->hash($id);
 
            $items[] = $this->ui_factory->modal()->interruptiveItem()->standard(
                $id,
                $shortlink->getAlias(),
            );
        }
 
        $this->pons->out()->outAsyncAsConfirmation(
            $title,
            $message,
            $button_title,
            $this->pons->flow()->getHereAsURI($target_command),
            ...$items
        );
    }

◆ confirmDelete()

ShortlinkAdministrationGUI::confirmDelete ( )

private

Definition at line 246 of file ShortlinkAdministrationGUI.php.

                                    : void
    {
        $this->confirm(
            self::CMD_DELETE,
            $this->pons->i18n()->t('delete_shortlink'),
            $this->pons->i18n()->t('delete_shortlink_msg'),
            $this->pons->i18n()->t('delete')
        );
    }

Referenced by executeCommand().

Here is the caller graph for this function:

◆ confirmToggle()

ShortlinkAdministrationGUI::confirmToggle ( )

private

Definition at line 273 of file ShortlinkAdministrationGUI.php.

                                    : void
    {
        $this->confirm(
            self::CMD_TOGGLE,
            $this->pons->i18n()->t('toggle_shortlink'),
            $this->pons->i18n()->t('toggle_shortlink_msg'),
            $this->pons->i18n()->t('toggle')
        );
    }

Referenced by executeCommand().

Here is the caller graph for this function:

◆ delete()

ShortlinkAdministrationGUI::delete ( )

private

Definition at line 257 of file ShortlinkAdministrationGUI.php.

                             : void
    {
        $from_request = $this->getAllIds();
        foreach ($from_request as $id) {
            $shortlink = $this->repository->getById($id);
            if ($shortlink === null) {
                continue;
            }
            $this->repository->delete($shortlink);
        }
 
        $this->pons->out()->success($this->pons->i18n()->t('shortlinks_deleted'));
        $this->pons->flow()->redirect(self::CMD_DEFAULT);
    }

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

Here is the call graph for this function:

◆ executeCommand()

ShortlinkAdministrationGUI::executeCommand ( )

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

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

Definition at line 102 of file ShortlinkAdministrationGUI.php.

                                    : bool
    {
        if ($this->pons->handle(ilObjStaticUrlServiceGUI::TAB_INDEX)) {
            return true;
        }
 
        match ($cmd = $this->pons->flow()->getCommand(self::CMD_DEFAULT)) {
            self::CMD_DEFAULT => $this->index(),
            self::CMD_FORM => $this->form(),
            self::CMD_SAVE => $this->save(),
            self::CMD_CONFIRM_DELETE => $this->confirmDelete(),
            self::CMD_DELETE => $this->delete(),
            self::CMD_CONFIRM_TOGGLE => $this->confirmToggle(),
            self::CMD_TOGGLE => $this->toggle(),
            self::CMD_SAVE_ORDERING => $this->saveOrdering(),
            default => $this->pons->out()->outString(
                'Unknown command: ' . $cmd
            ),
        };
        return true;
    }

References confirmDelete(), confirmToggle(), form(), index(), save(), saveOrdering(), ilObjStaticUrlServiceGUI\TAB_INDEX, and toggle().

Here is the call graph for this function:

◆ form()

ShortlinkAdministrationGUI::form ( )

private

Definition at line 157 of file ShortlinkAdministrationGUI.php.

                           : void
    {
        $form = $this->getForm();
 
        $this->pons->in()->keep(
            $this->token
        );
 
        $this->pons->out()->outAsyncAsModal(
            $this->pons->i18n()->t('shortlink'),
            $this->pons->flow()->getHereAsURI(self::CMD_SAVE),
            ...iterator_to_array($form->get())
        );
    }

References getForm().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllIds()

ShortlinkAdministrationGUI::getAllIds ( )

private

Definition at line 315 of file ShortlinkAdministrationGUI.php.

                                : array
    {
        $from_request = $this->pons->in()->getAllFromRequest($this->token);
        if (($from_request[0] ?? null) === Input::ALL_OBJECTS) {
            return array_map(
                static fn(Shortlink $s): string => $s->getId(),
                iterator_to_array($this->repository->getAll())
            );
        }
        return array_unique($from_request);
    }

References ILIAS\StaticURL\Shortlinks\Shortlink\Shortlink\getId(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

◆ getForm()

ShortlinkAdministrationGUI::getForm ( )

private

Definition at line 82 of file ShortlinkAdministrationGUI.php.

                              : Form
    {
        $id_from_request = $this->pons->in()->getFirstFromRequest($this->token);
 
        if ($this->repository->hasId($id_from_request)) {
            $shortlink = $this->repository->getById(
                $id_from_request
            );
        } else {
            $shortlink = $this->repository->blank();
        }
 
        return new Form(
            $this->pons,
            $this->repository,
            $this->pons->flow()->getHereAsURI(self::CMD_SAVE),
            $shortlink
        );
    }

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

Referenced by form(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTokensToKeep()

ShortlinkAdministrationGUI::getTokensToKeep ( )

Implements ILIAS\GlobalScreen\GUI\PonsGUI.

Definition at line 124 of file ShortlinkAdministrationGUI.php.

                                     : array
    {
        return [];
    }

◆ index()

ShortlinkAdministrationGUI::index ( )

private

Definition at line 173 of file ShortlinkAdministrationGUI.php.

                            : void
    {
        if ($this->pons->access()->hasUserPermissionTo('write')) {
            $this->toolbar->addComponent(
                $modal = $this->ui_factory->modal()->roundtrip(
                    $this->pons->i18n()->t('create_shortlink'),
                    null,
                    [],
                    null
                )->withAsyncRenderUrl(
                    (string) $this->pons->flow()->getHereAsURI(self::CMD_FORM),
                )
            );
 
            $this->toolbar->addComponent(
                $button = $this->ui_factory->button()->primary(
                    $this->pons->i18n()->t('create_shortlink'),
                    (string) $this->pons->flow()->getHereAsURI(self::CMD_FORM), // TODO make async again
                )->withOnClick(
                    $modal->getShowSignal()
                )
            );
        }
 
        $table = new Table(
            $this->pons,
            $this->repository,
            $this->link_resolver,
            $this->pons->flow()->getHereAsURI(self::CMD_SAVE_ORDERING),
            $this->token,
            $this->configuration,
            $this->pons->access()->hasUserPermissionTo('write'),
        );
 
        $this->pons->out()->out(...iterator_to_array($table->get()));
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ShortlinkAdministrationGUI::save ( )

private

Definition at line 130 of file ShortlinkAdministrationGUI.php.

                           : void
    {
        $form = $this->getForm();
        if (($out_form = $form->save()) instanceof Standard) {
            $this->pons->out()->out(
                $out_form
            );
            return;
        }
        $this
            ->pons
            ->out()
            ->success(
                $this->pons->i18n()->t(
                    'stus_stored_sucessfully'
                )
            );
 
        $this
            ->pons
            ->flow()
            ->redirect(
                self::CMD_DEFAULT
            );
    }

References getForm().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveOrdering()

ShortlinkAdministrationGUI::saveOrdering ( )

private

Definition at line 304 of file ShortlinkAdministrationGUI.php.

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

ShortlinkAdministrationGUI::toggle ( )

private

Definition at line 284 of file ShortlinkAdministrationGUI.php.

                             : void
    {
        $from_request = $this->getAllIds();
        foreach ($from_request as $id) {
            $shortlink = $this->repository->getById($id);
            if ($shortlink === null) {
                continue;
            }
            $shortlink = $shortlink->withActive(
                !$shortlink->isActive()
            );
 
            $this->repository->store($shortlink);
        }
 
        $this->pons->out()->success($this->pons->i18n()->t('shortlinks_toggled'));
        $this->pons->flow()->redirect(self::CMD_DEFAULT);
    }