ILIAS\UI\examples\Panel\Standard Namespace Reference

Functions
	base_text_block ()
	description: > Example for rendering a standard panel. More...
	with_actions ()
	description: > Example for rendering a standard panel with actions. More...
	with_listings ()
	description: > Example for rendering a standard panel with listings. More...
	with_view_controls ()
	description: > Example for rendering a standard panel with an all view control. More...

Function Documentation

base_text_block()

ILIAS\UI\examples\Panel\Standard\base_text_block

(

)

---

description: > Example for rendering a standard panel.

expected output: >

ILIAS shows a panel with a large title "Panel Title" and a text "Some Content".

Definition at line 32 of file base_text_block.php.

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

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

    $panel = $f->panel()->standard(
        "Panel Title",
        $f->legacy()->content("Some Content")
    );

    return $renderer->render($panel);
}

with_actions()

ILIAS\UI\examples\Panel\Standard\with_actions

(

)

---

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

expected output: > ILIAS shows a base panel but it also includes a menu displayed by

an triangle symbol pointing down. You can open the menu which includes links to ilias.de and GitHub.

Definition at line 33 of file with_actions.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")
    ));

    $panel = $f->panel()->standard(
        "Panel Title",
        $f->legacy()->content("Some Content")
    )->withActions($actions);

    return $renderer->render($panel);
}

with_listings()

ILIAS\UI\examples\Panel\Standard\with_listings

(

)

---

description: > Example for rendering a standard panel with listings.

expected output: >

ILIAS shows a base panel with two lists (numbered and unordered).

Definition at line 32 of file with_listings.php.

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

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

    $content = array(
        $f->listing()->ordered(array("item 1","item 2","item 3")),
        $f->listing()->unordered(array("item 1","item 2","item 3"))
    );

    $panel = $f->panel()->standard("Panel Title", $content);

    return $renderer->render($panel);
}

with_view_controls()

ILIAS\UI\examples\Panel\Standard\with_view_controls

(

)

---

description: > Example for rendering a standard panel with an all view control.

expected output: > ILIAS shows a base panel with some content like sub items, titles etc. Additionally it displayes three view controls

(Sortation, modes and pagination).

Definition at line 33 of file with_view_controls.php.

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

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

    $url = $DIC->http()->request()->getRequestTarget();

    $actions = $f->dropdown()->standard([
        $f->button()->shy("ILIAS", "https://www.ilias.de"),
        $f->button()->shy("GitHub", "https://www.github.com")
    ]);
    $current_sortation = 'abc';
    if ($request_wrapper->has('sort')) {
        $current_sortation = $request_wrapper->retrieve('sort', $refinery->kindlyTo()->string());
    }

    $sortation_options = [
        'abc' => 'Sort by Alphabet',
        'date' => 'Sort by Date',
        'location' => 'Sort by Location'
    ];
    $sortation = $f->viewControl()->sortation($sortation_options, $current_sortation)
                   ->withTargetURL($url, "sort");

    $current_presentation = 'list';
    if ($request_wrapper->has('mode')) {
        $current_presentation = $request_wrapper->retrieve('mode', $refinery->kindlyTo()->string());
    }
    $presentation_options = [
        'list' => 'List View',
        'tile' => 'Tile View'
    ];
    $modes = $f->viewControl()->mode(
        array_reduce(
            array_keys($presentation_options),
            static function ($carry, $item) use ($presentation_options, $url) {
                $carry[$presentation_options[$item]] = "$url&mode=$item";
                return $carry;
            },
            []
        ),
        'Presentation Mode'
    )
               ->withActive($presentation_options[$current_presentation]);

    $current_page = 0;
    if ($request_wrapper->has('page')) {
        $current_page = $request_wrapper->retrieve('page', $refinery->kindlyTo()->int());
    }
    $pagination = $f->viewControl()->pagination()
                    ->withTargetURL($url, "page")
                    ->withTotalEntries(98)
                    ->withPageSize(10)
                    ->withCurrentPage($current_page);

    $view_controls = [
        $sortation,
        $modes,
        $pagination
    ];

    if ($current_presentation === 'list') {
        $item1 = $f->item()->standard("Item Title")
                   ->withActions($actions)
                   ->withProperties([
                       "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."
                   );

        $item2 = $f->item()->standard("Item 2 Title")
                   ->withActions($actions)
                   ->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."
                   );

        $item3 = $f->item()->standard("Item 3 Title")
                   ->withActions($actions)
                   ->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."
                   );
    } else {
        $image = $f->image()->responsive(
            "./assets/images/logo/HeaderIcon.svg",
            "Thumbnail Example"
        );
        $content = $f->listing()->descriptive(
            [
                "Entry 1" => "Some text",
                "Entry 2" => "Some more text",
            ]
        );
        $item1 = $item2 = $item3 = $f->card()->standard("Item Title", $image)
                                     ->withSections([$content]);
    }

    $std_list = $f->panel()->standard("List Title", [
        $f->item()->group("Subtitle 1", [
            $item1,
            $item2
        ]),
        $f->item()->group("Subtitle 2", [
            $item3
        ])
    ])
                  ->withActions($actions)
                  ->withViewControls($view_controls);

    return $renderer->render($std_list);
}