Test on glyph implementation. More...

Inheritance diagram for GlyphTest:

Collaboration diagram for GlyphTest:

Public Member Functions
	getGlyphFactory ()

	getCounterFactory ()

	test_implements_factory_interface (string $factory_method)
	@dataProvider glyph_type_provider More...

	test_glyph_types (string $factory_method)
	@dataProvider glyph_type_provider More...

	test_glyph_action (string $factory_method)
	@dataProvider glyph_type_provider More...

	test_glyph_no_action (string $factory_method)
	@dataProvider glyph_type_provider More...

	test_with_unavailable_action (string $factory_method)
	@dataProvider glyph_type_provider More...

	test_with_highlight ()

	test_no_counter (string $factory_method)
	@dataProvider glyph_type_provider More...

	test_one_counter (string $counter_type)
	@dataProvider counter_type_provider More...

	test_two_counters ()

	test_only_two_counters ()

	test_immutability_withCounter ()

	test_known_glyphs_only ()

	glyph_type_provider ()

	counter_type_provider ()

	test_render_simple (string $type)
	@dataProvider glyph_type_provider More...

	test_render_with_unavailable_action (string $type)
	@dataProvider glyph_type_provider More...

	test_render_withCounter (string $type)
	@dataProvider counter_type_provider More...

	test_render_withTwoCounters ()

	test_dont_render_counter ()

	test_render_with_on_load_code (string $type)
	@dataProvider glyph_type_provider More...

	test_render_with_action (string $type)
	@dataProvider glyph_type_provider More...

	testIsTabbable ()

	testTabbableGlyphRender ()

Public Member Functions inherited from ILIAS_UI_TestBase
	setUp ()

	tearDown ()

	getUIFactory ()

	getTemplateFactory ()

	getResourceRegistry ()

	getLanguage ()

	getJavaScriptBinding ()

	getRefinery ()

	getImagePathResolver ()

	getDataFactory ()

	getDefaultRenderer (JavaScriptBinding $js_binding=null, array $with_stub_renderings=[])

	getDecoratedRenderer (Renderer $default)

	normalizeHTML (string $html)

	assertHTMLEquals (string $expected_html_as_string, string $html_as_string)

Static Public Attributes
static array	$canonical_css_classes

static array	$aria_labels

Additional Inherited Members
Protected Member Functions inherited from ILIAS_UI_TestBase
	brutallyTrimHTML (string $html)
	A more radical version of normalizeHTML. More...

	brutallyTrimSignals (string $html)
	A naive replacement of all il_signal-ids with dots to ease comparisons of rendered output. More...

Detailed Description

Test on glyph implementation.

Definition at line 33 of file GlyphTest.php.

Member Function Documentation

◆ counter_type_provider()

GlyphTest::counter_type_provider ( )

Definition at line 331 of file GlyphTest.php.

                                           : array
    {
        return [
            ["status"],
            ["novelty"]
        ];
    }

◆ getCounterFactory()

GlyphTest::getCounterFactory ( )

Definition at line 40 of file GlyphTest.php.

                                       : C\Factory
    {
        return new I\Counter\Factory();
    }

Referenced by test_dont_render_counter(), test_immutability_withCounter(), test_one_counter(), test_only_two_counters(), test_render_withCounter(), test_render_withTwoCounters(), and test_two_counters().

Here is the caller graph for this function:

◆ getGlyphFactory()

GlyphTest::getGlyphFactory ( )

Definition at line 35 of file GlyphTest.php.

                                     : G\Factory
    {
        return new I\Symbol\Glyph\Factory();
    }

Referenced by test_glyph_action(), test_glyph_no_action(), test_glyph_types(), test_immutability_withCounter(), test_implements_factory_interface(), test_no_counter(), test_one_counter(), test_only_two_counters(), test_render_simple(), test_render_with_action(), test_render_with_on_load_code(), test_render_with_unavailable_action(), test_render_withCounter(), test_render_withTwoCounters(), test_two_counters(), test_with_highlight(), test_with_unavailable_action(), testIsTabbable(), and testTabbableGlyphRender().

Here is the caller graph for this function:

◆ glyph_type_provider()

GlyphTest::glyph_type_provider ( )

Definition at line 322 of file GlyphTest.php.

                                         : array
    {
        $glyph_reflection = new ReflectionClass(G\Glyph::class);
        $constant_values = array_values($glyph_reflection->getConstants());
        return array_map(function ($val) {
            return [$val];
        }, $constant_values);
    }

◆ test_dont_render_counter()

GlyphTest::test_dont_render_counter ( )

Definition at line 424 of file GlyphTest.php.

                                              : void
    {
        $this->expectException(LogicException::class);
        $r = new Renderer(
            $this->getUIFactory(),
            $this->getTemplateFactory(),
            $this->getLanguage(),
            $this->getJavaScriptBinding(),
            $this->getRefinery(),
            new ilImagePathResolver(),
            $this->getDataFactory()
        );
        $f = $this->getCounterFactory();
 
        $r->render($f->status(0), $this->getDefaultRenderer());
    }

References Vendor\Package\$f, getCounterFactory(), ILIAS_UI_TestBase\getDataFactory(), ILIAS_UI_TestBase\getJavaScriptBinding(), ILIAS_UI_TestBase\getLanguage(), ILIAS_UI_TestBase\getRefinery(), ILIAS_UI_TestBase\getTemplateFactory(), and ILIAS_UI_TestBase\getUIFactory().

Here is the call graph for this function:

◆ test_glyph_action()

GlyphTest::test_glyph_action ( string $factory_method )

@dataProvider glyph_type_provider

Definition at line 169 of file GlyphTest.php.

                                                             : void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method("http://www.ilias.de");
 
        $this->assertNotNull($g);
        $this->assertEquals("http://www.ilias.de", $g->getAction());
    }

References Vendor\Package\$f, and getGlyphFactory().

Here is the call graph for this function:

◆ test_glyph_no_action()

GlyphTest::test_glyph_no_action ( string $factory_method )

@dataProvider glyph_type_provider

Definition at line 181 of file GlyphTest.php.

                                                                : void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method();
 
        $this->assertNotNull($g);
        $this->assertEquals(null, $g->getAction());
    }

References Vendor\Package\$f, and getGlyphFactory().

Here is the call graph for this function:

◆ test_glyph_types()

GlyphTest::test_glyph_types ( string $factory_method )

@dataProvider glyph_type_provider

Definition at line 157 of file GlyphTest.php.

                                                            : void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method();
 
        $this->assertNotNull($g);
        $this->assertEquals($factory_method, $g->getType());
    }

References Vendor\Package\$f, and getGlyphFactory().

Here is the call graph for this function:

◆ test_immutability_withCounter()

GlyphTest::test_immutability_withCounter ( )

Definition at line 301 of file GlyphTest.php.

                                                   : void
    {
        $gf = $this->getGlyphFactory();
        $cf = $this->getCounterFactory();
 
        $g = $gf->mail();
        $g
            ->withCounter(
                $cf->novelty(0)
            );
 
        $counters = $g->getCounters();
        $this->assertCount(0, $counters);
    }

References getCounterFactory(), and getGlyphFactory().

Here is the call graph for this function:

◆ test_implements_factory_interface()

GlyphTest::test_implements_factory_interface ( string $factory_method )

@dataProvider glyph_type_provider

Definition at line 146 of file GlyphTest.php.

                                                                             : void
    {
        $f = $this->getGlyphFactory();
 
        $this->assertInstanceOf("ILIAS\\UI\\Component\\Symbol\\Glyph\\Factory", $f);
        $this->assertInstanceOf("ILIAS\\UI\\Component\\Symbol\\Glyph\\Glyph", $f->$factory_method("http://www.ilias.de"));
    }

References Vendor\Package\$f, and getGlyphFactory().

Here is the call graph for this function:

◆ test_known_glyphs_only()

GlyphTest::test_known_glyphs_only ( )

Definition at line 316 of file GlyphTest.php.

                                            : void
    {
        $this->expectException(InvalidArgumentException::class);
        new Glyph("FOO", "http://www.ilias.de");
    }

◆ test_no_counter()

GlyphTest::test_no_counter ( string $factory_method )

@dataProvider glyph_type_provider

Definition at line 217 of file GlyphTest.php.

                                                           : void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method();
 
        $this->assertCount(0, $g->getCounters());
    }

References Vendor\Package\$f, and getGlyphFactory().

Here is the call graph for this function:

◆ test_one_counter()

GlyphTest::test_one_counter ( string $counter_type )

@dataProvider counter_type_provider

Definition at line 228 of file GlyphTest.php.

                                                          : void
    {
        $gf = $this->getGlyphFactory();
        $cf = $this->getCounterFactory();
        $number = 1;
 
        $g = $gf
            ->mail()
            ->withCounter(
                $cf->$counter_type($number)
            );
 
        $counters = $g->getCounters();
        $this->assertCount(1, $counters);
        $c = $counters[0];
        $this->assertEquals($counter_type, $c->getType());
        $this->assertEquals($number, $c->getNumber());
    }

References $c, getCounterFactory(), and getGlyphFactory().

Here is the call graph for this function:

◆ test_only_two_counters()

GlyphTest::test_only_two_counters ( )

Definition at line 272 of file GlyphTest.php.

                                            : void
    {
        $gf = $this->getGlyphFactory();
        $cf = $this->getCounterFactory();
        $number_s = 1;
        $number_n1 = 2;
        $number_n2 = 2;
 
        $g = $gf
            ->mail()
            ->withCounter(
                $cf->status($number_s)
            )
            ->withCounter(
                $cf->novelty($number_n1)
            )
            ->withCounter(
                $cf->novelty($number_n2)
            );
 
        $counters = $g->getCounters();
        $this->assertCount(2, $counters);
        $vals = array_map(function ($c) {
            return array($c->getType(), $c->getNumber());
        }, $counters);
        $this->assertContains(array("status", $number_s), $vals);
        $this->assertContains(array("novelty", $number_n2), $vals);
    }

References $c, getCounterFactory(), and getGlyphFactory().

Here is the call graph for this function:

◆ test_render_simple()

GlyphTest::test_render_simple ( string $type )

@dataProvider glyph_type_provider

Definition at line 342 of file GlyphTest.php.

                                                    : void
    {
        $f = $this->getGlyphFactory();
        $r = $this->getDefaultRenderer();
        $c = $f->$type("http://www.ilias.de");
 
        $html = $this->normalizeHTML($r->render($c));
 
        $css_classes = self::$canonical_css_classes[$type];
        $aria_label = self::$aria_labels[$type];
 
        $expected = '<a tabindex="0" class="glyph" href="http://www.ilias.de" aria-label="' . $aria_label . '"><span class="' . $css_classes . '" aria-hidden="true"></span></a>';
        $this->assertEquals($expected, $html);
    }

References $c, Vendor\Package\$f, $type, ILIAS_UI_TestBase\getDefaultRenderer(), getGlyphFactory(), and ILIAS_UI_TestBase\normalizeHTML().

Here is the call graph for this function:

◆ test_render_with_action()

GlyphTest::test_render_with_action ( string $type )

@dataProvider glyph_type_provider

Definition at line 470 of file GlyphTest.php.

                                                         : void
    {
        $f = $this->getGlyphFactory();
        $r = $this->getDefaultRenderer();
        $c = $f->$type("http://www.ilias.de");
        $c = $c->withAction("http://www.ilias.de/open-source-lms-ilias/");
 
        $html = $this->normalizeHTML($r->render($c));
 
        $css_classes = self::$canonical_css_classes[$type];
        $aria_label = self::$aria_labels[$type];
 
        $expected = "<a tabindex=\"0\" class=\"glyph\" href=\"http://www.ilias.de/open-source-lms-ilias/\" aria-label=\"$aria_label\"><span class=\"$css_classes\" aria-hidden=\"true\"></span></a>";
        $this->assertEquals($expected, $html);
    }

References $c, Vendor\Package\$f, $type, ILIAS_UI_TestBase\getDefaultRenderer(), getGlyphFactory(), and ILIAS_UI_TestBase\normalizeHTML().

Here is the call graph for this function:

◆ test_render_with_on_load_code()

GlyphTest::test_render_with_on_load_code ( string $type )

@dataProvider glyph_type_provider

Definition at line 444 of file GlyphTest.php.

                                                               : void
    {
        $f = $this->getGlyphFactory();
        $r = $this->getDefaultRenderer();
        $ids = array();
        $c = $f->$type("http://www.ilias.de")
                ->withOnLoadCode(function ($id) use (&$ids): string {
                    $ids[] = $id;
                    return "";
                });
 
        $html = $this->normalizeHTML($r->render($c));
 
        $this->assertCount(1, $ids);
 
        $css_classes = self::$canonical_css_classes[$type];
        $aria_label = self::$aria_labels[$type];
 
        $id = $ids[0];
        $expected = "<a tabindex=\"0\" class=\"glyph\" href=\"http://www.ilias.de\" aria-label=\"$aria_label\" id=\"$id\"><span class=\"$css_classes\" aria-hidden=\"true\"></span></a>";
        $this->assertEquals($expected, $html);
    }

References $c, Vendor\Package\$f, $id, $type, ILIAS_UI_TestBase\getDefaultRenderer(), getGlyphFactory(), and ILIAS_UI_TestBase\normalizeHTML().

Here is the call graph for this function:

◆ test_render_with_unavailable_action()

GlyphTest::test_render_with_unavailable_action ( string $type )

@dataProvider glyph_type_provider

Definition at line 360 of file GlyphTest.php.

                                                                     : void
    {
        $f = $this->getGlyphFactory();
        $r = $this->getDefaultRenderer();
        $c = $f->$type("http://www.ilias.de")->withUnavailableAction();
 
        $html = $this->normalizeHTML($r->render($c));
 
        $css_classes = self::$canonical_css_classes[$type];
        $aria_label = self::$aria_labels[$type];
 
        $expected = '
        <a class="glyph disabled" aria-label="' . $aria_label . '" aria-disabled="true">
            <span class="' . $css_classes . '" aria-hidden="true"></span>
        </a>';
        $this->assertEquals($this->brutallyTrimHTML($expected), $this->brutallyTrimHTML($html));
    }

References $c, Vendor\Package\$f, $type, ILIAS_UI_TestBase\brutallyTrimHTML(), ILIAS_UI_TestBase\getDefaultRenderer(), getGlyphFactory(), and ILIAS_UI_TestBase\normalizeHTML().

Here is the call graph for this function:

◆ test_render_withCounter()

GlyphTest::test_render_withCounter ( string $type )

@dataProvider counter_type_provider

Definition at line 381 of file GlyphTest.php.

                                                         : void
    {
        $fg = $this->getGlyphFactory();
        $fc = $this->getCounterFactory();
        $r = $this->getDefaultRenderer();
        $c = $fg->mail("http://www.ilias.de")->withCounter($fc->$type(42));
 
        $html = $this->normalizeHTML($r->render($c));
 
        $css_classes = self::$canonical_css_classes[G\Glyph::MAIL];
        $aria_label = self::$aria_labels[G\Glyph::MAIL];
 
        $expected = '
            <a tabindex="0" class="glyph" href="http://www.ilias.de" aria-label="' . $aria_label . '">
                    <span class="' . $css_classes . '" aria-hidden="true"></span>
                    <span class="il-counter"><span class="badge badge-notify il-counter-' . $type . '">42</span></span>
                    <span class="il-counter-spacer">42</span>
            </a>';
        $this->assertHTMLEquals($expected, $html);
    }

References $c, $type, ILIAS_UI_TestBase\assertHTMLEquals(), getCounterFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), getGlyphFactory(), ILIAS\UI\Component\Symbol\Glyph\Glyph\MAIL, and ILIAS_UI_TestBase\normalizeHTML().

Here is the call graph for this function:

◆ test_render_withTwoCounters()

GlyphTest::test_render_withTwoCounters ( )

Definition at line 402 of file GlyphTest.php.

                                                 : void
    {
        $fg = $this->getGlyphFactory();
        $fc = $this->getCounterFactory();
        $r = $this->getDefaultRenderer();
        $c = $fg->mail("http://www.ilias.de")
                ->withCounter($fc->novelty(42))
                ->withCounter($fc->status(7));
 
        $html = $this->normalizeHTML($r->render($c));
 
        $css_classes = self::$canonical_css_classes[G\Glyph::MAIL];
        $aria_label = self::$aria_labels[G\Glyph::MAIL];
        $expected = "<a tabindex=\"0\" class=\"glyph\" href=\"http://www.ilias.de\" aria-label=\"$aria_label\">" .
                    "<span class=\"$css_classes\" aria-hidden=\"true\"></span>" .
                    "<span class=\"il-counter\"><span class=\"badge badge-notify il-counter-status\">7</span></span>" .
                    "<span class=\"il-counter\"><span class=\"badge badge-notify il-counter-novelty\">42</span></span>" .
                    "<span class=\"il-counter-spacer\">42</span>" .
                    "</a>";
        $this->assertHTMLEquals($expected, $html);
    }

References $c, ILIAS_UI_TestBase\assertHTMLEquals(), getCounterFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), getGlyphFactory(), ILIAS\UI\Component\Symbol\Glyph\Glyph\MAIL, and ILIAS_UI_TestBase\normalizeHTML().

Here is the call graph for this function:

◆ test_two_counters()

GlyphTest::test_two_counters ( )

Definition at line 247 of file GlyphTest.php.

                                       : void
    {
        $gf = $this->getGlyphFactory();
        $cf = $this->getCounterFactory();
        $number_s = 1;
        $number_n = 2;
 
        $g = $gf
            ->mail()
            ->withCounter(
                $cf->status($number_s)
            )
            ->withCounter(
                $cf->novelty($number_n)
            );
 
        $counters = $g->getCounters();
        $this->assertCount(2, $counters);
        $vals = array_map(function ($c) {
            return array($c->getType(), $c->getNumber());
        }, $counters);
        $this->assertContains(array("status", $number_s), $vals);
        $this->assertContains(array("novelty", $number_n), $vals);
    }

References $c, getCounterFactory(), and getGlyphFactory().

Here is the call graph for this function:

◆ test_with_highlight()

GlyphTest::test_with_highlight ( )

Definition at line 203 of file GlyphTest.php.

                                         : void
    {
        $gf = $this->getGlyphFactory();
 
        $g = $gf->mail();
        $g2 = $g->withHighlight();
 
        $this->assertFalse($g->isHighlighted());
        $this->assertTrue($g2->isHighlighted());
    }

References getGlyphFactory().

Here is the call graph for this function:

◆ test_with_unavailable_action()

GlyphTest::test_with_unavailable_action ( string $factory_method )

@dataProvider glyph_type_provider

Definition at line 193 of file GlyphTest.php.

                                                                        : void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method();
        $g2 = $f->$factory_method()->withUnavailableAction();
 
        $this->assertTrue($g->isActive());
        $this->assertFalse($g2->isActive());
    }

References Vendor\Package\$f, and getGlyphFactory().

Here is the call graph for this function:

◆ testIsTabbable()

GlyphTest::testIsTabbable ( )

Definition at line 486 of file GlyphTest.php.

                                    : void
    {
        $f = $this->getGlyphFactory();
        $r = $this->getDefaultRenderer();
 
        // Glyph without Action or Signal
        $c = $f->user();
        $this->assertFalse($c->isTabbable());
 
        // Glyph with Action
        $c = $f->user()->withAction("#");
        $this->assertTrue($c->isTabbable());
 
        // Glyph with Signal
        $c = $f->user()->withOnClick(new I\Signal("id_1", "click"));
        $this->assertTrue($c->isTabbable());
 
        // Glyph with Action and Signal
        $c = $f->user()->withAction("#")->withOnClick(new I\Signal("id_1", "click"));
        $this->assertTrue($c->isTabbable());
 
        // Glyph with Action and Signal but Inactive
        $c = $f->user()->withAction("#")->withOnClick(new I\Signal("id_1", "click"))->withUnavailableAction();
        $this->assertFalse($c->isTabbable());
    }

References $c, Vendor\Package\$f, ILIAS_UI_TestBase\getDefaultRenderer(), and getGlyphFactory().

Here is the call graph for this function:

◆ testTabbableGlyphRender()

GlyphTest::testTabbableGlyphRender ( )

Definition at line 512 of file GlyphTest.php.

                                             : void
    {
        $f = $this->getGlyphFactory();
        $r = $this->getDefaultRenderer();
 
        // Glyph without Action or Signal (not Tabbable)
        $c = $f->user();
        $expected = '<a class="glyph" aria-label="show_who_is_online"><span class="glyphicon glyphicon-user" aria-hidden="true"></span></a>';
        $html = $this->normalizeHTML($r->render($c));
        $this->assertEquals($expected, $html);
 
        // Glyph with Action (Tabbable)
        $c = $f->user()->withAction("#");
        $expected = '<a tabindex="0" class="glyph" href="#" aria-label="show_who_is_online"><span class="glyphicon glyphicon-user" aria-hidden="true"></span></a>';
        $html = $this->normalizeHTML($r->render($c));
        $this->assertEquals($expected, $html);
    }

References $c, Vendor\Package\$f, ILIAS_UI_TestBase\getDefaultRenderer(), getGlyphFactory(), and ILIAS_UI_TestBase\normalizeHTML().

Here is the call graph for this function:

Field Documentation

◆ $aria_labels

array GlyphTest::$aria_labels

static

Definition at line 94 of file GlyphTest.php.

◆ $canonical_css_classes

array GlyphTest::$canonical_css_classes

static

Definition at line 45 of file GlyphTest.php.

The documentation for this class was generated from the following file:

tests/UI/Component/Symbol/Glyph/GlyphTest.php

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ counter_type_provider()

◆ getCounterFactory()

◆ getGlyphFactory()

◆ glyph_type_provider()

◆ test_dont_render_counter()

◆ test_glyph_action()

◆ test_glyph_no_action()

◆ test_glyph_types()

◆ test_immutability_withCounter()

◆ test_implements_factory_interface()

◆ test_known_glyphs_only()

◆ test_no_counter()

◆ test_one_counter()

◆ test_only_two_counters()

◆ test_render_simple()

◆ test_render_with_action()

◆ test_render_with_on_load_code()

◆ test_render_with_unavailable_action()

◆ test_render_withCounter()

◆ test_render_withTwoCounters()

◆ test_two_counters()

◆ test_with_highlight()

◆ test_with_unavailable_action()

◆ testIsTabbable()

◆ testTabbableGlyphRender()

Field Documentation

◆ $aria_labels

◆ $canonical_css_classes