ILIAS\UI\examples\MainControls\ModeInfo Namespace Reference

Functions
	modeinfo ()
	expected output: > ILIAS shows a button "See UI in fullscreen-mode". More...
if($request_wrapper->has('new_mode_info') && $request_wrapper->retrieve('new_mode_info', $refinery->kindlyTo() ->int())===MODE_INFO_ACTIVE)	renderModeInfoFullscreenMode (\ILIAS\DI\Container $dic)

Variables
const	MODE_INFO_ACTIVE = 2
const	MODE_INFO_INACTIVE = 1
global	$DIC
	$request_wrapper = $DIC->http()->wrapper()->query()
	$refinery = $DIC->refinery()

Function Documentation

modeinfo()

ILIAS\UI\examples\MainControls\ModeInfo\modeinfo

(

)

---

expected output: > ILIAS shows a button "See UI in fullscreen-mode".

When clicked, a new page is shown with

• only one entry in the mainbar
• only the help-glyph in the metabar
• very(!) little content
• and a colored frame around the entire page. On the top of the frame, there is colored area "Active Mode Info" with a close-glyph. Clicking the close-glyph will return to the

  UI documentation.

Definition at line 39 of file modeinfo.php.

References ILIAS\UI\examples\MainControls\ModeInfo\$DIC, Vendor\Package\$f, $renderer, ILIAS\UI\examples\MainControls\ModeInfo\$request_wrapper, and ILIAS\UI\examples\MainControls\ModeInfo\MODE_INFO_ACTIVE.

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

    $icon = $f->symbol()->icon()->standard('root', '')->withSize('large');
    $target = new \ILIAS\Data\URI(
        $DIC->http()->request()->getUri()->__toString() . '&new_mode_info=' . MODE_INFO_ACTIVE
    );
    return $renderer->render([
        $f->divider()->horizontal(),
        $f->link()->bulky($icon, 'See UI in fullscreen-mode', $target),
        $f->legacy()->content('<p><b>press the link above to init a page with Mode Info</b></p><p><br/></p>'),
        $f->divider()->horizontal()
    ]);
}

const MODE_INFO_ACTIVE = 2;
const MODE_INFO_INACTIVE = 1;

global $DIC;
$request_wrapper = $DIC->http()->wrapper()->query();
$refinery = $DIC->refinery();

if ($request_wrapper->has('new_mode_info')
    && $request_wrapper->retrieve('new_mode_info', $refinery->kindlyTo()->int()) === MODE_INFO_ACTIVE
) {
    \ilInitialisation::initILIAS();
    echo(renderModeInfoFullscreenMode($DIC));
    exit();
}

renderModeInfoFullscreenMode()

if ( $request_wrapper->has( 'new_mode_info') &&$request_wrapper->retrieve( 'new_mode_info', $refinery->kindlyTo() ->int())===MODE_INFO_ACTIVE) ILIAS\UI\examples\MainControls\ModeInfo\renderModeInfoFullscreenMode

(

\ILIAS\DI\Container

$dic

)

a Mode Info needs to know what happens when you exit the mode

the Mode Info is attached to the page

Definition at line 73 of file modeinfo.php.

References Vendor\Package\$f, $renderer, ILIAS\UI\examples\MainControls\ModeInfo\MODE_INFO_ACTIVE, and ILIAS\UI\examples\MainControls\ModeInfo\MODE_INFO_INACTIVE.

{
    $f = $dic->ui()->factory();
    $data_factory = new \ILIAS\Data\Factory();
    $renderer = $dic->ui()->renderer();

    $panel_content = $f->legacy()->content("Mode Info is Active");
    $slate = $f->mainControls()->slate()->legacy(
        "Mode Info Active",
        $f->symbol()->glyph()->notification(),
        $f->legacy()->content("Things todo when special Mode is active")
    );

    $page = $f->layout()->page()->standard(
        [
            $f->legacy()->content("<div id='mainspacekeeper'><div style='padding: 15px;'>"),
            $f->panel()->standard(
                'Mode Info Example',
                $panel_content
            ),
            $f->legacy()->content("</div></div>")
        ],
        $f->mainControls()->metaBar()->withAdditionalEntry(
            'help',
            $f->button()->bulky($f->symbol()->glyph()->help(), 'Help', '#')
        ),
        $f->mainControls()->mainBar()->withAdditionalEntry("entry1", $slate),
        $f->breadcrumbs([]),
        $f->image()->responsive("assets/images/logo/HeaderIcon.svg", "ILIAS"),
        $f->image()->responsive("assets/images/logo/HeaderIconResponsive.svg", "ILIAS"),
        "./assets/images/logo/favicon.ico",
        $dic->ui()->factory()->toast()->container(),
        $dic->ui()->factory()->mainControls()->footer()->withAdditionalText("Footer"),
        'UI PAGE MODE INFO DEMO', //page title
        'ILIAS', //short title
        'Mode Info Demo' //view title
    )
    ->withHeaders(true)
    ->withUIDemo(true);


    $back = str_replace(
        'new_mode_info=' . MODE_INFO_ACTIVE,
        'new_mode_info=' . MODE_INFO_INACTIVE,
        $dic->http()->request()->getUri()->getQuery()
    );

    $mode_info = $f->mainControls()->modeInfo(
        "Active Mode Info",
        $data_factory->uri($dic->http()->request()->getUri()->withQuery($back)->__toString())
    );

    $page = $page->withModeInfo($mode_info);

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

Variable Documentation

$DIC

global ILIAS::UI::examples::MainControls::ModeInfo\$DIC

Definition at line 61 of file modeinfo.php.

Referenced by ILIAS\UI\examples\MainControls\ModeInfo\modeinfo().

$refinery

ILIAS::UI::examples::MainControls::ModeInfo\$refinery = $DIC->refinery()

Definition at line 63 of file modeinfo.php.

$request_wrapper

ILIAS::UI::examples::MainControls::ModeInfo\$request_wrapper = $DIC->http()->wrapper()->query()

Definition at line 62 of file modeinfo.php.

Referenced by ILIAS\UI\examples\MainControls\ModeInfo\modeinfo().

MODE_INFO_ACTIVE

const ILIAS::UI::examples::MainControls::ModeInfo\MODE_INFO_ACTIVE = 2

Definition at line 58 of file modeinfo.php.

Referenced by ILIAS\UI\examples\MainControls\ModeInfo\modeinfo(), and ILIAS\UI\examples\MainControls\ModeInfo\renderModeInfoFullscreenMode().

MODE_INFO_INACTIVE

const ILIAS::UI::examples::MainControls::ModeInfo\MODE_INFO_INACTIVE = 1

Definition at line 59 of file modeinfo.php.

Referenced by ILIAS\UI\examples\MainControls\ModeInfo\renderModeInfoFullscreenMode().