ButtonTest Class Reference

Test on button implementation. More...

Inheritance diagram for ButtonTest:

Collaboration diagram for ButtonTest:

Public Member Functions
	getButtonFactory ()
	test_implements_factory_interface ()
	test_button_label_or_glyph_only ($factory_method)
	button_type_provider More...
	test_button_string_action_only ($factory_method)
	button_type_provider More...
	test_button_label ($factory_method)
	button_type_provider More...
	test_button_with_label ($factory_method)
	button_type_provider More...
	test_button_action ($factory_method)
	button_type_provider More...
	test_button_activated_on_default ($factory_method)
	button_type_provider More...
	test_button_deactivation ($factory_method)
	button_type_provider More...
	test_render_button_label ($factory_method)
	button_type_provider More...
	test_render_button_disabled ($factory_method)
	button_type_provider More...
	test_render_close_button ()
	test_render_button_with_on_load_code ($factory_method)
	button_type_provider More...
	test_____render_close_button_with_on_load_code ()
	test_btn_tag_relevance ()
	test_render_btn_tag_relevance ()
	test_render_btn_tag_colors ()
	test_render_btn_tag_classes ()
	test_button_with_aria_label ($factory_method)
	button_type_provider More...
	test_button_with_aria_checked ($factory_method)
	button_type_provider More...
	test_render_button_with_aria_label ($factory_method)
	button_type_provider More...
	test_render_button_with_aria_checked ($factory_method)
	button_type_provider More...
	button_type_provider ()
Public Member Functions inherited from ILIAS_UI_TestBase
	setUp ()
	tearDown ()
	getUIFactory ()
	getTemplateFactory ()
	getResourceRegistry ()
	getLanguage ()
	getJavaScriptBinding ()
	getDefaultRenderer (JavaScriptBinding $js_binding=null)
	normalizeHTML ($html)
	assertHTMLEquals ($expected_html_as_string, $html_as_string)

Static Public Attributes
static	$canonical_css_classes
static	$canonical_css_inactivation_classes

Detailed Description

Test on button implementation.

Definition at line 13 of file ButtonTest.php.

Member Function Documentation

button_type_provider()

ButtonTest::button_type_provider

(

)

Definition at line 398 of file ButtonTest.php.

References array.

    {
        return array( array("standard")
            , array("primary")
            , array("shy")
            , array("tag")
            );
    }

getButtonFactory()

ButtonTest::getButtonFactory

(

)

Definition at line 15 of file ButtonTest.php.

Referenced by test_____render_close_button_with_on_load_code(), test_btn_tag_relevance(), test_button_action(), test_button_activated_on_default(), test_button_deactivation(), test_button_label(), test_button_label_or_glyph_only(), test_button_string_action_only(), test_button_with_aria_checked(), test_button_with_aria_label(), test_button_with_label(), test_implements_factory_interface(), test_render_btn_tag_classes(), test_render_btn_tag_colors(), test_render_btn_tag_relevance(), test_render_button_disabled(), test_render_button_label(), test_render_button_with_aria_checked(), test_render_button_with_aria_label(), test_render_button_with_on_load_code(), and test_render_close_button().

    {
        return new \ILIAS\UI\Implementation\Component\Button\Factory();
    }

Here is the caller graph for this function:

test_____render_close_button_with_on_load_code()

ButtonTest::test_____render_close_button_with_on_load_code

(

)

Definition at line 224 of file ButtonTest.php.

References $html, $id, $r, array, getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS_UI_TestBase\normalizeHTML().

    {
        $f = $this->getButtonFactory();
        $r = $this->getDefaultRenderer();
        $ids = array();
        $b = $f->close()
                ->withOnLoadCode(function ($id) use (&$ids) {
                    $ids[] = $id;
                    return "";
                });

        $html = $this->normalizeHTML($r->render($b));

        $this->assertCount(1, $ids);

        $id = $ids[0];
        $expected = "<button type=\"button\" class=\"close\" data-dismiss=\"modal\" id=\"$id\">" .
                    "   <span aria-hidden=\"true\">&times;</span>" .
                    "   <span class=\"sr-only\">Close</span>" .
                    "</button>";
        $this->assertEquals($expected, $html);
    }

Here is the call graph for this function:

test_btn_tag_relevance()

ButtonTest::test_btn_tag_relevance

(

)

Definition at line 247 of file ButtonTest.php.

References getButtonFactory().

    {
        $f = $this->getButtonFactory();
        $b = $f->tag('tag', '#');
        try {
            $b->withRelevance(0);
            $this->assertFalse("This should not happen");
        } catch (\InvalidArgumentException $e) {
            $this->assertTrue(true);
        }
        try {
            $b->withRelevance('notsoimportant');
            $this->assertFalse("This should not happen");
        } catch (\InvalidArgumentException $e) {
            $this->assertTrue(true);
        }
    }

Here is the call graph for this function:

test_button_action()

ButtonTest::test_button_action

(

$factory_method

)

button_type_provider

Definition at line 110 of file ButtonTest.php.

References getButtonFactory().

    {
        $f = $this->getButtonFactory();
        $b = $f->$factory_method("label", "http://www.ilias.de");

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

Here is the call graph for this function:

test_button_activated_on_default()

ButtonTest::test_button_activated_on_default

(

$factory_method

)

button_type_provider

Definition at line 121 of file ButtonTest.php.

References getButtonFactory().

    {
        $f = $this->getButtonFactory();
        $b = $f->$factory_method("label", "http://www.ilias.de");

        $this->assertTrue($b->isActive());
    }

Here is the call graph for this function:

test_button_deactivation()

ButtonTest::test_button_deactivation

(

$factory_method

)

button_type_provider

Definition at line 132 of file ButtonTest.php.

References getButtonFactory().

    {
        $f = $this->getButtonFactory();
        $b = $f->$factory_method("label", "http://www.ilias.de")
                ->withUnavailableAction();

        $this->assertFalse($b->isActive());
        $this->assertEquals("http://www.ilias.de", $b->getAction());
    }

Here is the call graph for this function:

test_button_label()

ButtonTest::test_button_label

(

$factory_method

)

button_type_provider

Definition at line 85 of file ButtonTest.php.

References getButtonFactory().

    {
        $f = $this->getButtonFactory();
        $b = $f->$factory_method("label", "http://www.ilias.de");

        $this->assertEquals("label", $b->getLabel());
    }

Here is the call graph for this function:

test_button_label_or_glyph_only()

ButtonTest::test_button_label_or_glyph_only

(

$factory_method

)

button_type_provider

Definition at line 59 of file ButtonTest.php.

References getButtonFactory().

    {
        $f = $this->getButtonFactory();
        try {
            $f->$factory_method($this, "http://www.ilias.de");
            $this->assertFalse("This should not happen");
        } catch (\InvalidArgumentException $e) {
        }
    }

Here is the call graph for this function:

test_button_string_action_only()

ButtonTest::test_button_string_action_only

(

$factory_method

)

button_type_provider

Definition at line 72 of file ButtonTest.php.

References getButtonFactory().

    {
        $f = $this->getButtonFactory();
        try {
            $f->$factory_method("label", $this);
            $this->assertFalse("This should not happen");
        } catch (\InvalidArgumentException $e) {
        }
    }

Here is the call graph for this function:

test_button_with_aria_checked()

ButtonTest::test_button_with_aria_checked

(

$factory_method

)

button_type_provider

Definition at line 343 of file ButtonTest.php.

References getButtonFactory().

    {
        $f = $this->getButtonFactory();
        $b = $f->$factory_method("label", "http://www.ilias.de");
        $this->assertEquals(false, $b->isAriaChecked());
        $b2 = $f->$factory_method("label", "http://www.ilias.de")->withAriaChecked();
        $this->assertEquals(true, $b2->isAriaChecked());
    }

Here is the call graph for this function:

test_button_with_aria_label()

ButtonTest::test_button_with_aria_label

(

$factory_method

)

button_type_provider

Definition at line 333 of file ButtonTest.php.

References getButtonFactory().

    {
        $f = $this->getButtonFactory();
        $b = $f->$factory_method("label", "http://www.ilias.de")->withAriaLabel("ariatext");
        $this->assertEquals("ariatext", $b->getAriaLabel());
    }

Here is the call graph for this function:

test_button_with_label()

ButtonTest::test_button_with_label

(

$factory_method

)

button_type_provider

Definition at line 96 of file ButtonTest.php.

References getButtonFactory().

    {
        $f = $this->getButtonFactory();
        $b = $f->$factory_method("label", "http://www.ilias.de");

        $b2 = $b->withLabel("label2");

        $this->assertEquals("label", $b->getLabel());
        $this->assertEquals("label2", $b2->getLabel());
    }

Here is the call graph for this function:

test_implements_factory_interface()

ButtonTest::test_implements_factory_interface

(

)

Definition at line 33 of file ButtonTest.php.

References getButtonFactory().

    {
        $f = $this->getButtonFactory();

        $this->assertInstanceOf("ILIAS\\UI\\Component\\Button\\Factory", $f);
        $this->assertInstanceOf(
            "ILIAS\\UI\\Component\\Button\\Standard",
            $f->standard("label", "http://www.ilias.de")
        );
        $this->assertInstanceOf(
            "ILIAS\\UI\\Component\\Button\\Primary",
            $f->primary("label", "http://www.ilias.de")
        );
        $this->assertInstanceOf(
            "ILIAS\\UI\\Component\\Button\\Close",
            $f->close()
        );
        $this->assertInstanceOf(
            "ILIAS\\UI\\Component\\Button\\Shy",
            $f->shy("label", "http://www.ilias.de")
        );
    }

Here is the call graph for this function:

test_render_btn_tag_classes()

ButtonTest::test_render_btn_tag_classes

(

)

Definition at line 315 of file ButtonTest.php.

References $html, $r, array, getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS_UI_TestBase\normalizeHTML().

    {
        $f = $this->getButtonFactory();
        $r = $this->getDefaultRenderer();
        $df = new \ILIAS\Data\Factory;

        $classes = array('cl1', 'cl2');
        $b = $f->tag('tag', '#')
            ->withClasses($classes);
        $this->assertEquals($classes, $b->getClasses());

        $html = $this->normalizeHTML($r->render($b));
        $expected = '<a class="btn btn-tag btn-tag-relevance-veryhigh cl1 cl2" href="#" data-action="#">tag</a>';
        $this->assertEquals($expected, $html);
    }

Here is the call graph for this function:

test_render_btn_tag_colors()

ButtonTest::test_render_btn_tag_colors

(

)

Definition at line 294 of file ButtonTest.php.

References $html, $r, getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS_UI_TestBase\normalizeHTML().

    {
        $f = $this->getButtonFactory();
        $r = $this->getDefaultRenderer();
        $df = new \ILIAS\Data\Factory;

        $bgcol = $df->color('#00ff00');

        $b = $f->tag('tag', '#')
            ->withBackgroundColor($bgcol);
        $html = $this->normalizeHTML($r->render($b));
        $expected = '<a class="btn btn-tag btn-tag-relevance-veryhigh" style="background-color: #00ff00; color: #000000;" href="#" data-action="#">tag</a>';
        $this->assertEquals($expected, $html);

        $fcol = $df->color('#ddd');
        $b = $b->withForegroundColor($fcol);
        $html = $this->normalizeHTML($r->render($b));
        $expected = '<a class="btn btn-tag btn-tag-relevance-veryhigh" style="background-color: #00ff00; color: #dddddd;" href="#" data-action="#">tag</a>';
        $this->assertEquals($expected, $html);
    }

Here is the call graph for this function:

test_render_btn_tag_relevance()

ButtonTest::test_render_btn_tag_relevance

(

)

Definition at line 265 of file ButtonTest.php.

References $html, $r, $t, $w, array, getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS_UI_TestBase\normalizeHTML().

    {
        $expectations = array(
            '<a class="btn btn-tag btn-tag-relevance-verylow" href="#" data-action="#">tag</a>',
            '<a class="btn btn-tag btn-tag-relevance-low" href="#" data-action="#">tag</a>',
            '<a class="btn btn-tag btn-tag-relevance-middle" href="#" data-action="#">tag</a>',
            '<a class="btn btn-tag btn-tag-relevance-high" href="#" data-action="#">tag</a>',
            '<a class="btn btn-tag btn-tag-relevance-veryhigh" href="#" data-action="#">tag</a>'
        );

        $f = $this->getButtonFactory();
        $r = $this->getDefaultRenderer();
        $t = $f->tag('tag', '#');
        $possible_relevances = array(
            $t::REL_VERYLOW,
            $t::REL_LOW,
            $t::REL_MID,
            $t::REL_HIGH,
            $t::REL_VERYHIGH
        );
        foreach ($possible_relevances as $w) {
            $html = $this->normalizeHTML(
                $r->render($t->withRelevance($w))
            );
            $expected = $expectations[array_search($w, $possible_relevances)];
            $this->assertEquals($expected, $html);
        }
    }

Here is the call graph for this function:

test_render_button_disabled()

ButtonTest::test_render_button_disabled

(

$factory_method

)

button_type_provider

Definition at line 164 of file ButtonTest.php.

References $html, $r, ILIAS_UI_TestBase\assertHTMLEquals(), getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS_UI_TestBase\normalizeHTML().

    {
        $ln = "http://www.ilias.de";
        $f = $this->getButtonFactory();
        $b = $f->$factory_method("label", $ln)
                ->withUnavailableAction();
        $r = $this->getDefaultRenderer();

        $html = $this->normalizeHTML($r->render($b));

        $css_classes = self::$canonical_css_classes[$factory_method];
        $css_class_inactive = self::$canonical_css_inactivation_classes[$factory_method];
        $expected = "<a class=\"$css_classes $css_class_inactive\" data-action=\"$ln\">" .
                    "label" .
                    "</a>";
        $this->assertHTMLEquals($expected, $html);
    }

Here is the call graph for this function:

test_render_button_label()

ButtonTest::test_render_button_label

(

$factory_method

)

button_type_provider

Definition at line 145 of file ButtonTest.php.

References $html, $r, ILIAS_UI_TestBase\assertHTMLEquals(), getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS_UI_TestBase\normalizeHTML().

    {
        $ln = "http://www.ilias.de";
        $f = $this->getButtonFactory();
        $b = $f->$factory_method("label", $ln);
        $r = $this->getDefaultRenderer();

        $html = $this->normalizeHTML($r->render($b));

        $css_classes = self::$canonical_css_classes[$factory_method];
        $expected = "<a class=\"$css_classes\" href=\"$ln\" data-action=\"$ln\">" .
                    "label" .
                    "</a>";
        $this->assertHTMLEquals($expected, $html);
    }

Here is the call graph for this function:

test_render_button_with_aria_checked()

ButtonTest::test_render_button_with_aria_checked

(

$factory_method

)

button_type_provider

Definition at line 378 of file ButtonTest.php.

References $html, $r, ILIAS_UI_TestBase\assertHTMLEquals(), getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS_UI_TestBase\normalizeHTML().

    {
        //only standard buttons have aria labels in the template. Should the others accept aria stuff?
        //if yes, remove this conditional
        if ($factory_method == "standard") {
            $ln = "http://www.ilias.de";
            $f = $this->getButtonFactory();
            $r = $this->getDefaultRenderer();
            $b = $f->$factory_method("label", $ln)->withAriaChecked();

            $html = $this->normalizeHTML($r->render($b));
            $css_classes = self::$canonical_css_classes[$factory_method];
            $expected = "<a class=\"$css_classes\" href=\"$ln\" aria-checked=\"true\" data-action=\"$ln\">" .
                "label" .
                "</a>";
            $this->assertHTMLEquals($expected, $html);
        }
    }

Here is the call graph for this function:

test_render_button_with_aria_label()

ButtonTest::test_render_button_with_aria_label

(

$factory_method

)

button_type_provider

Definition at line 355 of file ButtonTest.php.

References $html, $r, ILIAS_UI_TestBase\assertHTMLEquals(), getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS_UI_TestBase\normalizeHTML().

    {
        //only standard buttons have aria labels in the template. Should the others accept aria stuff?
        //if yes, remove this conditional
        if ($factory_method == "standard") {
            $ln = "http://www.ilias.de";
            $f = $this->getButtonFactory();
            $r = $this->getDefaultRenderer();
            $b = $f->$factory_method("label", $ln)->withAriaLabel("aria label text");
            $aria_label = $b->getAriaLabel();

            $html = $this->normalizeHTML($r->render($b));
            $css_classes = self::$canonical_css_classes[$factory_method];
            $expected = "<a class=\"$css_classes\" href=\"$ln\" aria-label=\"$aria_label\" data-action=\"$ln\">" .
                "label" .
                "</a>";
            $this->assertHTMLEquals($expected, $html);
        }
    }

Here is the call graph for this function:

test_render_button_with_on_load_code()

ButtonTest::test_render_button_with_on_load_code

(

$factory_method

)

button_type_provider

Definition at line 200 of file ButtonTest.php.

References $html, $id, $r, array, ILIAS_UI_TestBase\assertHTMLEquals(), getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS_UI_TestBase\normalizeHTML().

    {
        $ln = "http://www.ilias.de";
        $f = $this->getButtonFactory();
        $r = $this->getDefaultRenderer();
        $ids = array();
        $b = $f->$factory_method("label", $ln)
                ->withOnLoadCode(function ($id) use (&$ids) {
                    $ids[] = $id;
                    return "";
                });

        $html = $this->normalizeHTML($r->render($b));

        $this->assertCount(1, $ids);

        $id = $ids[0];
        $css_classes = self::$canonical_css_classes[$factory_method];
        $expected = "<a class=\"$css_classes\" href=\"$ln\" data-action=\"$ln\" id=\"$id\">" .
                    "label" .
                    "</a>";
        $this->assertHTMLEquals($expected, $html);
    }

Here is the call graph for this function:

test_render_close_button()

ButtonTest::test_render_close_button

(

)

Definition at line 182 of file ButtonTest.php.

References $html, $r, getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS_UI_TestBase\normalizeHTML().

    {
        $f = $this->getButtonFactory();
        $r = $this->getDefaultRenderer();
        $b = $f->close();

        $html = $this->normalizeHTML($r->render($b));

        $expected = "<button type=\"button\" class=\"close\" data-dismiss=\"modal\">" .
                    "   <span aria-hidden=\"true\">&times;</span>" .
                    "   <span class=\"sr-only\">Close</span>" .
                    "</button>";
        $this->assertEquals($expected, $html);
    }

Here is the call graph for this function:

Field Documentation

$canonical_css_classes

ButtonTest::$canonical_css_classes

static

Initial value:

= array( "standard" =>   "btn btn-default"
        , "primary"      =>      "btn btn-default btn-primary"
        , "shy"  =>      "btn btn-link"
        , "tag"  =>      "btn btn-tag btn-tag-relevance-veryhigh"
        )

Definition at line 20 of file ButtonTest.php.

$canonical_css_inactivation_classes

ButtonTest::$canonical_css_inactivation_classes

static

Initial value:

= array( "standard" =>  "ilSubmitInactive disabled"
        , "primary"     => "ilSubmitInactive disabled"
        , "shy" => "ilSubmitInactive disabled"
        , "tag" => "btn-tag-inactive"
        )

Definition at line 26 of file ButtonTest.php.

---

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

• tests/UI/Component/Button/ButtonTest.php