MessageBoxTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

require_once(__DIR__ . "/../../../../../../vendor/composer/vendor/autoload.php");
require_once(__DIR__ . "/../../Base.php");

use ILIAS\UI\Component as C;
use ILIAS\UI\Implementation\Component as IC;

class MessageBoxTest extends ILIAS_UI_TestBase
{
    public function getMessageBoxFactory(): IC\MessageBox\Factory
    {
        return new IC\MessageBox\Factory();
    }
    public function getButtonFactory(): IC\Button\Factory
    {
        return new IC\Button\Factory();
    }
    public function getLinkFactory(): IC\Link\Factory
    {
        return new IC\Link\Factory();
    }

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

    public static array $canonical_css_classes = 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"
    );

    public static array $canonical_role_types = array( C\MessageBox\MessageBox::FAILURE => "alert"
                                                        , C\MessageBox\MessageBox::SUCCESS => "status"
                                                        , C\MessageBox\MessageBox::INFO => "status"
                                                        , C\MessageBox\MessageBox::CONFIRMATION => "status"
    );

    public function getUIFactory(): NoUIFactory
    {
        return new class () extends NoUIFactory {
            public function listing(): IC\Listing\Factory
            {
                return new IC\Listing\Factory(
                    new IC\Listing\Workflow\Factory(),
                    new IC\Listing\CharacteristicValue\Factory(),
                    new IC\Listing\Entity\Factory(),
                );
            }
        };
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getMessageboxTypeProvider')]
    public function testImplementsFactoryInterface(string $factory_method): 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."));
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getMessageboxTypeProvider')]
    public function testMessageboxTypes(string $factory_method): void
    {
        $f = $this->getMessageBoxFactory();
        $g = $f->$factory_method("Lorem ipsum dolor sit amet.");

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

    #[\PHPUnit\Framework\Attributes\DataProvider('getMessageboxTypeProvider')]
    public function testMessageboxMessagetext(string $factory_method): 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());
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getMessageboxTypeProvider')]
    public function testWithButtons(string $factory_method): 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());
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getMessageboxTypeProvider')]
    public function testWithLinks(string $factory_method): 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());
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getMessageboxTypeProvider')]
    public function testWithButtonsAndLinks(string $factory_method): 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);
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getMessageboxTypeProvider')]
    public function testRenderSimple(string $factory_method): 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 name=\"il_message_focus\">" .
                    $g->getType() . "_message</a></div>Lorem ipsum dolor sit amet.</div>";
        $this->assertHTMLEquals($expected, $html);
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getMessageboxTypeProvider')]
    public function testRenderWithButtons(string $factory_method): 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 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);
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getMessageboxTypeProvider')]
    public function testRenderWithLinks(string $factory_method): 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 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);
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getMessageboxTypeProvider')]
    public function testRenderWithButtonsAndLinks(string $factory_method): 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 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);
    }
}