Tests for the Standard Page. More...

Inheritance diagram for StandardPageTest:

Collaboration diagram for StandardPageTest:

Public Member Functions
	setUp ()

	testConstruction ()

	testGetContent ()

	testGetMetabar ()

	testGetMainbar ()

	testGetBreadcrumbs ()

	testGetLogo ()

	testHasLogo ()

	testGetResponsiveLogo ()

	testHasResponsiveLogo ()

	testWithFaviconPath ()

	testGetOverlay ()

	testWithWrongContents ()

	testGetTitle ()

	testWithTitle ()

	testWithShortTitle ()

	testWithViewTitle ()

	testWithTextDirection ()

	testWithMetaDatum ()

	testRenderingWithTitle ()

	testRenderingWithRtlLanguage ()

	testRenderingWithMetaData ()

	getUIFactory ()

	getDataFactory ()

	testRenderingWithCrumbs ()

	getMockedTag (string $html)

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 Attributes
Page Standard	$stdpage

Page Factory	$factory

MainBar	$mainbar

MetaBar	$metabar

Breadcrumbs	$crumbs

Image	$logo

Image	$responsive_logo

Container	$overlay

string	$title

array	$contents

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

Tests for the Standard Page.

Definition at line 43 of file StandardPageTest.php.

Member Function Documentation

◆ getDataFactory()

StandardPageTest::getDataFactory ( )

Definition at line 407 of file StandardPageTest.php.

                                     : DataFactory
     {
         return new DataFactory();
     }

◆ getMockedTag()

StandardPageTest::getMockedTag ( string $html )

Definition at line 486 of file StandardPageTest.php.

References ILIAS\MetaData\Repository\Validation\Data\__construct().

Referenced by testRenderingWithMetaData(), and testWithMetaDatum().

                                               : Html\Tag
     {
         return new class ($html) extends Html\Tag {
             public function __construct(
                 protected string $html
             ) {
             }
 
             public function toHtml(): string
             {
                 return $this->html;
             }
         };
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUIFactory()

StandardPageTest::getUIFactory ( )

Definition at line 392 of file StandardPageTest.php.

References ILIAS\Repository\button().

                                   : NoUIFactory
     {
         return new class () extends NoUIFactory {
             public function button(): \ILIAS\UI\Component\Button\Factory
             {
                 return new Button\Factory();
             }
 
             public function dropdown(): Factory
             {
                 return new Dropdown\Factory();
             }
         };
     }

Here is the call graph for this function:

◆ setUp()

StandardPageTest::setUp ( )

Definition at line 60 of file StandardPageTest.php.

References ILIAS\UI\examples\MainControls\MainBar\mainbar().

                            : void
     {
         $sig_gen = new SignalGenerator();
         $this->metabar = $this->createMock(MetaBar::class);
         $this->metabar->method("getCanonicalName")->willReturn("MetaBar Stub");
         $this->mainbar = $this->createMock(MainBar::class);
         $this->mainbar->method("getCanonicalName")->willReturn("MainBar Stub");
         $this->crumbs = $this->createMock(Breadcrumbs::class);
         $this->crumbs->method("getCanonicalName")->willReturn("Breadcrumbs Stub");
         $this->logo = $this->createMock(Image::class);
         $this->logo->method("getCanonicalName")->willReturn("Logo Stub");
         $this->responsive_logo = $this->createMock(Image::class);
         $this->responsive_logo->method("getCanonicalName")->willReturn("Responsive Logo Stub");
         $this->overlay = $this->createMock(Container::class);
         $this->overlay->method("getCanonicalName")->willReturn("Overlay Stub");
         $this->contents = array(new Legacy('some content', $sig_gen));
         $this->title = 'pagetitle';
 
         $this->factory = new Page\Factory();
         $this->stdpage = $this->factory->standard(
             $this->contents,
             $this->metabar,
             $this->mainbar,
             $this->crumbs,
             $this->logo,
             $this->responsive_logo,
             'logo/favicon.ico',
             $this->overlay,
             null,
             $this->title
         );
     }

Here is the call graph for this function:

◆ testConstruction()

StandardPageTest::testConstruction ( )

Definition at line 93 of file StandardPageTest.php.

                                       : void
     {
         $this->assertInstanceOf(
             "ILIAS\\UI\\Component\\Layout\\Page\\Standard",
             $this->stdpage
         );
     }

◆ testGetBreadcrumbs()

StandardPageTest::testGetBreadcrumbs ( )

Definition at line 125 of file StandardPageTest.php.

                                         : void
     {
         $this->assertEquals(
             $this->crumbs,
             $this->stdpage->getBreadcrumbs()
         );
     }

◆ testGetContent()

StandardPageTest::testGetContent ( )

Definition at line 101 of file StandardPageTest.php.

                                     : void
     {
         $this->assertEquals(
             $this->contents,
             $this->stdpage->getContent()
         );
     }

◆ testGetLogo()

StandardPageTest::testGetLogo ( )

Definition at line 133 of file StandardPageTest.php.

                                  : void
     {
         $this->assertEquals(
             $this->logo,
             $this->stdpage->getLogo()
         );
     }

◆ testGetMainbar()

StandardPageTest::testGetMainbar ( )

Definition at line 117 of file StandardPageTest.php.

References ILIAS\UI\examples\MainControls\MainBar\mainbar().

                                     : void
     {
         $this->assertEquals(
             $this->mainbar,
             $this->stdpage->getMainbar()
         );
     }

Here is the call graph for this function:

◆ testGetMetabar()

StandardPageTest::testGetMetabar ( )

Definition at line 109 of file StandardPageTest.php.

                                     : void
     {
         $this->assertEquals(
             $this->metabar,
             $this->stdpage->getMetabar()
         );
     }

◆ testGetOverlay()

StandardPageTest::testGetOverlay ( )

Definition at line 168 of file StandardPageTest.php.

                                     : void
     {
         $this->assertEquals(
             $this->overlay,
             $this->stdpage->getOverlay()
         );
     }

◆ testGetResponsiveLogo()

StandardPageTest::testGetResponsiveLogo ( )

Definition at line 146 of file StandardPageTest.php.

                                            : void
     {
         $this->assertEquals(
             $this->responsive_logo,
             $this->stdpage->getResponsiveLogo()
         );
     }

◆ testGetTitle()

StandardPageTest::testGetTitle ( )

Definition at line 188 of file StandardPageTest.php.

                                   : void
     {
         $this->assertEquals(
             $this->title,
             $this->stdpage->getTitle()
         );
     }

◆ testHasLogo()

StandardPageTest::testHasLogo ( )

Definition at line 141 of file StandardPageTest.php.

                                  : void
     {
         $this->assertTrue($this->stdpage->hasLogo());
     }

◆ testHasResponsiveLogo()

StandardPageTest::testHasResponsiveLogo ( )

Definition at line 154 of file StandardPageTest.php.

                                            : void
     {
         $this->assertTrue($this->stdpage->hasResponsiveLogo());
     }

◆ testRenderingWithCrumbs()

StandardPageTest::testRenderingWithCrumbs ( )

Definition at line 412 of file StandardPageTest.php.

References $r, ILIAS_UI_TestBase\brutallyTrimHTML(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS\UI\examples\MainControls\MainBar\mainbar().

                                              : void
     {
         $crumbs = new Crumbs([
             new CrumbEntry("label1", '#'),
             new CrumbEntry("label2", '#'),
             new CrumbEntry("label3", '#')
         ]);
         $r = $this->getDefaultRenderer(null, [$this->metabar, $this->mainbar, $this->logo, $this->overlay]);
 
         $stdpage = $this->factory->standard(
             $this->contents,
             $this->metabar,
             $this->mainbar,
             $crumbs,
             $this->logo,
             $this->responsive_logo,
             'logo/favicon.ico',
             $this->overlay,
             null,
             $this->title
         );
 
         $html = $this->brutallyTrimHTML($r->render($stdpage));
 
         $exptected = $this->brutallyTrimHTML(
             '<!DOCTYPE html>
 <html lang="en" dir="ltr">
 
 <head>
     <meta charset="utf-8" />
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <title>:</title>
     <link rel="icon" href="logo/favicon.ico" type="image/x-icon">
     <script type="application/javascript">var il = il ||{}; window.il = il;</script>
     <style></style>
 </head>
 
 <body>
     <div class="il-page-overlay">Overlay Stub</div>
     <div class="il-layout-page">
         <header>
             <div class="header-inner">
                 <div class="il-logo"><span class="hidden-xs">Logo Stub</span><span class="visible-xs-block">Responsive Logo Stub</span>
                     <div class="il-pagetitle">pagetitle</div>
                 </div>
                 <nav class="il-header-locator">
                     <div class="dropdown"><button class="btn btn-default dropdown-toggle" type="button" data-toggle="dropdown" id="id_3" aria-haspopup="true" aria-expanded="false" aria-controls="id_3_menu">label3<span class="caret"></span></button>
                         <ul id="id_3_menu" class="dropdown-menu">
                             <li><button class="btn btn-link" data-action="#" id="id_1">label2</button></li>
                             <li><button class="btn btn-link" data-action="#" id="id_2">label1</button></li>
                         </ul>
                     </div>
                 </nav>MetaBar Stub
             </div>
         </header>
         <div class="il-system-infos"></div>
         <div class="nav il-maincontrols">MainBar Stub</div>
         <main class="il-layout-page-content">
                 <div class="breadcrumbs">
                     <nav aria-label="breadcrumbs_aria_label" class="breadcrumb_wrapper">
                         <div class="breadcrumb"><span class="crumb"><a href="#">label1</a></span><span class="crumb"><a href="#">label2</a></span><span class="crumb"><a href="#">label3</a></span></div>
                     </nav>
                 </div>some content
         </main>
     </div>
     <script>il.Util.addOnLoad(function() {});</script>
 </body>
 
 </html>'
         );
         $this->assertEquals($exptected, $html);
     }

Here is the call graph for this function:

◆ testRenderingWithMetaData()

StandardPageTest::testRenderingWithMetaData ( )

Definition at line 339 of file StandardPageTest.php.

References $r, ILIAS_UI_TestBase\brutallyTrimHTML(), ILIAS_UI_TestBase\getDefaultRenderer(), getMockedTag(), and ILIAS\UI\examples\MainControls\MainBar\mainbar().

                                                : void
     {
         $meta_datum_1_html = 'test_html_1';
         $meta_datum_2_html = 'test_html_2';
         $meta_datum_1 = $this->getMockedTag($meta_datum_1_html);
         $meta_datum_2 = $this->getMockedTag($meta_datum_2_html);
 
         $this->stdpage = $this->stdpage->withAdditionalMetaDatum($meta_datum_1);
         $this->stdpage = $this->stdpage->withAdditionalMetaDatum($meta_datum_2);
 
         $r = $this->getDefaultRenderer(
             null,
             [$this->metabar, $this->mainbar, $this->crumbs, $this->logo, $this->overlay]
         );
         $html = $this->brutallyTrimHTML($r->render($this->stdpage));
         $expected = $this->brutallyTrimHTML(
             '
 <!DOCTYPE html>
 <html lang="en" dir="ltr">
 
 <head>
     <meta charset="utf-8" />
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
 ' . $meta_datum_1_html . $meta_datum_2_html . '
     <title>:</title>
     <link rel="icon" href="logo/favicon.ico" type="image/x-icon">
     <script type="application/javascript">var il = il ||{}; window.il = il;</script>
     <style></style>
 </head>
 
 <body>
     <div class="il-page-overlay">Overlay Stub</div>
     <div class="il-layout-page">
         <header>
             <div class="header-inner">
                 <div class="il-logo"><span class="hidden-xs">Logo Stub</span><span class="visible-xs-block">Responsive Logo Stub</span>
                     <div class="il-pagetitle">pagetitle</div>
                 </div>MetaBar Stub
             </div>
         </header>
         <div class="il-system-infos"></div>
         <div class="nav il-maincontrols">MainBar Stub</div>
         <main class="il-layout-page-content">some content</main>
     </div>
     <script>il.Util.addOnLoad(function() {});</script>
 </body>
 
 </html>'
         );
         $this->assertEquals($expected, $html);
     }

Here is the call graph for this function:

◆ testRenderingWithRtlLanguage()

StandardPageTest::testRenderingWithRtlLanguage ( )

Definition at line 293 of file StandardPageTest.php.

References $r, ILIAS_UI_TestBase\brutallyTrimHTML(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS\UI\examples\MainControls\MainBar\mainbar().

                                                   : void
     {
         $this->stdpage = $this->stdpage->withTextDirection($this->stdpage::RTL);
 
         $r = $this->getDefaultRenderer(
             null,
             [$this->metabar, $this->mainbar, $this->crumbs, $this->logo, $this->overlay]
         );
         $html = $this->brutallyTrimHTML($r->render($this->stdpage));
 
         $exptected = $this->brutallyTrimHTML(
             '<!DOCTYPE html>
 <html lang="en" dir="rtl">
 
 <head>
     <meta charset="utf-8" />
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <title>:</title>
     <link rel="icon" href="logo/favicon.ico" type="image/x-icon">
     <script type="application/javascript">var il = il ||{}; window.il = il;</script>
     <style></style>
 </head>
 
 <body>
     <div class="il-page-overlay">Overlay Stub</div>
     <div class="il-layout-page">
         <header>
             <div class="header-inner">
                 <div class="il-logo"><span class="hidden-xs">Logo Stub</span><span class="visible-xs-block">Responsive Logo Stub</span>
                     <div class="il-pagetitle">pagetitle</div>
                 </div>MetaBar Stub
             </div>
         </header>
         <div class="il-system-infos"></div>
         <div class="nav il-maincontrols">MainBar Stub</div>
         <main class="il-layout-page-content">some content</main>
     </div>
     <script>il.Util.addOnLoad(function() {});</script>
 </body>
 
 </html>'
         );
         $this->assertEquals($exptected, $html);
     }

Here is the call graph for this function:

◆ testRenderingWithTitle()

StandardPageTest::testRenderingWithTitle ( )

Definition at line 244 of file StandardPageTest.php.

References $r, ILIAS_UI_TestBase\brutallyTrimHTML(), ILIAS_UI_TestBase\getDefaultRenderer(), and ILIAS\UI\examples\MainControls\MainBar\mainbar().

                                             : void
     {
         $this->stdpage = $this->stdpage
             ->withTitle("Title")
             ->withViewTitle("View Title")
             ->withShortTitle("Short Title");
 
         $r = $this->getDefaultRenderer(
             null,
             [$this->metabar, $this->mainbar, $this->crumbs, $this->logo, $this->overlay]
         );
         $html = $this->brutallyTrimHTML($r->render($this->stdpage));
 
         $exptected = $this->brutallyTrimHTML(
             '<!DOCTYPE html>
 <html lang="en" dir="ltr">
 
 <head>
     <meta charset="utf-8" />
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <title>View Title: Short Title</title>
     <link rel="icon" href="logo/favicon.ico" type="image/x-icon">
     <script type="application/javascript">var il = il ||{}; window.il = il;</script>
     <style></style>
 </head>
 
 <body>
     <div class="il-page-overlay">Overlay Stub</div>
     <div class="il-layout-page">
         <header>
             <div class="header-inner">
                 <div class="il-logo"><span class="hidden-xs">Logo Stub</span><span class="visible-xs-block">Responsive Logo Stub</span>
                     <div class="il-pagetitle">Title</div>
                 </div>MetaBar Stub
             </div>
         </header>
         <div class="il-system-infos"></div>
         <div class="nav il-maincontrols">MainBar Stub</div>
         <main class="il-layout-page-content">some content</main>
     </div>
     <script>il.Util.addOnLoad(function() {});</script>
 </body>
 
 </html>'
         );
         $this->assertEquals($exptected, $html);
     }

Here is the call graph for this function:

◆ testWithFaviconPath()

StandardPageTest::testWithFaviconPath ( )

Definition at line 159 of file StandardPageTest.php.

                                          : void
     {
         $this->assertEquals("logo/favicon.ico", $this->stdpage->getFaviconPath());
         $this->assertEquals(
             "test",
             $this->stdpage->withFaviconPath("test")->getFaviconPath()
         );
     }

◆ testWithMetaDatum()

StandardPageTest::testWithMetaDatum ( )

Definition at line 234 of file StandardPageTest.php.

References getMockedTag().

                                        : void
     {
         $meta_datum_html = 'test_html';
         $meta_datum = $this->getMockedTag($meta_datum_html);
         $this->assertEquals(
             [$meta_datum],
             $this->stdpage->withAdditionalMetaDatum($meta_datum)->getMetaData()
         );
     }

Here is the call graph for this function:

◆ testWithShortTitle()

StandardPageTest::testWithShortTitle ( )

Definition at line 205 of file StandardPageTest.php.

                                         : void
     {
         $title = 'some short title';
         $this->assertEquals(
             $title,
             $this->stdpage->withShortTitle($title)->getShortTitle()
         );
     }

◆ testWithTextDirection()

StandardPageTest::testWithTextDirection ( )

Definition at line 223 of file StandardPageTest.php.

                                            : void
     {
         $this->assertEquals("ltr", $this->stdpage->getTextDirection());
         $this->assertEquals(
             "rtl",
             $this->stdpage
                 ->withTextDirection($this->stdpage::RTL)
                 ->getTextDirection()
         );
     }

◆ testWithTitle()

StandardPageTest::testWithTitle ( )

Definition at line 196 of file StandardPageTest.php.

                                    : void
     {
         $title = 'some title';
         $this->assertEquals(
             $title,
             $this->stdpage->withTitle($title)->getTitle()
         );
     }

◆ testWithViewTitle()

StandardPageTest::testWithViewTitle ( )

Definition at line 214 of file StandardPageTest.php.

                                        : void
     {
         $title = 'some view title';
         $this->assertEquals(
             $title,
             $this->stdpage->withViewTitle($title)->getViewTitle()
         );
     }

◆ testWithWrongContents()

StandardPageTest::testWithWrongContents ( )

Definition at line 176 of file StandardPageTest.php.

References ILIAS\UI\examples\MainControls\MainBar\mainbar().

                                            : void
     {
         $this->expectException(TypeError::class);
         $this->stdpage = $this->factory->standard(
             $this->metabar,
             $this->mainbar,
             'string is not allowed here',
             $this->crumbs,
             $this->logo
         );
     }

Here is the call graph for this function:

Field Documentation

◆ $contents

array StandardPageTest::$contents

protected

Definition at line 58 of file StandardPageTest.php.

◆ $crumbs

Breadcrumbs StandardPageTest::$crumbs

protected

Definition at line 49 of file StandardPageTest.php.

◆ $factory

Page Factory StandardPageTest::$factory

protected

Definition at line 46 of file StandardPageTest.php.

◆ $logo

Image StandardPageTest::$logo

protected

Definition at line 50 of file StandardPageTest.php.

◆ $mainbar

MainBar StandardPageTest::$mainbar

protected

Definition at line 47 of file StandardPageTest.php.

◆ $metabar

MetaBar StandardPageTest::$metabar

protected

Definition at line 48 of file StandardPageTest.php.

◆ $overlay

Container StandardPageTest::$overlay

protected

Definition at line 52 of file StandardPageTest.php.

◆ $responsive_logo

Image StandardPageTest::$responsive_logo

protected

Definition at line 51 of file StandardPageTest.php.

◆ $stdpage

Page Standard StandardPageTest::$stdpage

protected

Definition at line 45 of file StandardPageTest.php.

◆ $title

string StandardPageTest::$title

protected

Definition at line 53 of file StandardPageTest.php.

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

tests/UI/Component/Layout/Page/StandardPageTest.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDataFactory()

◆ getMockedTag()

◆ getUIFactory()

◆ setUp()

◆ testConstruction()

◆ testGetBreadcrumbs()

◆ testGetContent()

◆ testGetLogo()

◆ testGetMainbar()

◆ testGetMetabar()

◆ testGetOverlay()

◆ testGetResponsiveLogo()

◆ testGetTitle()

◆ testHasLogo()

◆ testHasResponsiveLogo()

◆ testRenderingWithCrumbs()

◆ testRenderingWithMetaData()

◆ testRenderingWithRtlLanguage()

◆ testRenderingWithTitle()

◆ testWithFaviconPath()

◆ testWithMetaDatum()

◆ testWithShortTitle()

◆ testWithTextDirection()

◆ testWithTitle()

◆ testWithViewTitle()

◆ testWithWrongContents()

Field Documentation

◆ $contents

◆ $crumbs

◆ $factory

◆ $logo

◆ $mainbar

◆ $metabar

◆ $overlay

◆ $responsive_logo

◆ $stdpage

◆ $title