Tests for the Main Bar. More...

Inheritance diagram for MainBarTest:

Collaboration diagram for MainBarTest:

Public Member Functions
	setUp ()

	testConstruction ()

	testAddEntry ()

	testDisallowedEntry ()

	testDouplicateIdEntry ()

	testDisallowedToolEntry ()

	testAddToolEntryWithoutToolsButton ()

	testAddToolEntry ()

	testDouplicateIdToolEntry ()

	testActive (C\MainControls\MainBar $mb)
	testAddEntry More...

	testWithInvalidActive ()

	testSignalsPresent ()

	getUIFactory ()

	testRendering ()

Protected Member Functions
	getButton ()

	getLink ()

	getSlate ()

Protected Attributes
I Button Factory	$button_factory

I Link Factory	$link_factory

I Symbol Icon Factory	$icon_factory

I MainControls Factory	$factory

C MainControls MainBar	$mainbar

Detailed Description

Tests for the Main Bar.

Definition at line 34 of file MainBarTest.php.

Member Function Documentation

◆ getButton()

MainBarTest::getButton ( )

protected

Definition at line 71 of file MainBarTest.php.

Referenced by testAddEntry(), testAddToolEntry(), testDouplicateIdEntry(), testDouplicateIdToolEntry(), and testRendering().

                                   : C\Button\Bulky
     {
         $symbol = $this->icon_factory->custom('', '');
         return $this->button_factory->bulky($symbol, 'TestEntry', '#');
     }

Here is the caller graph for this function:

◆ getLink()

MainBarTest::getLink ( )

protected

Definition at line 77 of file MainBarTest.php.

Referenced by testAddEntry().

                                 : C\Link\Bulky
     {
         $symbol = $this->icon_factory->custom('', '');
         $target = new Data\URI("http://www.ilias.de");
         return $this->link_factory->bulky($symbol, 'TestEntry', $target);
     }

Here is the caller graph for this function:

◆ getSlate()

MainBarTest::getSlate ( )

protected

Returns: Legacy|mixed|MockObject

Definition at line 87 of file MainBarTest.php.

Referenced by testAddToolEntry(), testAddToolEntryWithoutToolsButton(), and testDouplicateIdToolEntry().

     {
         $mock = $this->getMockBuilder(Legacy::class)
             ->disableOriginalConstructor()
             ->getMock();
 
         return $mock;
     }

Here is the caller graph for this function:

◆ getUIFactory()

MainBarTest::getUIFactory ( )

Definition at line 184 of file MainBarTest.php.

References $button_factory, $factory, ILIAS\Repository\button(), ILIAS\UI\examples\MainControls\Slate\Legacy\legacy(), and ILIAS\Repository\symbol().

                                   : NoUIFactory
     {
         $factory = new class () extends NoUIFactory {
             public C\Button\Factory $button_factory;
 
             public function button(): C\Button\Factory
             {
                 return $this->button_factory;
             }
             public function symbol(): C\Symbol\Factory
             {
                 $f_icon = new I\Symbol\Icon\Factory();
                 $f_glyph = new I\Symbol\Glyph\Factory();
                 $f_avatar = new I\Symbol\Avatar\Factory();
 
                 return new I\Symbol\Factory($f_icon, $f_glyph, $f_avatar);
             }
             public function mainControls(): C\MainControls\Factory
             {
                 $sig_gen = new I\SignalGenerator();
                 $counter_factory = new I\Counter\Factory();
                 $symbol_factory = new I\Symbol\Factory(
                     new I\Symbol\Icon\Factory(),
                     new I\Symbol\Glyph\Factory(),
                     new I\Symbol\Avatar\Factory()
                 );
                 $slate_factory = new I\MainControls\Slate\Factory($sig_gen, $counter_factory, $symbol_factory);
                 return new I\MainControls\Factory($sig_gen, $slate_factory);
             }
             public function legacy(string $content): C\Legacy\Legacy
             {
                 $sig_gen = new I\SignalGenerator();
                 return new I\Legacy\Legacy($content, $sig_gen);
             }
         };
         $factory->button_factory = $this->button_factory;
         return $factory;
     }

Here is the call graph for this function:

◆ setUp()

MainBarTest::setUp ( )

Definition at line 42 of file MainBarTest.php.

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

                            : void
     {
         $sig_gen = new I\SignalGenerator();
         $this->button_factory = new I\Button\Factory();
         $this->link_factory = new I\Link\Factory();
         $this->icon_factory = new I\Symbol\Icon\Factory();
         $counter_factory = new I\Counter\Factory();
         $slate_factory = new I\MainControls\Slate\Factory(
             $sig_gen,
             $counter_factory,
             new I\Symbol\Factory(
                 new I\Symbol\Icon\Factory(),
                 new I\Symbol\Glyph\Factory(),
                 new I\Symbol\Avatar\Factory()
             )
         );
         $this->factory = new I\MainControls\Factory($sig_gen, $slate_factory);
 
         $this->mainbar = $this->factory->mainBar();
     }

Here is the call graph for this function:

◆ testActive()

MainBarTest::testActive ( C\MainControls\MainBar $mb )

testAddEntry

Definition at line 164 of file MainBarTest.php.

                                                           : void
     {
         $mb = $mb->withActive('testbtn');
         $this->assertEquals('testbtn', $mb->getActive());
     }

◆ testAddEntry()

MainBarTest::testAddEntry ( )

Definition at line 96 of file MainBarTest.php.

References getButton(), getLink(), and ILIAS\UI\examples\MainControls\MainBar\mainbar().

                                   : C\MainControls\MainBar
     {
         $btn = $this->getButton();
         $lnk = $this->getLink();
         $mb = $this->mainbar
             ->withAdditionalEntry('testbtn', $btn)
             ->withAdditionalEntry('testlnk', $lnk);
 
         $entries = $mb->getEntries();
         $expected = [
             'testbtn' => $btn,
             'testlnk' => $lnk,
         ];
         $this->assertEquals($expected, $entries);
         return $mb;
     }

Here is the call graph for this function:

◆ testAddToolEntry()

MainBarTest::testAddToolEntry ( )

Definition at line 140 of file MainBarTest.php.

References getButton(), getSlate(), and ILIAS\UI\examples\MainControls\MainBar\mainbar().

                                       : void
     {
         $slate = $this->getSlate();
         $mb = $this->mainbar
             ->withToolsButton($this->getButton())
             ->withAdditionalToolEntry('test', $slate);
         $entries = $mb->getToolEntries();
         $this->assertEquals($slate, $entries['test']);
     }

Here is the call graph for this function:

◆ testAddToolEntryWithoutToolsButton()

MainBarTest::testAddToolEntryWithoutToolsButton ( )

Definition at line 134 of file MainBarTest.php.

References getSlate(), and ILIAS\UI\examples\MainControls\MainBar\mainbar().

                                                         : void
     {
         $this->expectException(LogicException::class);
         $this->mainbar->withAdditionalToolEntry('test', $this->getSlate());
     }

Here is the call graph for this function:

◆ testConstruction()

MainBarTest::testConstruction ( )

Definition at line 63 of file MainBarTest.php.

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

                                       : void
     {
         $this->assertInstanceOf(
             "ILIAS\\UI\\Component\\MainControls\\MainBar",
             $this->mainbar
         );
     }

Here is the call graph for this function:

◆ testDisallowedEntry()

MainBarTest::testDisallowedEntry ( )

Definition at line 113 of file MainBarTest.php.

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

                                          : void
     {
         $this->expectException(InvalidArgumentException::class);
         $this->mainbar->withAdditionalEntry('test', 'wrong_param');
     }

Here is the call graph for this function:

◆ testDisallowedToolEntry()

MainBarTest::testDisallowedToolEntry ( )

Definition at line 128 of file MainBarTest.php.

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

                                              : void
     {
         $this->expectException(\TypeError::class);
         $this->mainbar->withAdditionalToolEntry('test', 'wrong_param');
     }

Here is the call graph for this function:

◆ testDouplicateIdEntry()

MainBarTest::testDouplicateIdEntry ( )

Definition at line 119 of file MainBarTest.php.

References getButton(), and ILIAS\UI\examples\MainControls\MainBar\mainbar().

                                            : void
     {
         $this->expectException(InvalidArgumentException::class);
         $btn = $this->getButton();
         $this->mainbar
             ->withAdditionalEntry('test', $btn)
             ->withAdditionalEntry('test', $btn);
     }

Here is the call graph for this function:

◆ testDouplicateIdToolEntry()

MainBarTest::testDouplicateIdToolEntry ( )

Definition at line 150 of file MainBarTest.php.

References getButton(), getSlate(), and ILIAS\UI\examples\MainControls\MainBar\mainbar().

                                                : void
     {
         $this->expectException(InvalidArgumentException::class);
         $btn = $this->getButton();
         $slate = $this->getSlate();
         $this->mainbar
             ->withToolsButton($btn)
             ->withAdditionalToolEntry('test', $slate)
             ->withAdditionalToolEntry('test', $slate);
     }

Here is the call graph for this function:

◆ testRendering()

MainBarTest::testRendering ( )

Definition at line 223 of file MainBarTest.php.

References $r, ILIAS\Repository\button(), ILIAS\UI\examples\Symbol\Glyph\Close\close(), and getButton().

                                    : void
     {
         $r = $this->getDefaultRenderer();
         $icon = $this->icon_factory->custom('', '');
 
         $sf = $this->factory->slate();
         $slate = $sf->combined('1', $icon)
             ->withAdditionalEntry(
                 $sf->combined('1.1', $icon)
                     ->withAdditionalEntry(
                         $sf->combined('1.1.1', $icon)
                     )
             );
 
         $toolslate = $sf->legacy('Help', $icon, new I\Legacy\Legacy('Help', new I\SignalGenerator()));
 
         $mb = $this->factory->mainBar()
             ->withAdditionalEntry('test1', $this->getButton())
             ->withAdditionalEntry('test2', $this->getButton())
             ->withAdditionalEntry('slate', $slate)
             ->withToolsButton($this->getButton())
             ->withAdditionalToolEntry('tool1', $toolslate);
 
         $html = $r->render($mb);
 
         $expected = <<<EOT
             <div class="il-maincontrols-mainbar" id="id_16">
               <nav class="il-mainbar" aria-label="mainbar_aria_label">
                 <div class="il-mainbar-tools-button">
                   <button class="btn btn-bulky" id="id_14">
                     <img class="icon custom small" src="" alt=""/>
                     <span class="bulky-label">TestEntry</span>
                   </button>
                 </div>
                 <div class="il-mainbar-triggers">
                   <ul class="il-mainbar-entries" role="menubar" style="visibility: hidden">
                     <li role="none">
                       <button class="btn btn-bulky" data-action="#" id="id_1" role="menuitem">
                         <img class="icon custom small" src="" alt=""/>
                         <span class="bulky-label">TestEntry</span>
                       </button>
                     </li>
                     <li role="none">
                       <button class="btn btn-bulky" data-action="#" id="id_2" role="menuitem">
                         <img class="icon custom small" src="" alt=""/>
                         <span class="bulky-label">TestEntry</span>
                       </button>
                     </li>
                     <li role="none">
                       <button class="btn btn-bulky" id="id_3" role="menuitem">
                         <img class="icon custom small" src="" alt=""/>
                         <span class="bulky-label">1</span>
                       </button>
                     </li>
                     <li role="none">
                       <button class="btn btn-bulky" id="id_9" role="menuitem">
                         <span class="glyph" role="img">
                           <span class="glyphicon glyphicon-option-horizontal" aria-hidden="true"></span>
                         </span>
                         <span class="bulky-label">mainbar_more_label</span>
                       </button>
                     </li>
                   </ul>
                 </div>
               </nav>
               <div class="il-mainbar-slates">
                 <div class="il-mainbar-tools-entries">
                   <ul class="il-mainbar-tools-entries-bg" role="menubar">
                     <li class="il-mainbar-tool-trigger-item" role="none">
                       <button class="btn btn-bulky" id="id_11" role="menuitem">
                         <img class="icon custom small" src="" alt=""/>
                         <span class="bulky-label">Help</span>
                       </button>
                     </li>
                   </ul>
                 </div>
                 <div class="il-maincontrols-slate disengaged" id="id_8" data-depth-level="1" role="menu">
                   <div class="il-maincontrols-slate-content" data-replace-marker="content">
                     <ul>
                       <li>
                         <button class="btn btn-bulky" id="id_4">
                           <img class="icon custom small" src="" alt=""/>
                           <span class="bulky-label">1.1</span>
                         </button>
                         <div class="il-maincontrols-slate disengaged" id="id_7" data-depth-level="2">
                           <div class="il-maincontrols-slate-content" data-replace-marker="content">
                             <ul>
                               <li>
                                 <button class="btn btn-bulky" id="id_5">
                                   <img class="icon custom small" src="" alt=""/>
                                   <span class="bulky-label">1.1.1</span>
                                 </button>
                                 <div class="il-maincontrols-slate disengaged" id="id_6" data-depth-level="3">
                                   <div class="il-maincontrols-slate-content" data-replace-marker="content"></div>
                                 </div>
                               </li>
                             </ul>
                           </div>
                         </div>
                       </li>
                     </ul>
                   </div>
                 </div>
                 <div class="il-maincontrols-slate disengaged" id="id_10" data-depth-level="1" role="menu">
                   <div class="il-maincontrols-slate-content" data-replace-marker="content"></div>
                 </div>
                 <div class="il-maincontrols-slate disengaged" id="id_13" data-depth-level="1" role="menu">
                   <div class="il-maincontrols-slate-content" data-replace-marker="content">Help</div>
                 </div>
                 <div class="il-mainbar-close-slates">
                   <button class="btn btn-bulky" id="id_15">
                     <span class="glyph" role="img">
                       <span class="glyphicon glyphicon-triangle-left" aria-hidden="true"></span>
                     </span>
                     <span class="bulky-label">close</span>
                   </button>
                 </div>
               </div>
             </div>
 EOT;
 
         $this->assertEquals(
             $this->brutallyTrimHTML($expected),
             $this->brutallyTrimHTML($html)
         );
     }

Here is the call graph for this function:

◆ testSignalsPresent()

MainBarTest::testSignalsPresent ( )

Definition at line 176 of file MainBarTest.php.

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

                                         : void
     {
         $this->assertInstanceOf(Signal::class, $this->mainbar->getEntryClickSignal());
         $this->assertInstanceOf(Signal::class, $this->mainbar->getToolsClickSignal());
         $this->assertInstanceOf(Signal::class, $this->mainbar->getToolsRemovalSignal());
         $this->assertInstanceOf(Signal::class, $this->mainbar->getDisengageAllSignal());
     }

Here is the call graph for this function:

◆ testWithInvalidActive()

MainBarTest::testWithInvalidActive ( )

Definition at line 170 of file MainBarTest.php.

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

                                            : void
     {
         $this->expectException(InvalidArgumentException::class);
         $this->mainbar->withActive('this-is-not-a-valid-entry');
     }

Here is the call graph for this function:

Field Documentation

◆ $button_factory

I Button Factory MainBarTest::$button_factory

protected

Definition at line 36 of file MainBarTest.php.

Referenced by getUIFactory().

◆ $factory

I MainControls Factory MainBarTest::$factory

protected

Definition at line 39 of file MainBarTest.php.

Referenced by getUIFactory().

◆ $icon_factory

I Symbol Icon Factory MainBarTest::$icon_factory

protected

Definition at line 38 of file MainBarTest.php.

◆ $link_factory

I Link Factory MainBarTest::$link_factory

protected

Definition at line 37 of file MainBarTest.php.

◆ $mainbar

C MainControls MainBar MainBarTest::$mainbar

protected

Definition at line 40 of file MainBarTest.php.

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

components/ILIAS/UI/tests/Component/MainControls/MainBarTest.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ getButton()

◆ getLink()

◆ getSlate()

◆ getUIFactory()

◆ setUp()

◆ testActive()

◆ testAddEntry()

◆ testAddToolEntry()

◆ testAddToolEntryWithoutToolsButton()

◆ testConstruction()

◆ testDisallowedEntry()

◆ testDisallowedToolEntry()

◆ testDouplicateIdEntry()

◆ testDouplicateIdToolEntry()

◆ testRendering()

◆ testSignalsPresent()

◆ testWithInvalidActive()

Field Documentation

◆ $button_factory

◆ $factory

◆ $icon_factory

◆ $link_factory

◆ $mainbar