ILIAS\UI\examples\Counter\Status Namespace Reference

Functions
	base ()
	description: > Base example for rendering a status counter. More...
	multiple_glyphs ()
	description: > Example for rendering multiple glyphs with status counters More...
	with_js ()
	description: > Base example for rendering a JS status counter More...
	with_novelty ()
	description: > Base example for rendering a status counter with novelty More...

Function Documentation

base()

ILIAS\UI\examples\Counter\Status\base

(

)

---

description: > Base example for rendering a status counter.

expected output: >

ILIAS shows a rendered glyph with a counter. The counter consists of a white colored number within a grey circle.

Definition at line 32 of file base.php.

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

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

    return $renderer->render($f->symbol()->glyph()->mail("#")
        ->withCounter($f->counter()->status(3)));
}

multiple_glyphs()

ILIAS\UI\examples\Counter\Status\multiple_glyphs

(

)

---

description: > Example for rendering multiple glyphs with status counters

expected output: > ILIAS shows three rendered glyphs with two counters each in a row.

The counters consist of a white number each and are highlighted red resp. grey

Definition at line 33 of file multiple_glyphs.php.

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

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

    $note = $f->symbol()->glyph()->note("#")
        ->withCounter($f->counter()->novelty(100))
        ->withCounter($f->counter()->status(8));

    $tag = $f->symbol()->glyph()->tag("#")
        ->withCounter($f->counter()->novelty(1))
        ->withCounter($f->counter()->status(800));

    $comment = $f->symbol()->glyph()->comment("#")
        ->withCounter($f->counter()->novelty(1))
        ->withCounter($f->counter()->status(8));

    return $renderer->render($note) . $renderer->render($tag) . $renderer->render($comment);
}

with_js()

ILIAS\UI\examples\Counter\Status\with_js

(

)

---

description: > Base example for rendering a JS status counter

note: > Counters also offer an interface for manipulations through JS. Checkout src/UI/templates/js/Counter/counter.js for a complete spec.

expected output: > ILIAS shows different JS-exmaples which can get altered directly:

• Click once to raise the status counter to 10.
• Click once to raise the novelty counter to 1.
• Click once to change the novelty counter to a status counter.

  - Click once to change the status counter 3 to a novelty counter 7.

Definition at line 40 of file with_js.php.

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

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

    //Note that both counters have to be present to perform JS actions on them
    $like = $f->symbol()->glyph()->love("#")
        ->withCounter($f->counter()->novelty(3))
        ->withCounter($f->counter()->status(0));

    $set_status_button = $f->button()->bulky($like, "Set Status Counter to 10 on click.", "#")
        ->withAdditionalOnLoadCode(
            function ($id) {
                return "
                $(\"#$id\").click(function() { 
                    il.UI.counter.getCounterObject($(this)).setStatusTo(10);
                });";
            }
        );

    $increment_novelty_button = $f->button()->bulky($like, "Increment Novelty Counter by on click", "#")
        ->withAdditionalOnLoadCode(
            function ($id) {
                return "
                $(\"#$id\").click(function() { 
                    il.UI.counter.getCounterObject($(this)).incrementNoveltyCount(1);
                });";
            }
        );

    $set_novelty_count_to_status_button = $f->button()->bulky($like, "Set Novelty Count to status on click", "#")
        ->withAdditionalOnLoadCode(
            function ($id) {
                return "
                $(\"#$id\").click(function() { 
                    il.UI.counter.getCounterObject($(this)).setTotalNoveltyToStatusCount(1);
                });";
            }
        );

    //What will the value of Status be after click?
    $combined_button = $f->button()->bulky($like, "Some chained actions", "#")
        ->withAdditionalOnLoadCode(
            function ($id) {
                return "
                $(\"#$id\").click(function() { 
                    var counter = il.UI.counter.getCounterObject($(this));
                    counter.setNoveltyTo(3);
                    counter.setStatusTo(3);
                    counter.incrementStatusCount(1);
                    counter.setTotalNoveltyToStatusCount();
                    console.log(
                        counter.getStatusCount()
                    );
                });";
            }
        );

    return $renderer->render([$set_status_button,$increment_novelty_button,$set_novelty_count_to_status_button,$combined_button]);
}

with_novelty()

ILIAS\UI\examples\Counter\Status\with_novelty

(

)

---

description: > Base example for rendering a status counter with novelty

expected output: >

ILIAS shows a glyph with two counters. The counter's numbers are white and highlighted red resp. grey.

Definition at line 32 of file with_novelty.php.

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

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

    return $renderer->render(
        $f->symbol()->glyph()->mail("#")
        ->withCounter($f->counter()->novelty(1))
        ->withCounter($f->counter()->status(8))
    );
}