ILIAS\UI\examples\ViewControl\Section Namespace Reference

Functions
	base ()
	description: > Example performing a page reload if switching between sections of some data. More...

Function Documentation

base()

ILIAS\UI\examples\ViewControl\Section\base

(

)

---

description: > Example performing a page reload if switching between sections of some data.

expected output: > ILIAS shows three controls next to each other: A "Back" glyph, a label "Engaged Section" and a "Next" glyph. Clicking "Engaged Section" will reload the website. Clicking the other two controls will result in the button in the middle being disenganged and showing the label "Go to Engaged Section (Current Section: 1)". The counter increases with each click onto the "Next" glyph and decreases with each click onto the "Back" glyph. Clicking the button in the middle

with the "Goto..." label will revert the buttons to the original status.

Definition at line 36 of file base.php.

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

{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $refinery = $DIC->refinery();
    $request_wrapper = $DIC->http()->wrapper()->query();

    //Some Target magic to get a behaviour closer to some real use case
    $target = $DIC->http()->request()->getRequestTarget();
    $param = "Section";
    $active = 0;
    if ($request_wrapper->has($param) && $request_wrapper->retrieve($param, $refinery->kindlyTo()->int())) {
        $active = $request_wrapper->retrieve($param, $refinery->kindlyTo()->int());
    }

    //Here the real magic to draw the controls
    $back = $f->button()->standard("Back", "$target&$param=" . ($active - 1));
    $next = $f->button()->standard("Next" . " " . ($active - 1), "$target&$param=" . ($active + 1));
    $middle = $f->button()->standard("Go to Engaged Section (Current Section: $active)", "$target&$param=0");
    //Note that the if the middle button needs to be engaged by the surrounding component, as so, if need to be drawn
    //as engaged. This can e.g. be the case for rendering a button labeled "Today" or similar.
    if ($active == 0) {
        $middle = $middle->withLabel("Engaged Section")->withEngagedState(true);
    }
    $view_control_section = $f->viewControl()->section($back, $middle, $next);
    $html = $renderer->render($view_control_section);
    return $html;
}