ILIAS\UI\examples\Item\Standard Namespace Reference

Functions
	base ()
	description: > Example for rendering a standard item. More...
	with_audio_player ()
	description: > Example for rendering a standard item with an audio player. More...
	with_image_and_progress ()
	description: > Example for rendering a standard item with an image and displaying the progress. More...
	with_lead_avatar ()
	description: > Example for rendering a standard item with an lead avatar. More...
	with_lead_icon ()
	description: > Example for rendering a standard item with an lead icon. More...
	with_lead_image ()
	description: > Example for rendering a standard item with an lead image. More...
	with_lead_text ()
	description: > Example for rendering a standard item with an lead text. More...
	with_link_title ()
	description: > Example for rendering a standard item with a link title. More...
	with_main_action ()
	description: > Example for rendering a standard item with main actions. More...
	with_main_link_action ()
	description: > Example for rendering a standard item with a main action displayed as a link. More...
	with_progress ()
	description: > Example for rendering a standard item with a progress meter. More...
	with_shy_properties ()
	description: > Example for rendering a standard item with shy properties. More...
	with_shy_title ()
	description: > Example for rendering a standard item with shy titles. More...

Function Documentation

base()

ILIAS\UI\examples\Item\Standard\base

(

)

---

description: > Example for rendering a standard item.

expected output: > ILIAS shows a box including the following informations: A heading "Item Title" with a dummy text in small writings ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update"

and "Location". Additionally a action menu is displayed in the box on the right top.

Definition at line 34 of file base.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $actions = $f->dropdown()->standard(array(
        $f->button()->shy("ILIAS", "https://www.ilias.de"),
        $f->button()->shy("GitHub", "https://www.github.com")
    ));
    $app_item = $f->item()->standard("Item Title")
        ->withActions($actions)
        ->withProperties(array(
            "Origin" => "Course Title 1",
            "Last Update" => "24.11.2011",
            "Location" => "Room 123, Main Street 44, 3012 Bern"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.");
    return $renderer->render($app_item);
}

with_audio_player()

ILIAS\UI\examples\Item\Standard\with_audio_player

(

)

---

description: > Example for rendering a standard item with an audio player.

expected output: > ILIAS shows a box with the following informations: The ILIAS-Logo, "ILIAS Audio" as heading and a dummy text in small writings ("Lorem ipsum...") below. Beneath those you can see a player to play an audio file. Below that player a fine line and more informations about the lengths of the file are displayed. Additionally the box includes an action menu

on the right top.

Definition at line 35 of file with_audio_player.php.

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

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

    $actions = $f->dropdown()->standard(array(
        $f->button()->shy("ILIAS", "https://www.ilias.de"),
        $f->button()->shy("GitHub", "https://www.github.com")
    ));

    $audio = $f->player()->audio("https://files.ilias.de/ILIAS-Audio.mp3", "");

    $app_item = $f->item()->standard("ILIAS Audio")
        ->withActions($actions)
        ->withAudioPlayer($audio)
        ->withProperties(array(
            "Length" => "00:00:26"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.")
        ->withLeadImage($f->image()->responsive(
            "assets/ui-examples/images/Image/HeaderIconLarge.svg",
            "Thumbnail Example"
        ));
    return $renderer->render($app_item);
}

with_image_and_progress()

ILIAS\UI\examples\Item\Standard\with_image_and_progress

(

)

---

description: > Example for rendering a standard item with an image and displaying the progress.

expected output: > ILIAS shows a box including the following informations: A heading "Item Title" with a dummy text in small writings ("Lorem ipsum...") below. On the left side a ILIAS icon is displayed, on the right side you can see a pictorial representation

and also a text (75%) about the progress.

Definition at line 34 of file with_image_and_progress.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $chart = $f->chart()->progressMeter()->standard(100, 75);
    $app_item = $f->item()->standard("Item Title")
                  ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.")
                  ->withProgress($chart)
                  ->withLeadImage($f->image()->responsive(
                      "assets/ui-examples/images/Image/HeaderIconLarge.svg",
                      "Thumbnail Example"
                  ));
    return $renderer->render($app_item);
}

with_lead_avatar()

ILIAS\UI\examples\Item\Standard\with_lead_avatar

(

)

---

description: > Example for rendering a standard item with an lead avatar.

expected output: > ILIAS shows two very similiar boxes including the following informations: A heading with a dummy text in small writings ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Last Login" and "Location". Additionally an action menu is displayed in the box on the right top. On the left side an avatar is

displayed.

Definition at line 35 of file with_lead_avatar.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $actions = $f->dropdown()->standard(array(
        $f->button()->shy("ILIAS", "https://www.ilias.de"),
        $f->button()->shy("GitHub", "https://www.github.com")
    ));
    $app_item1 = $f->item()->standard("Max Mustermann")
        ->withActions($actions)
        ->withProperties(array(
            "Last Login" => "24.11.2011",
            "Location" => "Hamburg"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.")
        ->withLeadAvatar($f->symbol()->avatar()->letter('mm'));
    $app_item2 = $f->item()->standard("Erika Mustermann")
        ->withActions($actions)
        ->withProperties(array(
            "Last Login" => "3.12.2018",
            "Location" => "Berlin"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.")
        ->withLeadAvatar($f->symbol()->avatar()->picture('./assets/images/placeholder/no_photo_xsmall.jpg', 'demo.user'));
    return $renderer->render([$app_item1, $f->divider()->horizontal(), $app_item2]);
}

with_lead_icon()

ILIAS\UI\examples\Item\Standard\with_lead_icon

(

)

---

description: > Example for rendering a standard item with an lead icon.

expected output: > ILIAS shows a box including the following informations: A heading with a dummy text in small writings ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update" and "Location". Additionally a action menu is displayed in the box on the right top. On the left side a "Course" icon

is displayed.

Definition at line 35 of file with_lead_icon.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $actions = $f->dropdown()->standard(array(
        $f->button()->shy("ILIAS", "https://www.ilias.de"),
        $f->button()->shy("GitHub", "https://www.github.com")
    ));
    $app_item = $f->item()->standard("ILIAS Course")
        ->withActions($actions)
        ->withProperties(array(
            "Origin" => "Course Title 1",
            "Last Update" => "24.11.2011",
            "Location" => "Room 123, Main Street 44, 3012 Bern"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.")
        ->withLeadIcon($f->symbol()->icon()->standard('crs', 'Course', 'medium'));
    return $renderer->render($app_item);
}

with_lead_image()

ILIAS\UI\examples\Item\Standard\with_lead_image

(

)

---

description: > Example for rendering a standard item with an lead image.

expected output: > ILIAS shows a box including the following informations: A heading with a dummy text in small writings ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update" and "Location". Additionally a action menu is displayed in the box on the right top. On the left side a ILIAS-Logo

is displayed.

Definition at line 34 of file with_lead_image.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $actions = $f->dropdown()->standard(array(
        $f->button()->shy("ILIAS", "https://www.ilias.de"),
        $f->button()->shy("GitHub", "https://www.github.com")
    ));
    $app_item = $f->item()->standard("ILIAS Course")
        ->withActions($actions)
        ->withProperties(array(
            "Origin" => "Course Title 1",
            "Last Update" => "24.11.2011",
            "Location" => "Room 123, Main Street 44, 3012 Bern"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.")
        ->withLeadImage($f->image()->responsive(
            "assets/ui-examples/images/Image/HeaderIconLarge.svg",
            "Thumbnail Example"
        ));
    return $renderer->render($app_item);
}

with_lead_text()

ILIAS\UI\examples\Item\Standard\with_lead_text

(

)

---

description: > Example for rendering a standard item with an lead text.

expected output: > ILIAS shows a box including the following informations: A heading with a dummy text in small writings ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update" and "Location". Additionally a action menu is displayed in the box on the right top. On the left side a period of time

(11:20-12:40) is displayed.

Definition at line 35 of file with_lead_text.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $actions = $f->dropdown()->standard(array(
        $f->button()->shy("ILIAS", "https://www.ilias.de"),
        $f->button()->shy("GitHub", "https://www.github.com")
    ));
    $app_item = $f->item()->standard("Weekly Meeting")
        ->withActions($actions)
        ->withProperties(array(
            "Origin" => "Course Title 1",
            "Last Update" => "24.11.2011",
            "Location" => "Room 123, Main Street 44, 3012 Bern"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.")
        ->withLeadText("11:20 - 12:40");
    return $renderer->render($app_item);
}

with_link_title()

ILIAS\UI\examples\Item\Standard\with_link_title

(

)

---

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

expected output: > ILIAS shows a box including the following informations: A title with a dummy text in small writings ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Code Repo" and

"Location". The title is rendered as a link and redirects to ilias.de.

Definition at line 34 of file with_link_title.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $app_item = $f->item()->standard($f->link()->standard("ILIAS", "https://www.ilias.de"))
        ->withProperties(array(
            "Code Repo" => $f->button()->shy("ILIAS on GitHub", "https://www.github.com/ILIAS-eLearning/ILIAS"),
            "Location" => "Room 123, Main Street 44, 3012 Bern"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.");
    return $renderer->render($app_item);
}

with_main_action()

ILIAS\UI\examples\Item\Standard\with_main_action

(

)

---

description: > Example for rendering a standard item with main actions.

expected output: > ILIAS shows a box including the following informations: A heading with a dummy text in small writings ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update" and "Location". Additionally a action menu is displayed in the box on the right top. On the left next to the action

menu a "Edit" button ist rendered.

Definition at line 35 of file with_main_action.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $actions = $f->dropdown()->standard(array(
        $f->button()->shy("ILIAS", "https://www.ilias.de"),
        $f->button()->shy("GitHub", "https://www.github.com")
    ));
    $main_action = $f->button()->standard("Edit", "#");
    $app_item = $f->item()->standard("Item Title")
        ->withActions($actions)
        ->withMainAction($main_action)
        ->withProperties(array(
            "Origin" => "Course Title 1",
            "Last Update" => "24.11.2011",
            "Location" => "Room 123, Main Street 44, 3012 Bern"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.");
    return $renderer->render($app_item);
}

with_main_link_action()

ILIAS\UI\examples\Item\Standard\with_main_link_action

(

)

---

description: > Example for rendering a standard item with a main action displayed as a link.

expected output: > ILIAS shows a box including the following informations: A heading with a dummy text in small writings ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update"

and "Location". Additionally a link titled "Open ILIAS" is rendered on the right top side of the box.

Definition at line 34 of file with_main_link_action.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $main_action = $f->link()->standard("Open ILIAS", "https://www.ilias.de");
    $app_item = $f->item()->standard("Item Title")
        ->withMainAction($main_action)
        ->withProperties(array(
            "Origin" => "Course Title 1",
            "Last Update" => "24.11.2011",
            "Location" => "Room 123, Main Street 44, 3012 Bern"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.");
    return $renderer->render($app_item);
}

with_progress()

ILIAS\UI\examples\Item\Standard\with_progress

(

)

---

description: > Example for rendering a standard item with a progress meter.

expected output: > ILIAS shows a box including the following informations: A heading with a dummy text in small writings

("Lorem ipsum...") below. Additionally a progress meter (75%) is rendered on the right top side of the box.

Definition at line 33 of file with_progress.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $chart = $f->chart()->progressMeter()->standard(100, 75);
    $app_item = $f->item()->standard("Item Title")
                  ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.")
                  ->withProgress($chart);
    return $renderer->render($app_item);
}

with_shy_properties()

ILIAS\UI\examples\Item\Standard\with_shy_properties

(

)

---

description: > Example for rendering a standard item with shy properties.

expected output: > ILIAS shows a box including the following informations: A heading with a dummy text in small writings ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "LMS", "Code Repo"

and "Location". Properties of "LMS" ("ILIAS") an "Code Repo" ("GitHub") are rendered as shy buttons and are functioning as links.

Definition at line 34 of file with_shy_properties.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $app_item = $f->item()->standard("Item Title")
        ->withProperties(array(
            "LMS" => $f->button()->shy("ILIAS", "https://www.ilias.de"),
            "Code Repo" => $f->button()->shy("GitHub", "https://www.github.com"),
            "Location" => "Room 123, Main Street 44, 3012 Bern"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.");
    return $renderer->render($app_item);
}

with_shy_title()

ILIAS\UI\examples\Item\Standard\with_shy_title

(

)

---

description: > Example for rendering a standard item with shy titles.

expected output: > ILIAS shows a box including the following informations: A heading with a dummy text in small writings ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Code Repo"

and "Location". "Code Repo" ("ILIAS") is rendered as shy link.

Definition at line 34 of file with_shy_title.php.

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

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $app_item = $f->item()->standard($f->button()->shy("ILIAS", "https://www.ilias.de"))
        ->withProperties(array(
            "Code Repo" => $f->button()->shy("GitHub", "https://www.github.com"),
            "Location" => "Room 123, Main Street 44, 3012 Bern"))
        ->withDescription("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.");
    return $renderer->render($app_item);
}