ilObjFooterUIHandling Class Reference

Collaboration diagram for ilObjFooterUIHandling:

Public Member Functions
	__construct (private UIServices $ui, private Services $http, private ilTabsGUI $tabs_gui, private Translator $translator, private ilCtrlInterface $ctrl, private ilErrorHandling $error, private ilRbacSystem $rbac_system, private int $ref_id)
	outAsyncAsModal (string $title, string $post_url, ?Component ... $components)
	outAsync (?Component ... $components)
	out (?Component ... $components)
	render (?Component ... $components)
	buildMainTabs ()
	backToMainTab ()
	activateTab (string $tab)
	requireReadable ()
	requireWritable ()
	hasPermission (string $permissions)

Private Attributes
ilGlobalTemplateInterface	$main_tpl
Renderer	$ui_renderer
Factory	$ui_factory

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilObjFooterUIHandling::__construct	(	private UIServices	$ui,
		private Services	$http,
		private ilTabsGUI	$tabs_gui,
		private Translator	$translator,
		private ilCtrlInterface	$ctrl,
		private ilErrorHandling	$error,
		private ilRbacSystem	$rbac_system,
		private int	$ref_id
	)

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

References ILIAS\Repository\ui().

      {
        $this->main_tpl = $this->ui->mainTemplate();
        $this->ui_renderer = $this->ui->renderer();
        $this->ui_factory = $this->ui->factory();
    }

Here is the call graph for this function:

Member Function Documentation

activateTab()

ilObjFooterUIHandling::activateTab

(

string

$tab

)

Definition at line 171 of file class.ilObjFooterUIHandling.php.

                                            : void
    {
        $this->tabs_gui->activateTab($tab);
    }

backToMainTab()

ilObjFooterUIHandling::backToMainTab

(

)

Definition at line 144 of file class.ilObjFooterUIHandling.php.

References ilObjFooterAdministrationGUI\CMD_DEFAULT, ilFooterEntriesGUI\CMD_DEFAULT, and ILIAS\Repository\ctrl().

                                   : void
    {
        $this->tabs_gui->clearTargets();

        if (
            $this->ctrl->getCmd() !== ilFooterEntriesGUI::CMD_DEFAULT
            && $this->ctrl->getCmdClass() === strtolower(ilFooterEntriesGUI::class)
        ) {
            $this->tabs_gui->setBackTarget(
                $this->translator->translate('back'),
                $this->ctrl->getLinkTargetByClass(
                    ilFooterEntriesGUI::class,
                    ilFooterEntriesGUI::CMD_DEFAULT
                )
            );
            return;
        }

        $this->tabs_gui->setBackTarget(
            $this->translator->translate('back'),
            $this->ctrl->getLinkTargetByClass(
                ilObjFooterAdministrationGUI::class,
                ilObjFooterAdministrationGUI::CMD_DEFAULT
            )
        );
    }

Here is the call graph for this function:

buildMainTabs()

ilObjFooterUIHandling::buildMainTabs

(

)

Definition at line 127 of file class.ilObjFooterUIHandling.php.

References ilObjFooterAdministrationGUI\CMD_DEFAULT, ILIAS\Repository\ctrl(), ilObjFooterAdministrationGUI\TAB_INDEX, and ilObjFooterAdministrationGUI\TAB_PERMISSIONS.

                                   : void
    {
        $this->tabs_gui->addTab(
            ilObjFooterAdministrationGUI::TAB_INDEX,
            $this->translator->translate('groups'),
            $this->ctrl->getLinkTargetByClass(
                ilObjFooterAdministrationGUI::class,
                ilObjFooterAdministrationGUI::CMD_DEFAULT
            )
        );
        $this->tabs_gui->addTab(
            ilObjFooterAdministrationGUI::TAB_PERMISSIONS,
            $this->translator->translate('perm_settings'),
            $this->ctrl->getLinkTargetByClass([ilObjFooterAdministrationGUI::class, ilPermissionGUI::class], 'perm')
        );
    }

Here is the call graph for this function:

hasPermission()

ilObjFooterUIHandling::hasPermission

(

string

$permissions

)

Definition at line 186 of file class.ilObjFooterUIHandling.php.

References $id, $token, ILIAS\Repository\ctrl(), ILIAS\UI\URLBuilderToken\getName(), ILIAS\FileDelivery\http(), and ILIAS\Data\URI\withParameter().

                                                      : bool
    {
        return $this->rbac_system->checkAccess($permissions, $this->ref_id);
    }

Here is the call graph for this function:

out()

ilObjFooterUIHandling::out

(

?Component ...

$components

)

Definition at line 112 of file class.ilObjFooterUIHandling.php.

                                                  : void
    {
        $components = array_filter($components, fn($component): bool => $component !== null);

        $this->main_tpl->setContent(
            $this->ui_renderer->render($components)
        );
    }

outAsync()

ilObjFooterUIHandling::outAsync

(

?Component ...

$components

)

Definition at line 98 of file class.ilObjFooterUIHandling.php.

References $response, and ILIAS\FileDelivery\http().

Referenced by outAsyncAsModal().

                                                       : void
    {
        $components = array_filter($components, fn($component): bool => $component !== null);
        $string = $this->ui_renderer->renderAsync($components);
        $response = $this->http->response()->withBody(
            Streams::ofString(
                $string
            )
        );
        $this->http->saveResponse($response);
        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

outAsyncAsModal()

ilObjFooterUIHandling::outAsyncAsModal	(	string	$title,
		string	$post_url,
		?Component ...	$components
	)

Definition at line 58 of file class.ilObjFooterUIHandling.php.

References ILIAS\UI\Implementation\Component\Modal\InterruptiveItem\InterruptiveItem\getId(), ILIAS\UI\Implementation\Component\Input\getInputs(), ILIAS\UI\Implementation\Component\Modal\InterruptiveItem\KeyValue\getKey(), ILIAS\UI\Implementation\Component\Modal\InterruptiveItem\KeyValue\getValue(), and outAsync().

     : void {
        $is_form = count($components) === 1 && $components[0] instanceof Form;
        $are_interruptive = array_filter($components, fn($component): bool => $component instanceof KeyValue) !== [];

        $modal = match (true) {
            $is_form => $this->ui_factory->modal()->roundtrip(
                $title,
                null,
                $components[0]->getInputs(),
                $post_url
            ),
            $are_interruptive => $this->ui_factory->modal()->interruptive(
                $title,
                $this->translator->translate('confirm_delete'),
                $post_url
            )->withAffectedItems(
                array_map(
                    fn(KeyValue $item): \ILIAS\UI\Component\Modal\InterruptiveItem\KeyValue => $this->ui_factory->modal()->interruptiveItem()->keyValue(
                        $this->hash($item->getId()),
                        $item->getKey(),
                        $item->getValue()
                    ),
                    $components
                )
            ),
            default => $this->ui_factory->modal()->roundtrip(
                $title,
                $components,
                [],
                $post_url
            )
        };

        $this->outAsync($modal);
    }

Here is the call graph for this function:

render()

ilObjFooterUIHandling::render

(

?Component ...

$components

)

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

                                                     : string
    {
        $components = array_filter($components, fn($component): bool => $component !== null);

        return $this->ui_renderer->render($components);
    }

requireReadable()

ilObjFooterUIHandling::requireReadable

(

)

Definition at line 176 of file class.ilObjFooterUIHandling.php.

                                     : void
    {
        $this->require('read');
    }

requireWritable()

ilObjFooterUIHandling::requireWritable

(

)

Definition at line 181 of file class.ilObjFooterUIHandling.php.

                                     : void
    {
        $this->require('write');
    }

Field Documentation

$main_tpl

ilGlobalTemplateInterface ilObjFooterUIHandling::$main_tpl

private

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

$ui_factory

Factory ilObjFooterUIHandling::$ui_factory

private

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

$ui_renderer

Renderer ilObjFooterUIHandling::$ui_renderer

private

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

---

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

• components/ILIAS/GlobalScreen_/classes/UI/Footer/class.ilObjFooterUIHandling.php