MessageBoxTest Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for MessageBoxTest:

Collaboration diagram for MessageBoxTest:

Public Member Functions
	getMessageBoxFactory ()
	getButtonFactory ()
	getLinkFactory ()
	messagebox_type_provider ()
	getUIFactory ()
	test_implements_factory_interface (string $factory_method)
	messagebox_type_provider More...
	test_messagebox_types (string $factory_method)
	messagebox_type_provider More...
	test_messagebox_messagetext (string $factory_method)
	messagebox_type_provider More...
	test_with_buttons (string $factory_method)
	messagebox_type_provider More...
	test_with_links (string $factory_method)
	messagebox_type_provider More...
	test_with_buttons_and_links (string $factory_method)
	messagebox_type_provider More...
	test_render_simple (string $factory_method)
	messagebox_type_provider More...
	test_render_with_buttons (string $factory_method)
	messagebox_type_provider More...
	test_render_with_links (string $factory_method)
	messagebox_type_provider More...
	test_render_with_buttons_and_links (string $factory_method)
	messagebox_type_provider More...
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	$canonical_role_types

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Test on Message Box implementation.

Definition at line 30 of file MessageBoxTest.php.

Member Function Documentation

getButtonFactory()

MessageBoxTest::getButtonFactory

(

)

Definition at line 36 of file MessageBoxTest.php.

Referenced by test_render_with_buttons(), test_render_with_buttons_and_links(), test_with_buttons(), and test_with_buttons_and_links().

                                      : IC\Button\Factory
    {
        return new IC\Button\Factory();
    }

Here is the caller graph for this function:

getLinkFactory()

MessageBoxTest::getLinkFactory

(

)

Definition at line 40 of file MessageBoxTest.php.

Referenced by test_render_with_buttons_and_links(), test_render_with_links(), test_with_buttons_and_links(), and test_with_links().

                                    : IC\Link\Factory
    {
        return new IC\Link\Factory();
    }

Here is the caller graph for this function:

getMessageBoxFactory()

MessageBoxTest::getMessageBoxFactory

(

)

Definition at line 32 of file MessageBoxTest.php.

Referenced by test_implements_factory_interface(), test_messagebox_messagetext(), test_messagebox_types(), test_render_simple(), test_render_with_buttons(), test_render_with_buttons_and_links(), test_render_with_links(), test_with_buttons(), test_with_buttons_and_links(), and test_with_links().

                                          : IC\MessageBox\Factory
    {
        return new IC\MessageBox\Factory();
    }

Here is the caller graph for this function:

getUIFactory()

MessageBoxTest::getUIFactory

(

)

Definition at line 66 of file MessageBoxTest.php.

                                  : NoUIFactory
    {
        return new class () extends NoUIFactory {
            public function listing(): IC\Listing\Factory
            {
                return new IC\Listing\Factory();
            }
        };
    }

messagebox_type_provider()

MessageBoxTest::messagebox_type_provider

(

)

Definition at line 45 of file MessageBoxTest.php.

                                              : array
    {
        return array( array(C\MessageBox\MessageBox::FAILURE)
        , array(C\MessageBox\MessageBox::SUCCESS)
        , array(C\MessageBox\MessageBox::INFO)
        , array(C\MessageBox\MessageBox::CONFIRMATION)
        );
    }

test_implements_factory_interface()

MessageBoxTest::test_implements_factory_interface

(

string

$factory_method

)

messagebox_type_provider

Definition at line 79 of file MessageBoxTest.php.

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

                                                                             : void
    {
        $f = $this->getMessageBoxFactory();

        $this->assertInstanceOf("ILIAS\\UI\\Component\\MessageBox\\Factory", $f);
        $this->assertInstanceOf("ILIAS\\UI\\Component\\MessageBox\\MessageBox", $f->$factory_method("Lorem ipsum dolor sit amet."));
    }

Here is the call graph for this function:

test_messagebox_messagetext()

MessageBoxTest::test_messagebox_messagetext

(

string

$factory_method

)

messagebox_type_provider

Definition at line 102 of file MessageBoxTest.php.

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

                                                                       : void
    {
        $f = $this->getMessageBoxFactory();
        $g = $f->$factory_method("Lorem ipsum dolor sit amet.");

        $this->assertNotNull($g);
        $this->assertEquals("Lorem ipsum dolor sit amet.", $g->getMessageText());
    }

Here is the call graph for this function:

test_messagebox_types()

MessageBoxTest::test_messagebox_types

(

string

$factory_method

)

messagebox_type_provider

Definition at line 90 of file MessageBoxTest.php.

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

                                                                 : void
    {
        $f = $this->getMessageBoxFactory();
        $g = $f->$factory_method("Lorem ipsum dolor sit amet.");

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

Here is the call graph for this function:

test_render_simple()

MessageBoxTest::test_render_simple

(

string

$factory_method

)

messagebox_type_provider

Definition at line 170 of file MessageBoxTest.php.

References Vendor\Package\$f, ILIAS_UI_TestBase\assertHTMLEquals(), ILIAS_UI_TestBase\getDefaultRenderer(), getMessageBoxFactory(), and ILIAS_UI_TestBase\normalizeHTML().

                                                              : void
    {
        $f = $this->getMessageBoxFactory();
        $r = $this->getDefaultRenderer();
        $g = $f->$factory_method("Lorem ipsum dolor sit amet.");
        $css_classes = self::$canonical_css_classes[$factory_method];
        $role_type = self::$canonical_role_types[$factory_method];

        $html = $this->normalizeHTML($r->render($g));
        $expected = "<div class=\"alert $css_classes\" role=\"$role_type\">" .
                    "<div class=\"ilAccHeadingHidden\"><a id=\"il_message_focus\" name=\"il_message_focus\">" .
                    $g->getType() . "_message</a></div>Lorem ipsum dolor sit amet.</div>";
        $this->assertHTMLEquals($expected, $html);
    }

Here is the call graph for this function:

test_render_with_buttons()

MessageBoxTest::test_render_with_buttons

(

string

$factory_method

)

messagebox_type_provider

Definition at line 188 of file MessageBoxTest.php.

References Vendor\Package\$f, ILIAS_UI_TestBase\assertHTMLEquals(), getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), getMessageBoxFactory(), and ILIAS_UI_TestBase\normalizeHTML().

                                                                    : void
    {
        $f = $this->getMessageBoxFactory();
        $bf = $this->getButtonFactory();
        $r = $this->getDefaultRenderer();
        $css_classes = self::$canonical_css_classes[$factory_method];
        $role_type = self::$canonical_role_types[$factory_method];

        $buttons = [$bf->standard("Confirm", "#"), $bf->standard("Cancel", "#")];

        $g = $f->$factory_method("Lorem ipsum dolor sit amet.")->withButtons($buttons);

        $html = $this->normalizeHTML($r->render($g));
        $expected = "<div class=\"alert $css_classes\" role=\"$role_type\">" .
                    "<div class=\"ilAccHeadingHidden\"><a id=\"il_message_focus\" name=\"il_message_focus\">" .
                    $g->getType() . "_message</a></div>Lorem ipsum dolor sit amet." .
                    "<div><button class=\"btn btn-default\"   data-action=\"#\" id=\"id_1\">Confirm</button>" .
                    "<button class=\"btn btn-default\"   data-action=\"#\" id=\"id_2\">Cancel</button></div></div>";
        $this->assertHTMLEquals($expected, $html);
    }

Here is the call graph for this function:

test_render_with_buttons_and_links()

MessageBoxTest::test_render_with_buttons_and_links

(

string

$factory_method

)

messagebox_type_provider

Definition at line 239 of file MessageBoxTest.php.

References Vendor\Package\$f, ILIAS_UI_TestBase\assertHTMLEquals(), getButtonFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), getLinkFactory(), getMessageBoxFactory(), and ILIAS_UI_TestBase\normalizeHTML().

                                                                              : void
    {
        $f = $this->getMessageBoxFactory();
        $bf = $this->getButtonFactory();
        $lf = $this->getLinkFactory();
        $r = $this->getDefaultRenderer();
        $css_classes = self::$canonical_css_classes[$factory_method];
        $role_type = self::$canonical_role_types[$factory_method];

        $buttons = [$bf->standard("Confirm", "#"), $bf->standard("Cancel", "#")];
        $links = [
            $lf->standard("Open Exercise Assignment", "#"),
            $lf->standard("Open other screen", "#"),
        ];

        $g = $f->$factory_method("Lorem ipsum dolor sit amet.")->withButtons($buttons)->withLinks($links);

        $html = $this->normalizeHTML($r->render($g));
        $expected = "<div class=\"alert $css_classes\" role=\"$role_type\">" .
                    "<div class=\"ilAccHeadingHidden\"><a id=\"il_message_focus\" name=\"il_message_focus\">" .
                    $g->getType() . "_message</a></div>Lorem ipsum dolor sit amet." .
                    "<div><button class=\"btn btn-default\"   data-action=\"#\" id=\"id_1\">Confirm</button>" .
                    "<button class=\"btn btn-default\"   data-action=\"#\" id=\"id_2\">Cancel</button></div>" .
                    "<ul><li><a href=\"#\" >Open Exercise Assignment</a></li>" .
                    "<li><a href=\"#\" >Open other screen</a></li></ul></div>";
        $this->assertHTMLEquals($expected, $html);
    }

Here is the call graph for this function:

test_render_with_links()

MessageBoxTest::test_render_with_links

(

string

$factory_method

)

messagebox_type_provider

Definition at line 212 of file MessageBoxTest.php.

References Vendor\Package\$f, ILIAS_UI_TestBase\assertHTMLEquals(), ILIAS_UI_TestBase\getDefaultRenderer(), getLinkFactory(), getMessageBoxFactory(), and ILIAS_UI_TestBase\normalizeHTML().

                                                                  : void
    {
        $f = $this->getMessageBoxFactory();
        $lf = $this->getLinkFactory();
        $r = $this->getDefaultRenderer();
        $css_classes = self::$canonical_css_classes[$factory_method];
        $role_type = self::$canonical_role_types[$factory_method];

        $links = [
            $lf->standard("Open Exercise Assignment", "#"),
            $lf->standard("Open other screen", "#"),
        ];

        $g = $f->$factory_method("Lorem ipsum dolor sit amet.")->withLinks($links);

        $html = $this->normalizeHTML($r->render($g));
        $expected = "<div class=\"alert $css_classes\" role=\"$role_type\">" .
                    "<div class=\"ilAccHeadingHidden\"><a id=\"il_message_focus\" name=\"il_message_focus\">" .
                    $g->getType() . "_message</a></div>Lorem ipsum dolor sit amet." .
                    "<ul><li><a href=\"#\" >Open Exercise Assignment</a></li>" .
                    "<li><a href=\"#\" >Open other screen</a></li></ul></div>";
        $this->assertHTMLEquals($expected, $html);
    }

Here is the call graph for this function:

test_with_buttons()

MessageBoxTest::test_with_buttons

(

string

$factory_method

)

messagebox_type_provider

Definition at line 114 of file MessageBoxTest.php.

References Vendor\Package\$f, getButtonFactory(), and getMessageBoxFactory().

                                                             : void
    {
        $f = $this->getMessageBoxFactory();
        $bf = $this->getButtonFactory();
        $g = $f->$factory_method("Lorem ipsum dolor sit amet.");

        $buttons = [$bf->standard("Confirm", "#"), $bf->standard("Cancel", "#")];
        $g2 = $g->withButtons($buttons);

        $this->assertEmpty($g->getButtons());
        $this->assertNotEmpty($g2->getButtons());
    }

Here is the call graph for this function:

test_with_buttons_and_links()

MessageBoxTest::test_with_buttons_and_links

(

string

$factory_method

)

messagebox_type_provider

Definition at line 149 of file MessageBoxTest.php.

References Vendor\Package\$f, getButtonFactory(), getLinkFactory(), and getMessageBoxFactory().

                                                                       : void
    {
        $f = $this->getMessageBoxFactory();
        $bf = $this->getButtonFactory();
        $lf = $this->getLinkFactory();
        $g = $f->$factory_method("Lorem ipsum dolor sit amet.");

        $buttons = [$bf->standard("Confirm", "#"), $bf->standard("Cancel", "#")];
        $links = [
            $lf->standard("Open Exercise Assignment", "#"),
            $lf->standard("Open other screen", "#"),
        ];
        $g2 = $g->withButtons($buttons)->withLinks($links);

        $this->assertFalse(count($g->getButtons()) > 0 && count($g->getLinks()) > 0);
        $this->assertTrue(count($g2->getButtons()) > 0 && count($g2->getLinks()) > 0);
    }

Here is the call graph for this function:

test_with_links()

MessageBoxTest::test_with_links

(

string

$factory_method

)

messagebox_type_provider

Definition at line 130 of file MessageBoxTest.php.

References Vendor\Package\$f, getLinkFactory(), and getMessageBoxFactory().

                                                           : void
    {
        $f = $this->getMessageBoxFactory();
        $lf = $this->getLinkFactory();
        $g = $f->$factory_method("Lorem ipsum dolor sit amet.");

        $links = [
            $lf->standard("Open Exercise Assignment", "#"),
            $lf->standard("Open other screen", "#"),
        ];
        $g2 = $g->withLinks($links);

        $this->assertEmpty($g->getLinks());
        $this->assertNotEmpty($g2->getLinks());
    }

Here is the call graph for this function:

Field Documentation

$canonical_css_classes

array MessageBoxTest::$canonical_css_classes

static

Initial value:

= array( C\MessageBox\MessageBox::FAILURE => "alert-danger"
    , C\MessageBox\MessageBox::SUCCESS => "alert-success"
    , C\MessageBox\MessageBox::INFO => "alert-info"
    , C\MessageBox\MessageBox::CONFIRMATION => "alert-warning"
    )

Definition at line 54 of file MessageBoxTest.php.

$canonical_role_types

array MessageBoxTest::$canonical_role_types

static

Initial value:

= array( C\MessageBox\MessageBox::FAILURE => "alert"
                                                        , C\MessageBox\MessageBox::SUCCESS => "status"
                                                        , C\MessageBox\MessageBox::INFO => "status"
                                                        , C\MessageBox\MessageBox::CONFIRMATION => "status"
    )

Definition at line 60 of file MessageBoxTest.php.

---

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

• tests/UI/Component/MessageBox/MessageBoxTest.php