ILIAS\UI\examples\Toast\Standard Namespace Reference

Functions
	base ()
	description: > Example for rendering a standard toast. More...
	with_action ()
	description: > Example for rendering a standard toast with actions. More...
	with_additional_links ()
	description: > Example for rendering a standard toast with additional links. More...
	with_description ()
	description: > Example for rendering a standard toast including a description. More...
	with_link_title ()
	description: > Example for rendering a standard toast with a link title. More...
	with_long_description ()
	description: > Example for rendering a standard toast including a long description. More...

Function Documentation

base()

ILIAS\UI\examples\Toast\Standard\base

(

)

---

description: > Example for rendering a standard toast.

expected output: > ILIAS shows a blue button "Show". Clicking onto the button opens a message "Example" on the right top edge which

disappears after a few seconds.

Definition at line 33 of file base.php.

References $DIC, and $id.

               : string
{
    global $DIC;
    $tc = $DIC->ui()->factory()->toast()->container();

    $toasts = [
        $DIC->ui()->factory()->toast()->standard(
            'Example',
            $DIC->ui()->factory()->symbol()->icon()->standard('info', 'Test')
        )
    ];

    $toasts = base64_encode($DIC->ui()->renderer()->renderAsync($toasts));
    $button = $DIC->ui()->factory()->button()->standard($DIC->language()->txt('show'), '');
    $button = $button->withAdditionalOnLoadCode(function ($id) use ($toasts) {
        return "$id.addEventListener('click', () => {
            $id.parentNode.querySelector('.il-toast-container').innerHTML = atob('$toasts');
            $id.parentNode.querySelector('.il-toast-container').querySelectorAll('script').forEach(element => {
                let newScript = document.createElement('script');
                newScript.innerHTML = element.innerHTML;
                element.parentNode.appendChild(newScript);
            })
        });";
    });

    return $DIC->ui()->renderer()->render([$button,$tc]);
}

with_action()

ILIAS\UI\examples\Toast\Standard\with_action

(

)

---

description: > Example for rendering a standard toast with actions.

expected output: > ILIAS shows a blue button "Show". Clicking onto the button opens a message "Example" on the right top edge which

disappears after a few seconds.

Definition at line 33 of file with_action.php.

References $DIC, $id, and ILIAS\GlobalScreen\Scope\Footer\Factory\withAction().

                      : string
{
    global $DIC;
    $tc = $DIC->ui()->factory()->toast()->container();

    $toasts = [
        $DIC->ui()->factory()->toast()->standard(
            'Example',
            $DIC->ui()->factory()->symbol()->icon()->standard('info', 'Test')
        )->withAction('https://www.ilias.de')
    ];

    $toasts = base64_encode($DIC->ui()->renderer()->renderAsync($toasts));
    $button = $DIC->ui()->factory()->button()->standard($DIC->language()->txt('show'), '');
    $button = $button->withAdditionalOnLoadCode(function ($id) use ($toasts) {
        return "$id.addEventListener('click', () => {
            $id.parentNode.querySelector('.il-toast-container').innerHTML = atob('$toasts');
            $id.parentNode.querySelector('.il-toast-container').querySelectorAll('script').forEach(element => {
                let newScript = document.createElement('script');
                newScript.innerHTML = element.innerHTML;
                element.parentNode.appendChild(newScript);
            })
        });";
    });

    return $DIC->ui()->renderer()->render([$button,$tc]);
}

Here is the call graph for this function:

with_additional_links()

ILIAS\UI\examples\Toast\Standard\with_additional_links

(

)

---

description: > Example for rendering a standard toast with additional links.

expected output: > ILIAS shows a blue button "Show". Clicking onto the button opens a message "Example" on the right top edge including

two links which open a page each.

Definition at line 33 of file with_additional_links.php.

References $DIC, and $id.

                                : string
{
    global $DIC;
    $tc = $DIC->ui()->factory()->toast()->container();

    $toasts = [
        $DIC->ui()->factory()->toast()->standard(
            'Example',
            $DIC->ui()->factory()->symbol()->icon()->standard('info', 'Example')
        )
            ->withAdditionalLink($DIC->ui()->factory()->link()->standard('ILIAS', 'https://www.ilias.de'))
            ->withAdditionalLink($DIC->ui()->factory()->link()->standard('GitHub', 'https://www.github.com'))
    ];

    $toasts = base64_encode($DIC->ui()->renderer()->renderAsync($toasts));
    $button = $DIC->ui()->factory()->button()->standard($DIC->language()->txt('show'), '');
    $button = $button->withAdditionalOnLoadCode(function ($id) use ($toasts) {
        return "$id.addEventListener('click', () => {
            $id.parentNode.querySelector('.il-toast-container').innerHTML = atob('$toasts');
            $id.parentNode.querySelector('.il-toast-container').querySelectorAll('script').forEach(element => {
                let newScript = document.createElement('script');
                newScript.innerHTML = element.innerHTML;
                element.parentNode.appendChild(newScript);
            })
        });";
    });

    return $DIC->ui()->renderer()->render([$button,$tc]);
}

with_description()

ILIAS\UI\examples\Toast\Standard\with_description

(

)

---

description: > Example for rendering a standard toast including a description.

expected output: > ILIAS shows a blue button "Show". Clicking onto the button opens a message "Example" including a description on the

right top edge and which disappears after a few seconds.

Definition at line 33 of file with_description.php.

References $DIC, and $id.

                           : string
{
    global $DIC;
    $tc = $DIC->ui()->factory()->toast()->container();

    $toasts = [
        $DIC->ui()->factory()->toast()->standard(
            'Example',
            $DIC->ui()->factory()->symbol()->icon()->standard('info', 'Test')
        )->withDescription('This is an example description.')
    ];

    $toasts = base64_encode($DIC->ui()->renderer()->renderAsync($toasts));
    $button = $DIC->ui()->factory()->button()->standard($DIC->language()->txt('show'), '');
    $button = $button->withAdditionalOnLoadCode(function ($id) use ($toasts) {
        return "$id.addEventListener('click', () => {
            $id.parentNode.querySelector('.il-toast-container').innerHTML = atob('$toasts');
            $id.parentNode.querySelector('.il-toast-container').querySelectorAll('script').forEach(element => {
                let newScript = document.createElement('script');
                newScript.innerHTML = element.innerHTML;
                element.parentNode.appendChild(newScript);
            })
        });";
    });

    return $DIC->ui()->renderer()->render([$button,$tc]);
}

with_link_title()

ILIAS\UI\examples\Toast\Standard\with_link_title

(

)

---

description: > Example for rendering a standard toast with a link title.

expected output: > ILIAS shows a blue button "Show". Clicking onto the button opens a message "Example" on the right top edge which

disappears after a few seconds. The message box's title is rendered as link.

Definition at line 33 of file with_link_title.php.

References $DIC, and $id.

                          : string
{
    global $DIC;
    $tc = $DIC->ui()->factory()->toast()->container();

    $toasts = [
        $DIC->ui()->factory()->toast()->standard(
            $DIC->ui()->factory()->link()->standard('Example', 'https://www.ilias.de'),
            $DIC->ui()->factory()->symbol()->icon()->standard('info', 'Test')
        )
    ];

    $toasts = base64_encode($DIC->ui()->renderer()->renderAsync($toasts));
    $button = $DIC->ui()->factory()->button()->standard($DIC->language()->txt('show'), '');
    $button = $button->withAdditionalOnLoadCode(function ($id) use ($toasts) {
        return "$id.addEventListener('click', () => {
            $id.parentNode.querySelector('.il-toast-container').innerHTML = atob('$toasts');
            $id.parentNode.querySelector('.il-toast-container').querySelectorAll('script').forEach(element => {
                let newScript = document.createElement('script');
                newScript.innerHTML = element.innerHTML;
                element.parentNode.appendChild(newScript);
            })
        });";
    });

    return $DIC->ui()->renderer()->render([$button,$tc]);
}

with_long_description()

ILIAS\UI\examples\Toast\Standard\with_long_description

(

)

---

description: > Example for rendering a standard toast including a long description.

expected output: > ILIAS shows a blue button "Show". Clicking onto the button opens a message "Example" including a long description on

the right top edge which disappears after a few seconds.

Definition at line 33 of file with_long_description.php.

References $DIC, and $id.

                                : string
{
    global $DIC;
    $tc = $DIC->ui()->factory()->toast()->container();

    $toasts = [
        $DIC->ui()->factory()->toast()->standard(
            'Example',
            $DIC->ui()->factory()->symbol()->icon()->standard('info', 'Test')
        )->withDescription(
            'This is an example description which is very long to provide a representative view of the object when it has ' .
            'to occupy enough space to show a very long toast. This may not be the favorable way of displaying a toast, ' .
            'since toast are assumed to be readable in a short time due to the temporary visibility, therefore they only ' .
            'should contain short description which can be read within seconds. But even if this long description softly ' .
            'violates the concepts of toast itself due to its long character it still provides a good view on the ' .
            'scalability of the object and could therefore be called to proof its responsivity which confirms its benefit ' .
            'as an example in spite of its unnatural form and missing usecase for productive systems'
        )
    ];

    $toasts = base64_encode($DIC->ui()->renderer()->renderAsync($toasts));
    $button = $DIC->ui()->factory()->button()->standard($DIC->language()->txt('show'), '');
    $button = $button->withAdditionalOnLoadCode(function ($id) use ($toasts) {
        return "$id.addEventListener('click', () => {
            $id.parentNode.querySelector('.il-toast-container').innerHTML = atob('$toasts');
            $id.parentNode.querySelector('.il-toast-container').querySelectorAll('script').forEach(element => {
                let newScript = document.createElement('script');
                newScript.innerHTML = element.innerHTML;
                element.parentNode.appendChild(newScript);
            })
        });";
    });

    return $DIC->ui()->renderer()->render([$button,$tc]);
}