ILIAS\GlobalScreen\GUI\Output\Output Class Reference

Collaboration diagram for ILIAS\GlobalScreen\GUI\Output\Output:

Public Member Functions
	__construct (private UIServices $ui_services, private Services $http, private Translator $translator, private Tabs $tabs, private \ilToolbarGUI $toolbar,)
	response ()
	ui ()
	toolbar ()
	success (string $message, bool $keep=true)
	info (string $message, bool $keep=true)
	error (string $message, bool $keep=true)
	message (string $type, string $message, bool $keep=true)
	outAsyncAsConfirmation (string $title, string $message, string $button_text, URI|string $post_url, InterruptiveItem ... $components)
	outAsyncAsModal (string $title, URI|string $post_url, ?Component ... $components)
	outAsync (?Component ... $components)
	outString (string $string)
	out (?Component ... $components)
	render (?Component ... $components)
	nok (bool $as_image=false)
	ok (bool $as_image=false)

Private Attributes
Factory	$ui_factory
Renderer	$ui_renderer
ilGlobalTemplateInterface	$main_tpl

Detailed Description

Author

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

Definition at line 43 of file Output.php.

Constructor & Destructor Documentation

__construct()

ILIAS\GlobalScreen\GUI\Output\Output::__construct	(	private UIServices	$ui_services,
		private Services	$http,
		private Translator	$translator,
		private Tabs	$tabs,
		private \ilToolbarGUI	$toolbar
	)

Definition at line 51 of file Output.php.

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

Member Function Documentation

error()

ILIAS\GlobalScreen\GUI\Output\Output::error	(	string	$message,
		bool	$keep = true
	)

Definition at line 88 of file Output.php.

                                                             : void
    {
        $this->message('failure', $message, $keep);
    }

References ILIAS\GlobalScreen\GUI\Output\Output\message().

Here is the call graph for this function:

info()

ILIAS\GlobalScreen\GUI\Output\Output::info	(	string	$message,
		bool	$keep = true
	)

Definition at line 83 of file Output.php.

                                                            : void
    {
        $this->message('info', $message, $keep);
    }

References ILIAS\GlobalScreen\GUI\Output\Output\message().

Here is the call graph for this function:

message()

ILIAS\GlobalScreen\GUI\Output\Output::message	(	string	$type,
		string	$message,
		bool	$keep = true
	)

Definition at line 93 of file Output.php.

                                                                             : void
    {
        $this->main_tpl->setOnScreenMessage($type, $message, $keep);
    }

Referenced by ILIAS\GlobalScreen\GUI\Output\Output\error(), ILIAS\GlobalScreen\GUI\Output\Output\info(), and ILIAS\GlobalScreen\GUI\Output\Output\success().

Here is the caller graph for this function:

nok()

ILIAS\GlobalScreen\GUI\Output\Output::nok

(

bool

$as_image = false

)

Definition at line 211 of file Output.php.

                                               : Icon|Image
    {
        if ($as_image) {
            return $this->ui_factory->image()->standard(
                'assets/images/standard/icon_unchecked.svg',
                ''
            );
        }
 
        return $this->ui_factory->symbol()->icon()->custom(
            'assets/images/standard/icon_unchecked.svg',
            '',
            'small'
        );
    }

ok()

ILIAS\GlobalScreen\GUI\Output\Output::ok

(

bool

$as_image = false

)

Definition at line 227 of file Output.php.

                                              : Icon|Image
    {
        if ($as_image) {
            return $this->ui_factory->image()->standard(
                'assets/images/standard/icon_checked.svg',
                ''
            );
        }
 
        return $this->ui_factory->symbol()->icon()->custom(
            'assets/images/standard/icon_checked.svg',
            '',
            'small'
        );
    }

out()

ILIAS\GlobalScreen\GUI\Output\Output::out

(

?Component ...

$components

)

Definition at line 194 of file Output.php.

                                                  : void
    {
        $this->tabs->show();
        $components = array_filter($components, fn(?Component $component): bool => $component !== null);
 
        $this->main_tpl->setContent(
            $this->ui_renderer->render($components)
        );
    }

References $components, and ILIAS\Repository\tabs().

Here is the call graph for this function:

outAsync()

ILIAS\GlobalScreen\GUI\Output\Output::outAsync

(

?Component ...

$components

)

Definition at line 174 of file Output.php.

                                                       : void
    {
        $components = array_filter($components, fn(?Component $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();
    }

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

Here is the call graph for this function:

outAsyncAsConfirmation()

ILIAS\GlobalScreen\GUI\Output\Output::outAsyncAsConfirmation	(	string	$title,
		string	$message,
		string	$button_text,
		URI|string	$post_url,
		InterruptiveItem ...	$components
	)

Definition at line 98 of file Output.php.

     : void {
        if ($post_url instanceof URI) {
            $post_url = (string) $post_url;
        }
        $modal = $this
            ->ui_factory
            ->modal()
            ->interruptive(
                $title,
                $message,
                $post_url
            )
            ->withAffectedItems(
                $components
            )
            ->withActionButtonLabel($button_text);
 
        $this->outAsync($modal);
    }

outAsyncAsModal()

ILIAS\GlobalScreen\GUI\Output\Output::outAsyncAsModal	(	string	$title,
		URI|string	$post_url,
		?Component ...	$components
	)

Definition at line 124 of file Output.php.

     : void {
        if ($post_url instanceof URI) {
            $post_url = (string) $post_url;
        }
 
        $is_form = count($components) === 1 && $components[0] instanceof Form;
        $are_interruptive = array_filter(
            $components,
            fn(?Component $component): bool => $component instanceof InterruptiveItem
        ) !== [];
 
        $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(
                    $components
                ),
            default => $this
                ->ui_factory
                ->modal()
                ->roundtrip(
                    $title,
                    $components,
                    [],
                    $post_url
                )
        };
 
        $this->outAsync($modal);
    }

outString()

ILIAS\GlobalScreen\GUI\Output\Output::outString

(

string

$string

)

Definition at line 188 of file Output.php.

                                             : void
    {
        $this->tabs->show();
        $this->main_tpl->setContent($string);
    }

References ILIAS\Repository\tabs().

Here is the call graph for this function:

render()

ILIAS\GlobalScreen\GUI\Output\Output::render

(

?Component ...

$components

)

Definition at line 204 of file Output.php.

                                                     : string
    {
        $components = array_filter($components, fn(?Component $component): bool => $component !== null);
 
        return $this->ui_renderer->render($components);
    }

References $components.

response()

ILIAS\GlobalScreen\GUI\Output\Output::response

(

)

Definition at line 63 of file Output.php.

                              : ResponseInterface
    {
        return $this->http->response();
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

success()

ILIAS\GlobalScreen\GUI\Output\Output::success	(	string	$message,
		bool	$keep = true
	)

Definition at line 78 of file Output.php.

                                                               : void
    {
        $this->message('success', $message, $keep);
    }

References ILIAS\GlobalScreen\GUI\Output\Output\message().

Here is the call graph for this function:

toolbar()

ILIAS\GlobalScreen\GUI\Output\Output::toolbar

(

)

Definition at line 73 of file Output.php.

                             : \ilToolbarGUI
    {
        return $this->toolbar;
    }

ui()

ILIAS\GlobalScreen\GUI\Output\Output::ui

(

)

Definition at line 68 of file Output.php.

                        : UIServices
    {
        return $this->ui_services;
    }

Field Documentation

$main_tpl

ilGlobalTemplateInterface ILIAS\GlobalScreen\GUI\Output\Output::$main_tpl

private

Definition at line 49 of file Output.php.

$ui_factory

Factory ILIAS\GlobalScreen\GUI\Output\Output::$ui_factory

private

Definition at line 47 of file Output.php.

$ui_renderer

Renderer ILIAS\GlobalScreen\GUI\Output\Output::$ui_renderer

private

Definition at line 48 of file Output.php.

---

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

• components/ILIAS/GlobalScreen/src/GUI/Output/Output.php