PanelSecondaryListingTest Class Reference

Test secondary listing panels. More...

Inheritance diagram for PanelSecondaryListingTest:

Collaboration diagram for PanelSecondaryListingTest:

Public Member Functions
	getUIFactory ()
	testImplementsFactoryInterface ()
	testGetTitle ()
	testGetItemGroups ()
	testWithActions ()
	testRenderWithActions ()
	testRenderWithSortation ()
	testRenderWithPagination ()
	testRenderWithSection ()
	testRenderWithFooter ()
	testRenderWithNoHeaderButContent ()
	testRenderWithNoHeaderNoContentNoFooter ()
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)

Protected Member Functions
	cleanHTML (string $html)
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 secondary listing panels.

Definition at line 31 of file PanelSecondaryListingTest.php.

Member Function Documentation

cleanHTML()

PanelSecondaryListingTest::cleanHTML ( string  $html )

protected

Definition at line 67 of file PanelSecondaryListingTest.php.

Referenced by testRenderWithFooter().

                                              : string
    {
        $html = str_replace(["\n", "\t"], "", $html);

        return trim($html);
    }

Here is the caller graph for this function:

getUIFactory()

PanelSecondaryListingTest::getUIFactory

(

)

Definition at line 33 of file PanelSecondaryListingTest.php.

References ILIAS\Repository\button(), and ILIAS\Repository\symbol().

Referenced by testGetItemGroups(), testGetTitle(), testImplementsFactoryInterface(), testRenderWithActions(), testRenderWithFooter(), testRenderWithNoHeaderButContent(), testRenderWithNoHeaderNoContentNoFooter(), testRenderWithPagination(), testRenderWithSection(), testRenderWithSortation(), and testWithActions().

                                  : NoUIFactory
    {
        return new class () extends NoUIFactory {
            public function panelSecondary(): I\Component\Panel\Secondary\Factory
            {
                return new I\Component\Panel\Secondary\Factory();
            }

            public function dropdown(): C\Dropdown\Factory
            {
                return new I\Component\Dropdown\Factory();
            }

            public function viewControl(): C\ViewControl\Factory
            {
                return new I\Component\ViewControl\Factory(new SignalGenerator());
            }

            public function button(): C\Button\Factory
            {
                return new I\Component\Button\Factory();
            }

            public function symbol(): C\Symbol\Factory
            {
                return new I\Component\Symbol\Factory(
                    new I\Component\Symbol\Icon\Factory(),
                    new I\Component\Symbol\Glyph\Factory(),
                    new I\Component\Symbol\Avatar\Factory()
                );
            }
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

testGetItemGroups()

PanelSecondaryListingTest::testGetItemGroups

(

)

Definition at line 107 of file PanelSecondaryListingTest.php.

References Vendor\Package\$c, getUIFactory(), and ILIAS\UI\Implementation\Component\Input\Group.

                                       : void
    {
        $groups = array(
            new I\Component\Item\Group("Subtitle 1", array(
                new I\Component\Item\Standard("title1"),
                new I\Component\Item\Standard("title2")
            )),
            new I\Component\Item\Group("Subtitle 2", array(
                new I\Component\Item\Standard("title3")
            ))
        );

        $c = $this->getUIFactory()->panelSecondary()->listing("title", $groups);

        $this->assertEquals($c->getItemGroups(), $groups);
    }

Here is the call graph for this function:

testGetTitle()

PanelSecondaryListingTest::testGetTitle

(

)

Definition at line 90 of file PanelSecondaryListingTest.php.

References Vendor\Package\$c, getUIFactory(), and ILIAS\UI\Implementation\Component\Input\Group.

                                  : void
    {
        $groups = array(
            new I\Component\Item\Group("Subtitle 1", array(
                new I\Component\Item\Standard("title1"),
                new I\Component\Item\Standard("title2")
            )),
            new I\Component\Item\Group("Subtitle 2", array(
                new I\Component\Item\Standard("title3")
            ))
        );

        $c = $this->getUIFactory()->panelSecondary()->listing("title", $groups);

        $this->assertEquals("title", $c->getTitle());
    }

Here is the call graph for this function:

testImplementsFactoryInterface()

PanelSecondaryListingTest::testImplementsFactoryInterface

(

)

Definition at line 74 of file PanelSecondaryListingTest.php.

References getUIFactory(), and ILIAS\UI\Implementation\Component\Input\Group.

                                                    : void
    {
        $secondary_panel = $this->getUIFactory()->panelSecondary()->listing("List Title", array(

            new I\Component\Item\Group("Subtitle 1", array(
                new I\Component\Item\Standard("title1"),
                new I\Component\Item\Standard("title2")
            )),
            new I\Component\Item\Group("Subtitle 2", array(
                new I\Component\Item\Standard("title3")
            ))
        ));

        $this->assertInstanceOf("ILIAS\\UI\\Component\\Panel\\Secondary\\Listing", $secondary_panel);
    }

Here is the call graph for this function:

testRenderWithActions()

PanelSecondaryListingTest::testRenderWithActions

(

)

Definition at line 141 of file PanelSecondaryListingTest.php.

References ILIAS_UI_TestBase\brutallyTrimHTML(), ILIAS\Repository\button(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUIFactory().

                                           : void
    {
        $actions = $this->getUIFactory()->dropdown()->standard(array(
            $this->getUIFactory()->button()->shy("ILIAS", "https://www.ilias.de"),
            $this->getUIFactory()->button()->shy("Github", "https://www.github.com")
        ));

        $sec = $this->getUIFactory()->panelSecondary()->listing("Title", array())->withActions($actions);

        $html = $this->getDefaultRenderer()->render($sec);

        $expected_html = <<<EOT
<div class="panel panel-secondary panel-flex">
    <div class="panel-heading ilHeader">
        <div class="panel-title"><h2>Title</h2></div>
        <div class="panel-controls">
            <div class="dropdown"><button class="btn btn-default dropdown-toggle" type="button" data-toggle="dropdown" id="id_3" aria-label="actions" aria-haspopup="true" aria-expanded="false" aria-controls="id_3_menu"><span class="caret"></span></button>
                <ul id="id_3_menu" class="dropdown-menu">
                    <li><button class="btn btn-link" data-action="https://www.ilias.de" id="id_1">ILIAS</button></li>
                    <li><button class="btn btn-link" data-action="https://www.github.com" id="id_2">Github</button></li>
                </ul>
            </div>
        </div>
    </div>
    <div class="panel-body">
    </div>
</div>
EOT;
        $this->assertEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($html)
        );
    }

Here is the call graph for this function:

testRenderWithFooter()

PanelSecondaryListingTest::testRenderWithFooter

(

)

Definition at line 302 of file PanelSecondaryListingTest.php.

References ILIAS_UI_TestBase\assertHTMLEquals(), ILIAS\Repository\button(), cleanHTML(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUIFactory().

                                          : void
    {
        $footer_shy_button = $this->getUIFactory()->button()->shy("Action", "");
        $secondary_panel = $this->getUIFactory()->panelSecondary()->listing("", array())->withFooter($footer_shy_button);

        $html = $this->getDefaultRenderer()->render($secondary_panel);

        $expected_html = <<<EOT
<div class="panel panel-secondary panel-flex">\n
<div class="panel-body"></div>\n
<div class="panel-footer ilBlockInfo"><button class="btn btn-link" data-action="">Action</button></div>\n
</div>\n

EOT;
        $this->assertHTMLEquals(
            $this->cleanHTML($expected_html),
            $this->cleanHTML($html)
        );
    }

Here is the call graph for this function:

testRenderWithNoHeaderButContent()

PanelSecondaryListingTest::testRenderWithNoHeaderButContent

(

)

Definition at line 322 of file PanelSecondaryListingTest.php.

References ILIAS_UI_TestBase\assertHTMLEquals(), ILIAS_UI_TestBase\brutallyTrimHTML(), ILIAS_UI_TestBase\getDefaultRenderer(), getUIFactory(), and ILIAS\UI\Implementation\Component\Input\Group.

                                                      : void
    {
        $group = new I\Component\Item\Group(
            "Subtitle 1",
            array(
                new I\Component\Item\Standard("title1"),
                new I\Component\Item\Standard("title2"))
        );

        $secondary_panel = $this->getUIFactory()->panelSecondary()->listing("", array($group));

        $html = $this->getDefaultRenderer()->render($secondary_panel);

        $expected_html = <<<EOT
<div class="panel panel-secondary panel-flex">
  <div class="panel-body">
    <div class="il-item-group">
      <h3>Subtitle 1</h3>
      <div class="il-item-group-items">
        <ul>
            <li class="il-std-item-container">
              <div class="il-item il-std-item ">
                <h4 class="il-item-title">title1</h4>
              </div>
            </li>
            <li class="il-std-item-container">
              <div class="il-item il-std-item ">
                <h4 class="il-item-title">title2</h4>
              </div>
            </li>
        </ul>
      </div>
    </div>
  </div>
</div>
EOT;
        $this->assertHTMLEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($html)
        );
    }

Here is the call graph for this function:

testRenderWithNoHeaderNoContentNoFooter()

PanelSecondaryListingTest::testRenderWithNoHeaderNoContentNoFooter

(

)

Definition at line 364 of file PanelSecondaryListingTest.php.

References ILIAS_UI_TestBase\getDefaultRenderer(), and getUIFactory().

                                                             : void
    {
        $secondary_panel = $this->getUIFactory()->panelSecondary()->listing("", array());

        $html = $this->getDefaultRenderer()->render($secondary_panel);

        $this->assertEquals("", $html);
    }

Here is the call graph for this function:

testRenderWithPagination()

PanelSecondaryListingTest::testRenderWithPagination

(

)

Definition at line 216 of file PanelSecondaryListingTest.php.

References ILIAS_UI_TestBase\brutallyTrimHTML(), ILIAS\Repository\button(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUIFactory().

                                              : void
    {
        $pagination = $this->getUIFactory()->viewControl()->pagination()
            ->withTargetURL('http://ilias.de', 'page')
            ->withTotalEntries(10)
            ->withPageSize(2)
            ->withCurrentPage(1);

        $sec = $this->getUIFactory()->panelSecondary()->listing("Title", array())
            ->withViewControls([$pagination]);

        $html = $this->getDefaultRenderer()->render($sec);

        $expected_html = <<<EOT
<div class="panel panel-secondary panel-flex">
    <div class="panel-heading ilHeader">
        <div class="panel-title"><h2>Title</h2></div>
        <div class="panel-viewcontrols l-bar__space-keeper">
            <div class="il-viewcontrol-pagination l-bar__element">
                <span class="btn btn-ctrl browse previous">
                    <a tabindex="0" class="glyph" href="http://ilias.de?page=0" aria-label="back">
                        <span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
                    </a>
                </span>
                <button class="btn btn-link" data-action="http://ilias.de?page=0" id="id_1">1</button>
                <button class="btn btn-link engaged" aria-pressed="true" data-action="http://ilias.de?page=1" id="id_2">2</button>
                <button class="btn btn-link" data-action="http://ilias.de?page=2" id="id_3">3</button>
                <button class="btn btn-link" data-action="http://ilias.de?page=3" id="id_4">4</button>
                <button class="btn btn-link" data-action="http://ilias.de?page=4" id="id_5">5</button>
                <span class="btn btn-ctrl browse next">
                    <a tabindex="0" class="glyph" href="http://ilias.de?page=2" aria-label="next">
                        <span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
                    </a>
                </span>
            </div>
        </div>
        <div class="panel-controls"></div>
    </div>
    <div class="panel-body">
    </div>
</div>
EOT;
        $this->assertEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($html)
        );
    }

Here is the call graph for this function:

testRenderWithSection()

PanelSecondaryListingTest::testRenderWithSection

(

)

Definition at line 264 of file PanelSecondaryListingTest.php.

References ILIAS_UI_TestBase\brutallyTrimHTML(), ILIAS\Repository\button(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUIFactory().

                                           : void
    {
        $back = $this->getUIFactory()->button()->standard("previous", "http://www.ilias.de");
        $next = $this->getUIFactory()->button()->standard("next", "http://www.github.com");
        $current = $this->getUIFactory()->button()->standard("current", "");
        $section = $this->getUIFactory()->viewControl()->section($back, $current, $next);

        $secondary_panel = $this->getUIFactory()->panelSecondary()->listing("Title", array())
            ->withViewControls([$section]);

        $html = $this->getDefaultRenderer()->render($secondary_panel);

        $expected_html = <<<EOT
<div class="panel panel-secondary panel-flex">
    <div class="panel-heading ilHeader">
        <div class="panel-title"><h2>Title</h2></div>
        <div class="panel-viewcontrols l-bar__space-keeper">
            <div class="il-viewcontrol-section l-bar__element">
                <a class="btn btn-ctrl browse previous" href="http://www.ilias.de" aria-label="previous" data-action="http://www.ilias.de" id="id_1">
                    <span class="glyphicon glyphicon-chevron-left"></span>
                </a>
                <button class="btn btn-default" data-action="">current</button>
                <a class="btn btn-ctrl browse next" href="http://www.github.com" aria-label="next" data-action="http://www.github.com" id="id_2">
                    <span class="glyphicon glyphicon-chevron-right"></span>
                </a>
            </div>
        </div>
        <div class="panel-controls"></div>
    </div>
    <div class="panel-body">
    </div>
</div>
EOT;
        $this->assertEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($html)
        );
    }

Here is the call graph for this function:

testRenderWithSortation()

PanelSecondaryListingTest::testRenderWithSortation

(

)

Definition at line 175 of file PanelSecondaryListingTest.php.

References ILIAS_UI_TestBase\brutallyTrimHTML(), ILIAS\Repository\button(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUIFactory().

                                             : void
    {
        $sort_options = array(
            'a' => 'A',
            'b' => 'B'
        );
        $sortation = $this->getUIFactory()->viewControl()->sortation($sort_options);
        $sec = $this->getUIFactory()->panelSecondary()->listing("Title", array())
            ->withViewControls([$sortation]);

        $html = $this->getDefaultRenderer()->render($sec);

        $expected_html = <<<EOT
<div class="panel panel-secondary panel-flex">
    <div class="panel-heading ilHeader">
        <div class="panel-title"><h2>Title</h2></div>
        <div class="panel-viewcontrols l-bar__space-keeper">
            <div class="il-viewcontrol-sortation l-bar__element" id="id_1">
                <div class="dropdown">
                    <button class="btn btn-default dropdown-toggle" type="button" data-toggle="dropdown" id="id_4" aria-label="actions" aria-haspopup="true" aria-expanded="false" aria-controls="id_4_menu">
                        <span class="caret"></span>
                    </button>
                    <ul id="id_4_menu" class="dropdown-menu">
                        <li><button class="btn btn-link" data-action="?sortation=a" id="id_2">A</button></li>
                        <li><button class="btn btn-link" data-action="?sortation=b" id="id_3">B</button></li>
                    </ul>
                </div>
            </div>
        </div>
        <div class="panel-controls"></div>
    </div>
    <div class="panel-body">
    </div>
</div>
EOT;
        $this->assertEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($html)
        );
    }

Here is the call graph for this function:

testWithActions()

PanelSecondaryListingTest::testWithActions

(

)

Definition at line 124 of file PanelSecondaryListingTest.php.

References Vendor\Package\$c, and getUIFactory().

                                     : void
    {
        $actions = new I\Component\Dropdown\Standard(array(
            new I\Component\Button\Shy("ILIAS", "https://www.ilias.de"),
            new I\Component\Button\Shy("GitHub", "https://www.github.com")
        ));

        $groups = array();

        $c = $this->getUIFactory()->panelSecondary()->listing("title", $groups)
            ->withActions($actions);

        $this->assertEquals($c->getActions(), $actions);
    }

Here is the call graph for this function:

---

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

• tests/UI/Component/Panel/PanelSecondaryListingTest.php