ILIAS\UI\examples\Modal\RoundTrip Namespace Reference

Functions
	show_form_in_modal ()
	description: > Example for rendering a round trip modal. More...
	show_multi_step_modal ()
	description: > Example for rendering a round trip multi-step modal. More...
	show_the_same_modal_with_different_buttons ()
	description: > Example for rendering a round trip modal with different buttons. More...
	with_custom_labels ()
	description: > An example showing how you can set a custom label for the modals cancel-button. More...

Function Documentation

show_form_in_modal()

ILIAS\UI\examples\Modal\RoundTrip\show_form_in_modal

(

)

---

description: > Example for rendering a round trip modal.

expected output: > ILIAS shows a button titled "open modal". A click onto the button opens the modal including a formular "some text"

and "some number". The entered content will be displayed above the button after hitting "Save".

Definition at line 33 of file show_form_in_modal.php.

References $data, $DIC, $renderer, and null.

{
    global $DIC;

    $renderer = $DIC->ui()->renderer();
    $request = $DIC->http()->request();
    $factory = $DIC->ui()->factory();

    // declare roundtrip with inputs and form action.
    $modal = $factory->modal()->roundtrip(
        'roundtrip with form',
        null,
        [
            $factory->input()->field()->text('some text'),
            $factory->input()->field()->numeric('some numbere'),
        ],
        '#'
    );

    // declare something that triggers the modal.
    $open = $factory->button()->standard('open modal', '#')->withOnClick($modal->getShowSignal());

    // please use ilCtrl to generate an appropriate link target
    // and check it's command instead of this.
    if ('POST' === $request->getMethod()) {
        $modal = $modal->withRequest($request);
        $data = $modal->getData();
    } else {
        $data = 'no results yet.';
    }

    return
        '<pre>' . print_r($data, true) . '</pre>' .
        $renderer->render([$open, $modal]);
}

show_multi_step_modal()

ILIAS\UI\examples\Modal\RoundTrip\show_multi_step_modal

(

)

---

description: > Example for rendering a round trip multi-step modal.

expected output: > ILIAS shows a button titled "Signin". A click onto the button will open a modal with two buttons "Login" and "Registration". Depending on the button a click will switch betweeen the "Login Page" and "Registration Page"

within the modal.

Definition at line 36 of file show_multi_step_modal.php.

References $_SERVER, $DIC, Vendor\Package\$f, $r, ILIAS\UI\examples\Layout\Page\Standard\$refinery, ILIAS\UI\examples\Layout\Page\Standard\$request_wrapper, $url, exit, and null.

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $r = $DIC->ui()->renderer();
    $refinery = $DIC->refinery();
    $request_wrapper = $DIC->http()->wrapper()->query();

    $url = $_SERVER['REQUEST_URI'];

    $page = "";
    if ($request_wrapper->has('page')) {
        $page = $request_wrapper->retrieve('page', $refinery->kindlyTo()->string());
    }
    if ($page == "") {
        $modal = $f->modal()->roundtrip("Modal Title", $f->legacy()->content("b"));
        $asyncUrl = $url . '&page=login&replaceSignal=' . $modal->getReplaceSignal()->getId();
        $modal = $modal->withAsyncRenderUrl($asyncUrl);
        $button = $f->button()->standard("Sign In", '#')
            ->withOnClick($modal->getShowSignal());
        return $r->render([$modal, $button]);
    } else {
        $signalId = "";
        if ($request_wrapper->has('replaceSignal')) {
            $signalId = $request_wrapper->retrieve('replaceSignal', $refinery->kindlyTo()->string());
        }
        $replaceSignal = new ReplaceSignal($signalId);
        $button1 = $f->button()->standard('Login', '#')
            ->withOnClick($replaceSignal->withAsyncRenderUrl($url . '&page=login&replaceSignal=' . $replaceSignal->getId()));
        $button2 = $f->button()->standard('Registration', '#')
            ->withOnClick($replaceSignal->withAsyncRenderUrl($url . '&page=register&replaceSignal=' . $replaceSignal->getId()));

        $modal = null;
        if ($page == "login") {
            $legacy = $f->legacy()->content("<p>The Login Page</p>");
            $modal = $f->modal()->roundtrip("Login", [$legacy])->withActionButtons([$button1, $button2]);
        }
        if ($page == "register") {
            $legacy = $f->legacy()->content("<p>The Registration Page</p>");
            $modal = $f->modal()->roundtrip("Registration", [$legacy])->withActionButtons([$button1, $button2]);
        }

        echo $r->renderAsync([$modal]);
        exit;
    }
}

show_the_same_modal_with_different_buttons()

ILIAS\UI\examples\Modal\RoundTrip\show_the_same_modal_with_different_buttons

(

)

---

description: > Example for rendering a round trip modal with different buttons.

expected output: > ILIAS shows three buttons with different titles. After clicking one of the first two buttonns a modal with primary

and secondary buttons is opened. Both buttons do not have any functions.

Definition at line 33 of file show_the_same_modal_with_different_buttons.php.

References $DIC, $out, and $renderer.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();

    $modal = $factory->modal()->roundtrip('My Modal 1', $factory->legacy()->content('My Content'))
        ->withActionButtons([
            $factory->button()->primary('Primary Action', ''),
            $factory->button()->standard('Secondary Action', ''),
        ]);

    $out = '';
    $button1 = $factory->button()->standard('Open Modal 1', '#')
        ->withOnClick($modal->getShowSignal());
    $out .= ' ' . $renderer->render($button1);

    $button2 = $button1->withLabel('Also opens modal 1');
    $out .= ' ' . $renderer->render($button2);

    $button3 = $button2->withLabel('Does not open modal 1')
        ->withResetTriggeredSignals();
    $out .= ' ' . $renderer->render($button3);

    return $out . $renderer->render($modal);
}

with_custom_labels()

ILIAS\UI\examples\Modal\RoundTrip\with_custom_labels

(

)

---

description: > An example showing how you can set a custom label for the modals cancel-button.

expected output: > ILIAS shows a button titled "I will show you something". A click onto the button will open a modal including the two

buttons with custom labels.

Definition at line 34 of file with_custom_labels.php.

References $DIC, and $renderer.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();

    $modal = $factory->modal()->roundtrip(
        'Showing something off',
        [
            $factory->messageBox()->info('I am something.'),
        ]
    )->withCancelButtonLabel(
        'Thank you and goodbye'
    )->withActionButtons([$factory->button()->standard('Nothing todo here', '#')]);

    $trigger = $factory->button()->standard('I will show you something', $modal->getShowSignal());

    return $renderer->render([$modal, $trigger]);
}