GlyphTest Class Reference

Test on glyph implementation. More...

Inheritance diagram for GlyphTest:

Collaboration diagram for GlyphTest:

Public Member Functions
	getGlyphFactory ()
	getCounterFactory ()
	testImplementsFactoryInterface (string $factory_method)
	getGlyphTypeProvider More...
	testGlyphTypes (string $factory_method)
	getGlyphTypeProvider More...
	testGlyphAction (string $factory_method)
	getGlyphTypeProvider More...
	testGlyphNoAction (string $factory_method)
	getGlyphTypeProvider More...
	testWithUnavailableAction (string $factory_method)
	getGlyphTypeProvider More...
	testWithHighlight ()
	testNoCounter (string $factory_method)
	getGlyphTypeProvider More...
	testOneCounter (string $counter_type)
	getCounterTypeProvider More...
	testTwoCounters ()
	testOnlyTwoCounters ()
	testImmutabilityWithCounter ()
	testKnownGlyphsOnly ()
	getGlyphTypeProvider ()
	getCounterTypeProvider ()
	testRenderSimple (string $type)
	getGlyphTypeProvider More...
	testRenderWithUnavailableAction (string $type)
	getGlyphTypeProvider More...
	testRenderWithCounter (string $type)
	getCounterTypeProvider More...
	testRenderWithTwoCounters ()
	testDontRenderCounter ()
	testRenderWithOnLoadCode (string $type)
	getGlyphTypeProvider More...
	testRenderWithAction (string $type)
	getGlyphTypeProvider More...
	testIsTabbable ()
	testTabbableGlyphRender ()
Public Member Functions inherited from ILIAS_UI_TestBase
	setUp ()
	tearDown ()
	getUIFactory ()
	getTemplateFactory ()
	getResourceRegistry ()
	getLanguage ()
	getJavaScriptBinding ()
	getRefinery ()
	getImagePathResolver ()
	getDataFactory ()
	getHelpTextRetriever ()
	getUploadLimitResolver ()
	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 35 of file GlyphTest.php.

Member Function Documentation

getCounterFactory()

GlyphTest::getCounterFactory

(

)

Definition at line 42 of file GlyphTest.php.

Referenced by testDontRenderCounter(), testImmutabilityWithCounter(), testOneCounter(), testOnlyTwoCounters(), testRenderWithCounter(), testRenderWithTwoCounters(), and testTwoCounters().

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

Here is the caller graph for this function:

getCounterTypeProvider()

GlyphTest::getCounterTypeProvider

(

)

Definition at line 343 of file GlyphTest.php.

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

getGlyphFactory()

GlyphTest::getGlyphFactory

(

)

Definition at line 37 of file GlyphTest.php.

Referenced by testGlyphAction(), testGlyphNoAction(), testGlyphTypes(), testImmutabilityWithCounter(), testImplementsFactoryInterface(), testIsTabbable(), testNoCounter(), testOneCounter(), testOnlyTwoCounters(), testRenderSimple(), testRenderWithAction(), testRenderWithCounter(), testRenderWithOnLoadCode(), testRenderWithTwoCounters(), testRenderWithUnavailableAction(), testTabbableGlyphRender(), testTwoCounters(), testWithHighlight(), and testWithUnavailableAction().

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

Here is the caller graph for this function:

getGlyphTypeProvider()

GlyphTest::getGlyphTypeProvider

(

)

Definition at line 334 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);
    }

testDontRenderCounter()

GlyphTest::testDontRenderCounter

(

)

Definition at line 436 of file GlyphTest.php.

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

                                           : void
    {
        $this->expectException(LogicException::class);
        $r = new Renderer(
            $this->getUIFactory(),
            $this->getTemplateFactory(),
            $this->getLanguage(),
            $this->getJavaScriptBinding(),
            $this->getRefinery(),
            new ilImagePathResolver(),
            $this->createMock(DataFactory::class),
            $this->createMock(HelpTextRetriever::class),
            $this->getUploadLimitResolver()
        );
        $f = $this->getCounterFactory();

        $r->render($f->status(0), $this->getDefaultRenderer());
    }

Here is the call graph for this function:

testGlyphAction()

GlyphTest::testGlyphAction

(

string

$factory_method

)

getGlyphTypeProvider

Definition at line 181 of file GlyphTest.php.

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

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

        $this->assertNotNull($g);
        $this->assertEquals("http://www.ilias.de", $g->getAction());
    }

Here is the call graph for this function:

testGlyphNoAction()

GlyphTest::testGlyphNoAction

(

string

$factory_method

)

getGlyphTypeProvider

Definition at line 193 of file GlyphTest.php.

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

                                                             : void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method();

        $this->assertNotNull($g);
        $this->assertEquals(null, $g->getAction());
    }

Here is the call graph for this function:

testGlyphTypes()

GlyphTest::testGlyphTypes

(

string

$factory_method

)

getGlyphTypeProvider

Definition at line 169 of file GlyphTest.php.

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

                                                          : void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method();

        $this->assertNotNull($g);
        $this->assertEquals($factory_method, $g->getType());
    }

Here is the call graph for this function:

testImmutabilityWithCounter()

GlyphTest::testImmutabilityWithCounter

(

)

Definition at line 313 of file GlyphTest.php.

References getCounterFactory(), and getGlyphFactory().

                                                 : void
    {
        $gf = $this->getGlyphFactory();
        $cf = $this->getCounterFactory();

        $g = $gf->mail();
        $g
            ->withCounter(
                $cf->novelty(0)
            );

        $counters = $g->getCounters();
        $this->assertCount(0, $counters);
    }

Here is the call graph for this function:

testImplementsFactoryInterface()

GlyphTest::testImplementsFactoryInterface

(

string

$factory_method

)

getGlyphTypeProvider

Definition at line 158 of file GlyphTest.php.

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

                                                                          : 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"));
    }

Here is the call graph for this function:

testIsTabbable()

GlyphTest::testIsTabbable

(

)

Definition at line 500 of file GlyphTest.php.

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

                                    : 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());
    }

Here is the call graph for this function:

testKnownGlyphsOnly()

GlyphTest::testKnownGlyphsOnly

(

)

Definition at line 328 of file GlyphTest.php.

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

testNoCounter()

GlyphTest::testNoCounter

(

string

$factory_method

)

getGlyphTypeProvider

Definition at line 229 of file GlyphTest.php.

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

                                                         : void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method();

        $this->assertCount(0, $g->getCounters());
    }

Here is the call graph for this function:

testOneCounter()

GlyphTest::testOneCounter

(

string

$counter_type

)

getCounterTypeProvider

Definition at line 240 of file GlyphTest.php.

References Vendor\Package\$c, getCounterFactory(), and getGlyphFactory().

                                                        : 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());
    }

Here is the call graph for this function:

testOnlyTwoCounters()

GlyphTest::testOnlyTwoCounters

(

)

Definition at line 284 of file GlyphTest.php.

References Vendor\Package\$c, getCounterFactory(), and getGlyphFactory().

                                         : 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);
    }

Here is the call graph for this function:

testRenderSimple()

GlyphTest::testRenderSimple

(

string

$type

)

getGlyphTypeProvider

Definition at line 354 of file GlyphTest.php.

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

                                                  : 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);
    }

Here is the call graph for this function:

testRenderWithAction()

GlyphTest::testRenderWithAction

(

string

$type

)

getGlyphTypeProvider

Definition at line 484 of file GlyphTest.php.

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

                                                      : 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);
    }

Here is the call graph for this function:

testRenderWithCounter()

GlyphTest::testRenderWithCounter

(

string

$type

)

getCounterTypeProvider

Definition at line 393 of file GlyphTest.php.

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

                                                       : 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);
    }

Here is the call graph for this function:

testRenderWithOnLoadCode()

GlyphTest::testRenderWithOnLoadCode

(

string

$type

)

getGlyphTypeProvider

Definition at line 458 of file GlyphTest.php.

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

                                                          : 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);
    }

Here is the call graph for this function:

testRenderWithTwoCounters()

GlyphTest::testRenderWithTwoCounters

(

)

Definition at line 414 of file GlyphTest.php.

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

                                               : 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);
    }

Here is the call graph for this function:

testRenderWithUnavailableAction()

GlyphTest::testRenderWithUnavailableAction

(

string

$type

)

getGlyphTypeProvider

Definition at line 372 of file GlyphTest.php.

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

                                                                 : 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));
    }

Here is the call graph for this function:

testTabbableGlyphRender()

GlyphTest::testTabbableGlyphRender

(

)

Definition at line 526 of file GlyphTest.php.

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

                                             : 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);
    }

Here is the call graph for this function:

testTwoCounters()

GlyphTest::testTwoCounters

(

)

Definition at line 259 of file GlyphTest.php.

References Vendor\Package\$c, getCounterFactory(), and getGlyphFactory().

                                     : 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);
    }

Here is the call graph for this function:

testWithHighlight()

GlyphTest::testWithHighlight

(

)

Definition at line 215 of file GlyphTest.php.

References getGlyphFactory().

                                       : void
    {
        $gf = $this->getGlyphFactory();

        $g = $gf->mail();
        $g2 = $g->withHighlight();

        $this->assertFalse($g->isHighlighted());
        $this->assertTrue($g2->isHighlighted());
    }

Here is the call graph for this function:

testWithUnavailableAction()

GlyphTest::testWithUnavailableAction

(

string

$factory_method

)

getGlyphTypeProvider

Definition at line 205 of file GlyphTest.php.

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

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

        $this->assertTrue($g->isActive());
        $this->assertFalse($g2->isActive());
    }

Here is the call graph for this function:

Field Documentation

$aria_labels

array GlyphTest::$aria_labels

static

Definition at line 101 of file GlyphTest.php.

$canonical_css_classes

array GlyphTest::$canonical_css_classes

static

Definition at line 47 of file GlyphTest.php.

---

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

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