Functions
	base ()

	show_modal_on_button_click ()

	show_modal_on_button_click_async_rendered ()

	with_custom_labels ()

Function Documentation

◆ base()

ILIAS\UI\examples\Modal\Interruptive\base ( )

description: > Example for rendering an interruptive modal.

expected output: >

ILIAS shows no example because the modal is not called. This behaviour is expected.

Definition at line 32 of file base.php.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $message = 'Are you sure you want to delete the following items?';
    $form_action = $DIC->ctrl()->getFormActionByClass('ilsystemstyledocumentationgui');
    $modal = $factory->modal()->interruptive('My Title', $message, $form_action);
 
    // Note: This modal is just rendered in the DOM but not displayed
    // because its show/close signals are not triggered by any components
    return $renderer->render($modal);
}

References ILIAS\UI\examples\Layout\Page\Mail\$DIC, and $renderer.

◆ show_modal_on_button_click()

ILIAS\UI\examples\Modal\Interruptive\show_modal_on_button_click ( )

description: > Example for rendering a interruptive modal on a click onto a button.

expected output: > Clicking "Show Modal" opens up a modal with some content. A click onto "Delete" will reload the page and displays a confirmation below the example.

A click onto "Cancel" or Close Glyph will hide the modal.

Definition at line 34 of file show_modal_on_button_click.php.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $refinery = $DIC->refinery();
    $request_wrapper = $DIC->http()->wrapper()->query();
    $post_wrapper = $DIC->http()->wrapper()->post();
    $ctrl = $DIC->ctrl();
 
    $message = 'Are you sure you want to delete the following items?';
    $ctrl->setParameterByClass('ilsystemstyledocumentationgui', 'modal_nr', 1);
    $form_action = $ctrl->getFormActionByClass('ilsystemstyledocumentationgui');
    $icon = $factory->image()->standard('./assets/images/standard/icon_crs.svg', '');
 
    $items = [
        $factory->modal()->interruptiveItem()->standard('10', 'Course 1', $icon, 'Some description text'),
        $factory->modal()->interruptiveItem()->keyValue('20', 'Item Key', 'item value'),
        $factory->modal()->interruptiveItem()->standard('30', 'Course 3', $icon, 'Last but not least, a description'),
        $factory->modal()->interruptiveItem()->keyValue('50', 'Second Item Key', 'another item value'),
    ];
    $modal = $factory->modal()->interruptive('My Title', $message, $form_action)->withAffectedItems($items);
    $button = $factory->button()->standard('Show Modal', '')
        ->withOnClick($modal->getShowSignal());
 
    $out = [$button, $modal];
 
    // Display POST data of affected items in a panel
    if (
        $post_wrapper->has('interruptive_items') &&
        $request_wrapper->retrieve('modal_nr', $refinery->kindlyTo()->string()) === '1'
    ) {
        $out[] = $post_wrapper->retrieve('interruptive_items', $refinery->custom()->transformation(
            function ($item_keys) use ($factory, $post_wrapper) {
                return $factory->panel()->standard('Items deleted', $factory->legacy("Number of items deleted: ".count($item_keys)));
            }
        ));
    }
 
    return $renderer->render($out);
}

References $DIC, $out, ILIAS\UI\examples\Layout\Page\Mail\$refinery, $renderer, ILIAS\UI\examples\Layout\Page\Mail\$request_wrapper, and ILIAS\UI\examples\MainControls\Slate\Notification\standard().

Here is the call graph for this function:

◆ show_modal_on_button_click_async_rendered()

ILIAS\UI\examples\Modal\Interruptive\show_modal_on_button_click_async_rendered ( )

description: > Example for rendering an interruptive modal by clicking a button. In the background an asynchronous action is running.

expected output: >

ILIAS shows three buttons. A click onto the buttons will open a modal each.

Definition at line 32 of file show_modal_on_button_click_async_rendered.php.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $refinery = $DIC->refinery();
    $request_wrapper = $DIC->http()->wrapper()->query();
    $post_wrapper = $DIC->http()->wrapper()->post();
    $ctrl = $DIC->ctrl();
 
    $message = 'Are you sure you want to delete the following item?';
    $ctrl->setParameterByClass('ilsystemstyledocumentationgui', 'modal_nr', "2");
    $form_action = $ctrl->getFormActionByClass('ilsystemstyledocumentationgui');
    $items = ['First Item', 'Second Item', 'Third Item'];
 
    // Check if this is the ajax request to deliver the new modal showing the affected item
    if ($request_wrapper->has('item')) {
        $id = $request_wrapper->retrieve('item', $refinery->kindlyTo()->string());
        $item = $items[$id];
        $affected_item = $factory->modal()->interruptiveItem()->standard($id, $item);
        $modal = $factory->modal()->interruptive('Delete Items', $message, $form_action)
            ->withAffectedItems([$affected_item]);
        echo $renderer->render($modal);
        exit();
    }
 
    // Create a button per item
    $out = [];
    foreach ($items as $i => $item) {
        $ajax_url = $_SERVER['REQUEST_URI'] . '&item=' . $i;
        $modal = $factory->modal()->interruptive('', '', '')
            ->withAsyncRenderUrl($ajax_url);
        $button = $factory->button()->standard('Delete ' . $item, '#')
            ->withOnClick($modal->getShowSignal());
        $out[] = $button;
        $out[] = $modal;
    }
 
    // Display POST data of affected items in a panel
    if (
        $post_wrapper->has('interruptive_items') &&
        $request_wrapper->has('modal_nr') && $request_wrapper->retrieve('modal_nr', $refinery->kindlyTo()->string()) === '2'
    ) {
        $out[] = $post_wrapper->retrieve('interruptive_items', $refinery->custom()->transformation(
            function ($v) use ($factory, $post_wrapper, $items) {
                return $factory->panel()->standard('Affected Item', $factory->legacy()->content($items[$v[0]]));
            }
        ));
    }
 
    return $renderer->render($out);
}

References $_SERVER, $DIC, $id, $out, ILIAS\UI\examples\Layout\Page\Mail\$refinery, $renderer, ILIAS\UI\examples\Layout\Page\Mail\$request_wrapper, exit, and ILIAS\UI\examples\MainControls\Slate\Notification\standard().

Here is the call graph for this function:

◆ with_custom_labels()

ILIAS\UI\examples\Modal\Interruptive\with_custom_labels ( )

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

expected output: > ILIAS shows a button titled "I will interrupt you". Clicking the button opens a modal with some content including

two buttons which labels were customized.

Definition at line 34 of file with_custom_labels.php.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $modal = $factory->modal()->interruptive(
        'Interrupting something',
        'Am I interrupting you?',
        '#'
    )->withActionButtonLabel(
        'Yeah you do!'
    )->withCancelButtonLabel(
        'Nah, not really'
    );
 
    $trigger = $factory->button()->standard('I will interrupt you', $modal->getShowSignal());
 
    return $renderer->render([$modal, $trigger]);
}

References $DIC, and $renderer.

Functions