FooterTest Class Reference

Inheritance diagram for FooterTest:

Collaboration diagram for FooterTest:

Public Member Functions
	testRenderWithPermanentUrl ()
	testRenderWithAdditionalLinkGroup ()
	testRenderWithAdditionalLink ()
	testRenderWithAdditionalIcon ()
	testRenderWithAdditionalText ()
	testRenderWithModalsAndTrigger ()
	testRenderEmptyFooter ()
	getUIFactory ()

Protected Member Functions
	setUp ()

Protected Attributes
I Link Standard	$link_mock
I Symbol Icon Icon	$icon_mock
I Button Shy	$shy_mock
I Button Standard	$button_mock
I Listing Unordered	$unordered_mock
I Button Factory	$button_factory
I Link Factory	$link_factory
I Listing Factory	$listing_factory
ILIAS Data URI	$uri_mock
string	$link_html
string	$icon_html
string	$shy_html
string	$button_html
string	$unordered_html

Detailed Description

Definition at line 28 of file FooterTest.php.

Member Function Documentation

getUIFactory()

FooterTest::getUIFactory

(

)

Definition at line 281 of file FooterTest.php.

References $button_factory, $link_factory, $listing_factory, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\button(), ILIAS\Repository\link(), and ILIAS\Repository\listing().

Referenced by setUp(), testRenderEmptyFooter(), testRenderWithAdditionalIcon(), testRenderWithAdditionalLink(), testRenderWithAdditionalLinkGroup(), testRenderWithAdditionalText(), testRenderWithModalsAndTrigger(), and testRenderWithPermanentUrl().

                                  : NoUIFactory
    {
        return new class (
            $this->createMock(I\SignalGeneratorInterface::class),
            $this->createMock(I\Counter\Factory::class),
            $this->createMock(I\Symbol\Factory::class),
            $this->button_factory,
            $this->link_factory,
            $this->listing_factory,
        ) extends NoUIFactory {
            public function __construct(
                protected I\SignalGeneratorInterface $signal_generator,
                protected I\Counter\Factory $counter_factory,
                protected I\Symbol\Factory $symbol_factory,
                protected I\Button\Factory $button_factory,
                protected I\Link\Factory $link_factory,
                protected I\Listing\Factory $listing_factory,
            ) {
            }
            public function mainControls(): I\MainControls\Factory
            {
                return new I\MainControls\Factory(
                    $this->signal_generator,
                    new I\MainControls\Slate\Factory(
                        $this->signal_generator,
                        $this->counter_factory,
                        $this->symbol_factory,
                    ),
                );
            }
            public function button(): I\Button\Factory
            {
                return $this->button_factory;
            }
            public function link(): I\Link\Factory
            {
                return $this->link_factory;
            }
            public function listing(): I\Listing\Factory
            {
                return $this->listing_factory;
            }
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setUp()

FooterTest::setUp ( )

protected

Definition at line 45 of file FooterTest.php.

References $shy_mock, and getUIFactory().

                              : void
    {
        $this->link_html = sha1(C\Link\Standard::class);
        $this->icon_html = sha1(C\Symbol\Icon\Icon::class);
        $this->shy_html = sha1(C\Button\Shy::class);
        $this->button_html = sha1(C\Button\Standard::class);
        $this->unordered_html = sha1(C\Listing\Unordered::class);

        $this->link_mock = $this->createMock(I\Link\Standard::class);
        $this->link_mock->method('getCanonicalName')->willReturn($this->link_html);

        $this->icon_mock = $this->createMock(I\Symbol\Icon\Icon::class);
        $this->icon_mock->method('getCanonicalName')->willReturn($this->icon_html);

        $this->shy_mock = $this->createMock(I\Button\Shy::class);
        $this->shy_mock->method('getCanonicalName')->willReturn($this->shy_html);

        $this->button_mock = $this->createMock(I\Button\Standard::class);
        $this->button_mock->method('getCanonicalName')->willReturn($this->button_html);

        $this->unordered_mock = $this->createMock(I\Listing\Unordered::class);
        $this->unordered_mock->method('getCanonicalName')->willReturn($this->unordered_html);

        $this->button_factory = $this->createMock(I\Button\Factory::class);
        $this->button_factory->method('shy')->willReturn($this->shy_mock);
        $this->button_factory->method('standard')->willReturn($this->button_mock);

        $this->link_factory = $this->createMock(I\Link\Factory::class);
        $this->link_factory->method('standard')->willReturn($this->link_mock);

        $this->listing_factory = $this->createMock(I\Listing\Factory::class);
        $this->listing_factory->method('unordered')->willReturn($this->unordered_mock);

        $this->uri_mock = $this->createMock(\ILIAS\Data\URI::class);

        parent::setUp();
    }

Here is the call graph for this function:

testRenderEmptyFooter()

FooterTest::testRenderEmptyFooter

(

)

Definition at line 269 of file FooterTest.php.

References $renderer, and getUIFactory().

                                           : void
    {
        $footer = $this->getUIFactory()->mainControls()->footer();

        $renderer = $this->getDefaultRenderer();
        $actual_html = $renderer->render($footer);

        $expected_html = '';

        $this->assertEquals($expected_html, $actual_html);
    }

Here is the call graph for this function:

testRenderWithAdditionalIcon()

FooterTest::testRenderWithAdditionalIcon

(

)

Definition at line 186 of file FooterTest.php.

References $renderer, getUIFactory(), and null.

                                                  : void
    {
        $footer = $this->getUIFactory()->mainControls()->footer();
        $footer = $footer->withAdditionalIcon($this->icon_mock);

        $renderer = $this->getDefaultRenderer(null, [$this->icon_mock]);
        $actual_html = $renderer->render($footer);

        $expected_html = <<<EOT
<footer class="c-maincontrols c-maincontrols__footer">
    <section class="c-maincontrols__footer-grid" data-section="icons" aria-label="footer_icons" tabindex="0">
        <div class="c-maincontrols__footer-grid__item l-bar__group">
            <span class="l-bar__element">$this->icon_html</span>
        </div>
    </section>
</footer>
EOT;

        $this->assertEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($actual_html)
        );
    }

Here is the call graph for this function:

testRenderWithAdditionalLink()

FooterTest::testRenderWithAdditionalLink

(

)

Definition at line 164 of file FooterTest.php.

References $renderer, getUIFactory(), and null.

                                                  : void
    {
        $footer = $this->getUIFactory()->mainControls()->footer();
        $footer = $footer->withAdditionalLink($this->link_mock);

        $renderer = $this->getDefaultRenderer(null, [$this->link_mock]);
        $actual_html = $renderer->render($footer);

        $expected_html = <<<EOT
<footer class="c-maincontrols c-maincontrols__footer">
    <section class="c-maincontrols__footer-grid" data-section="links" aria-label="footer_links" tabindex="0">
        <div class="c-maincontrols__footer-grid__item text-left">$this->link_html</div>
    </section>
</footer>
EOT;

        $this->assertEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($actual_html)
        );
    }

Here is the call graph for this function:

testRenderWithAdditionalLinkGroup()

FooterTest::testRenderWithAdditionalLinkGroup

(

)

Definition at line 136 of file FooterTest.php.

References $renderer, getUIFactory(), and null.

                                                       : void
    {
        $link_group_title = sha1('link_group_1');

        $footer = $this->getUIFactory()->mainControls()->footer();
        $footer = $footer->withAdditionalLinkGroup($link_group_title, [$this->link_mock]);

        $this->listing_factory->expects($this->once())->method('unordered')->with([$this->link_mock]);

        $renderer = $this->getDefaultRenderer(null, [$this->unordered_mock]);
        $actual_html = $renderer->render($footer);

        $expected_html = <<<EOT
<footer class="c-maincontrols c-maincontrols__footer">
    <section class="c-maincontrols__footer-grid" data-section="link-groups" aria-label="footer_link_groups" tabindex="0">
        <div class="c-maincontrols__footer-grid__item text-left">
            <strong>$link_group_title</strong>$this->unordered_html
        </div>
    </section>
</footer>
EOT;

        $this->assertEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($actual_html)
        );
    }

Here is the call graph for this function:

testRenderWithAdditionalText()

FooterTest::testRenderWithAdditionalText

(

)

Definition at line 210 of file FooterTest.php.

References $renderer, and getUIFactory().

                                                  : void
    {
        $text = sha1('text_1');

        $footer = $this->getUIFactory()->mainControls()->footer();
        $footer = $footer->withAdditionalText($text);

        $renderer = $this->getDefaultRenderer();
        $actual_html = $renderer->render($footer);

        $expected_html = <<<EOT
<footer class="c-maincontrols c-maincontrols__footer">
    <section class="c-maincontrols__footer-grid" data-section="texts" aria-label="footer_texts" tabindex="0">
        <div class="c-maincontrols__footer-grid__item text-left">$text</div>
    </section>
</footer>
EOT;

        $this->assertEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($actual_html)
        );
    }

Here is the call graph for this function:

testRenderWithModalsAndTrigger()

FooterTest::testRenderWithModalsAndTrigger

(

)

Definition at line 234 of file FooterTest.php.

References $renderer, $shy_mock, getUIFactory(), and null.

                                                    : void
    {
        $modal_html = sha1(C\Modal\RoundTrip::class);
        $modal_mock = $this->createMock(C\Modal\RoundTrip::class);
        $modal_mock->method('getCanonicalName')->willReturn($modal_html);
        $modal_mock->method('getShowSignal')->willReturn(
            $this->createMock(C\Signal::class)
        );

        $shy_mock = $this->shy_mock;
        $shy_mock->method('withOnClick')->willReturnSelf();

        $shy_mock = $shy_mock->withOnClick($modal_mock->getShowSignal());

        $footer = $this->getUIFactory()->mainControls()->footer();
        $footer = $footer->withAdditionalLink($shy_mock);
        $footer = $footer->withAdditionalModal($modal_mock);

        $renderer = $this->getDefaultRenderer(null, [$modal_mock, $shy_mock]);
        $actual_html = $renderer->render($footer);

        $expected_html = <<<EOT
<footer class="c-maincontrols c-maincontrols__footer">
    <section class="c-maincontrols__footer-grid" data-section="links" aria-label="footer_links" tabindex="0">
        <div class="c-maincontrols__footer-grid__item text-left">$this->shy_html</div>
    </section>
</footer>$modal_html
EOT;

        $this->assertEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($actual_html)
        );
    }

Here is the call graph for this function:

testRenderWithPermanentUrl()

FooterTest::testRenderWithPermanentUrl

(

)

Definition at line 104 of file FooterTest.php.

References $renderer, getUIFactory(), and null.

                                                : void
    {
        $footer = $this->getUIFactory()->mainControls()->footer();
        $footer = $footer->withPermanentURL($this->uri_mock);

        $this->button_factory->expects($this->once())->method('standard')->with('copy_perma_link', '');
        $this->button_mock->expects($this->once())->method('withAdditionalOnLoadCode')->willReturnSelf();

        $renderer = $this->getDefaultRenderer(null, [$this->button_mock]);
        $actual_html = $renderer->render($footer);

        $expected_html = <<<EOT
<footer class="c-maincontrols c-maincontrols__footer">
    <section class="c-maincontrols__footer-grid" data-section="permanent-link" aria-label="footer_permanent_link" tabindex="0">
        <div class="c-maincontrols__footer-grid__item text-left">
            <div class="c-tooltip__container c-tooltip--top" aria-live="polite">
                $this->button_html
                <div class="c-tooltip c-tooltip--hidden" role="tooltip">
                    perma_link_copied
                </div>
            </div>
        </div>
    </section>
</footer>
EOT;

        $this->assertEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($actual_html)
        );
    }

Here is the call graph for this function:

Field Documentation

$button_factory

I Button Factory FooterTest::$button_factory

protected

Definition at line 35 of file FooterTest.php.

Referenced by getUIFactory().

$button_html

string FooterTest::$button_html

protected

Definition at line 42 of file FooterTest.php.

$button_mock

I Button Standard FooterTest::$button_mock

protected

Definition at line 33 of file FooterTest.php.

$icon_html

string FooterTest::$icon_html

protected

Definition at line 40 of file FooterTest.php.

$icon_mock

I Symbol Icon Icon FooterTest::$icon_mock

protected

Definition at line 31 of file FooterTest.php.

$link_factory

I Link Factory FooterTest::$link_factory

protected

Definition at line 36 of file FooterTest.php.

Referenced by getUIFactory().

$link_html

string FooterTest::$link_html

protected

Definition at line 39 of file FooterTest.php.

$link_mock

I Link Standard FooterTest::$link_mock

protected

Definition at line 30 of file FooterTest.php.

$listing_factory

I Listing Factory FooterTest::$listing_factory

protected

Definition at line 37 of file FooterTest.php.

Referenced by getUIFactory().

$shy_html

string FooterTest::$shy_html

protected

Definition at line 41 of file FooterTest.php.

$shy_mock

I Button Shy FooterTest::$shy_mock

protected

Definition at line 32 of file FooterTest.php.

Referenced by setUp(), and testRenderWithModalsAndTrigger().

$unordered_html

string FooterTest::$unordered_html

protected

Definition at line 43 of file FooterTest.php.

$unordered_mock

I Listing Unordered FooterTest::$unordered_mock

protected

Definition at line 34 of file FooterTest.php.

$uri_mock

ILIAS Data URI FooterTest::$uri_mock

protected

Definition at line 38 of file FooterTest.php.

---

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

• components/ILIAS/UI/tests/Component/MainControls/FooterTest.php