Functions
	base ()

	closable ()

	include_aggregates ()

Function Documentation

◆ base()

ILIAS\UI\examples\Item\Notification\base ( )

description: > Example for rendering a notification item.

expected output: > ILIAS shows a box titled "Inbox" on a white background and including following text: "You have 23 unread mails in <h2>your inbox". A dashed line and a time indication (Time 3 days ago) are displayed below.

Definition at line 33 of file base.php.

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Creating a Mail Notification Item
    $mail_icon = $f->symbol()->icon()->standard("mail", "mail");
    $mail_title = $f->link()->standard("Inbox", "#");
    $mail_notification_item = $f->item()->notification($mail_title, $mail_icon)
                                ->withDescription("You have 23 unread mails in your inbox")
                                ->withProperties(["Time" => "3 days ago"]);
 
 
    return $renderer->render($mail_notification_item);
}

References $DIC, Vendor\Package\$f, and $renderer.

◆ closable()

ILIAS\UI\examples\Item\Notification\closable ( )

description: > Example for rendering a closable notification item.

expected output: > ILIAS shows a box titled "Inbox" on a white background and including following text: "You have 23 unread mails in your inbox". A dashed line and a time indication (Time 3 days ago) are displayed below. Additionally a "X" is rendered

on the right side of the box. Clicking the "X" will close the box.

Definition at line 34 of file closable.php.

{
    global $DIC;
    $refinery = $DIC->refinery();
    $request_wrapper = $DIC->http()->wrapper()->query();
 
    $close_url = $_SERVER['REQUEST_URI'] . '&mail_closed=true';
 
    //If closed, an ajax request is fired to the set close_url
    if ($request_wrapper->has('mail_closed') && $request_wrapper->retrieve('mail_closed', $refinery->kindlyTo()->bool())) {
        //Do Some Magic needed to be done, when this item is closed.
        exit;
    }
 
    //Creating a closable Mail Notification Item
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $mail_icon = $f->symbol()->icon()->standard("mail", "mail");
    $mail_title = $f->link()->standard("Inbox", "#");
    $mail_notification_item = $f->item()->notification($mail_title, $mail_icon)
                                ->withDescription("You have 23 unread mails in your inbox")
                                ->withProperties(["Time" => "3 days ago"])
                                ->withCloseAction($close_url);
 
 
    return $renderer->render($mail_notification_item);
}

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

◆ include_aggregates()

ILIAS\UI\examples\Item\Notification\include_aggregates ( )

description: > Example for rendering a notificication item including aggregates.

expected output: > ILIAS shows a box titled "Item" on a white background and following text: "Notification Item with Aggregates". Clicking the item's heading will collapse another field with the same content. On the right side an "X" for closing the boxes is displayed. Additionally you can see two dropdown fields on the right side including two entries each.

On the top the heading "<Back" is displayed. Clicking "Back" will fold up the boxes.

Definition at line 35 of file include_aggregates.php.

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $refinery = $DIC->refinery();
    $request_wrapper = $DIC->http()->wrapper()->query();
 
    $close_url = $_SERVER['REQUEST_URI'] . '&aggregate_closed=true';
 
    //If closed, an ajax request is fired to the set close_url
    if (
        $request_wrapper->has('aggregate_closed') &&
        $request_wrapper->retrieve('aggregate_closed', $refinery->kindlyTo()->bool())
    ) {
        //Do Some Magic needed to be done, when this item is closed.
        exit;
    }
 
    //Some generic notification Items
    $generic_icon1 = $f->symbol()->icon()->standard("cal", "generic");
    $generic_title1 = $f->link()->standard("Aggregate of Item", "#");
    $generic_item1 = $f->item()->notification($generic_title1, $generic_icon1)
                                       ->withDescription("Is shown when top item is clicked")
                                       ->withProperties(["Property 1" => "Content 1", "Property 2" => "Content 2"])
                                       ->withActions(
                                           $f->dropdown()->standard([
                                               $f->button()->shy("Link to ilias.de", "https://www.ilias.de"),
                                               $f->button()->shy("Link to github", "https://www.github.com")
                                           ])
                                       )
                                        ->withCloseAction($close_url);
 
    $generic_title2 = $f->link()->standard("Item", "just_opens_the_list_of_aggregates");
    $generic_item2 = $f->item()->notification($generic_title2, $generic_icon1)
                       ->withDescription("Notification Item with Aggregates")
                       ->withProperties(["Property 1" => "Content 1", "Property 2" => "Content 2"])
                       ->withAggregateNotifications([$generic_item1, $generic_item1]);
 
 
    return $renderer->render($generic_item2);
}