PaginationTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

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

use ILIAS\UI\Component as C;
use ILIAS\UI\Implementation\Component as IC;
use ILIAS\UI\Implementation\Component\SignalGenerator;
use ILIAS\UI\Implementation\Component\ViewControl\Factory;

class PaginationTest extends ILIAS_UI_TestBase
{
    public function getUIFactory(): NoUIFactory
    {
        return new class () extends NoUIFactory {
            public function symbol(): IC\Symbol\Factory
            {
                return new IC\Symbol\Factory(
                    new IC\Symbol\Icon\Factory(),
                    new IC\Symbol\Glyph\Factory(),
                    new IC\Symbol\Avatar\Factory()
                );
            }
            public function button(): IC\Button\Factory
            {
                return new IC\Button\Factory();
            }
            public function dropdown(): IC\Dropdown\Factory
            {
                return new IC\Dropdown\Factory();
            }
        };
    }

    private function getFactory(): Factory
    {
        $sg = new SignalGenerator();
        return new Factory($sg);
    }

    public function testConstruction(): void
    {
        $f = $this->getFactory();
        $pagination = $f->pagination();
        $this->assertInstanceOf("ILIAS\\UI\\Component\\ViewControl\\Pagination", $pagination);
        $this->assertInstanceOf("ILIAS\\UI\\Component\\Signal", $pagination->getInternalSignal());
    }

    public function testAttributes(): void
    {
        $total_entries = 111;
        $page_size = 100;
        $current_page = 1;
        //$select_signal;
        $target_url = 'http://testurl';
        $parameter_name = "param_name";
        $max_page_options = 10;

        $f = $this->getFactory();
        $p = $f->pagination()
            ->withTargetURL($target_url, $parameter_name)
            ->withTotalEntries($total_entries)
            ->withPageSize($page_size)
            ->withCurrentPage($current_page)
            ->withMaxPaginationButtons($max_page_options)
        ;

        $this->assertEquals($target_url, $p->getTargetURL());
        $this->assertEquals($parameter_name, $p->getParameterName());
        $this->assertEquals($page_size, $p->getPageSize());
        $this->assertEquals($current_page, $p->getCurrentPage());
        $this->assertEquals($max_page_options, $p->getMaxPaginationButtons());
        $this->assertEquals(2, $p->getNumberOfPages());
    }

    public function testViewControlPaginationRenderUnlimited(): void
    {
        $p = $this->getFactory()->pagination()
            ->withTotalEntries(2)
            ->withPageSize(1);

        //two entries, first one inactive
        //browse-left disabled
        $expected_html = <<<EOT
<div class="il-viewcontrol-pagination l-bar__element">
        <span class="btn btn-ctrl browse previous">
                <a class="glyph disabled" aria-label="back" aria-disabled="true">
                        <span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
                </a>
        </span>

        <button class="btn btn-link engaged" aria-pressed="true" data-action="?pagination_offset=0" id="id_1">1</button>
        <button class="btn btn-link" data-action="?pagination_offset=1" id="id_2">2</button>

        <span class="btn btn-ctrl browse next">
                <a tabindex="0" class="glyph" href="?pagination_offset=1" aria-label="next">
                        <span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
                </a>
        </span>
</div>
EOT;

        $html = $this->getDefaultRenderer()->render($p);
        $this->assertEquals($this->brutallyTrimHTML($expected_html), $this->brutallyTrimHTML($html));
    }

    public function testRenderWithCurrentPage(): void
    {
        $p = $this->getFactory()->pagination()
            ->withTotalEntries(2)
            ->withPageSize(1)
            ->withCurrentPage(1);

        //two entries, second one inactive
        //browse-right disabled
        $expected_html = <<<EOT
<div class="il-viewcontrol-pagination l-bar__element">
        <span class="btn btn-ctrl browse previous">
                <a tabindex="0" class="glyph" href="?pagination_offset=0" aria-label="back">
                        <span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
                </a>
        </span>

        <button class="btn btn-link" data-action="?pagination_offset=0" id="id_1">1</button>
        <button class="btn btn-link engaged" aria-pressed="true" data-action="?pagination_offset=1" id="id_2">2</button>

        <span class="btn btn-ctrl browse next">
                <a class="glyph disabled" aria-label="next" aria-disabled="true">
                        <span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
                </a>
        </span>
</div>
EOT;

        $html = $this->getDefaultRenderer()->render($p);
        $this->assertHTMLEquals($expected_html, $html);
    }

    public function testRenderLimited(): void
    {
        $p = $this->getFactory()->pagination()
            ->withTotalEntries(3)
            ->withPageSize(1)
            ->withMaxPaginationButtons(1);

        //one entry,
        //browse-left disabled
        //boundary-button right
        $expected_html = <<<EOT
<div class="il-viewcontrol-pagination l-bar__element">
        <span class="btn btn-ctrl browse previous">
                <a class="glyph disabled" aria-label="back" aria-disabled="true">
                        <span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
                </a>
        </span>

        <button class="btn btn-link engaged" aria-pressed="true" data-action="?pagination_offset=0" id="id_1">1</button>

        <span class="last">
                <button class="btn btn-link" data-action="?pagination_offset=2" id="id_2">3</button>
        </span>

        <span class="btn btn-ctrl browse next">
                <a tabindex="0" class="glyph" href="?pagination_offset=1" aria-label="next">
                        <span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
                </a>
        </span>
</div>
EOT;
        $html = $this->getDefaultRenderer()->render($p);
        $this->assertHTMLEquals($expected_html, $html);
    }

    public function testRenderLimitedWithCurrentPage(): void
    {
        $p = $this->getFactory()->pagination()
            ->withTotalEntries(3)
            ->withPageSize(1)
            ->withMaxPaginationButtons(1)
            ->withCurrentPage(1);

        //one entry,
        //both rockers enabled
        //both boundary-buttons
        $expected_html = <<<EOT
<div class="il-viewcontrol-pagination l-bar__element">
        <span class="btn btn-ctrl browse previous">
                <a tabindex="0" class="glyph" href="?pagination_offset=0" aria-label="back">
                        <span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
                </a>
        </span>

        <span class="first">
                <button class="btn btn-link" data-action="?pagination_offset=0" id="id_2">1</button>
        </span>

        <button class="btn btn-link engaged" aria-pressed="true" data-action="?pagination_offset=1" id="id_1">2</button>

        <span class="last">
                <button class="btn btn-link" data-action="?pagination_offset=2" id="id_3">3</button>
        </span>

        <span class="btn btn-ctrl browse next">
                <a tabindex="0" class="glyph" href="?pagination_offset=2" aria-label="next">
                        <span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
                </a>
        </span>
</div>
EOT;
        $html = $this->getDefaultRenderer()->render($p);
        $this->assertHTMLEquals($expected_html, $html);
    }

    public function testRenderLimitedWithCurrentPage2(): void
    {
        $p = $this->getFactory()->pagination()
            ->withTotalEntries(3)
            ->withPageSize(1)
            ->withMaxPaginationButtons(1)
            ->withCurrentPage(2);

        //one entry,
        //browse-right disabled
        //boundary-button left only
        $expected_html = <<<EOT
<div class="il-viewcontrol-pagination l-bar__element">
        <span class="btn btn-ctrl browse previous">
                <a tabindex="0" class="glyph" href="?pagination_offset=1" aria-label="back">
                        <span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
                </a>
        </span>
        <span class="first">
                <button class="btn btn-link" data-action="?pagination_offset=0" id="id_2">1</button>
        </span>

        <button class="btn btn-link engaged" aria-pressed="true" data-action="?pagination_offset=2" id="id_1">3</button>

        <span class="btn btn-ctrl browse next">
                <a class="glyph disabled" aria-label="next" aria-disabled="true">
                        <span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
                </a>
        </span>
</div>
EOT;
        $html = $this->getDefaultRenderer()->render($p);
        $this->assertHTMLEquals($expected_html, $html);
    }



    public function testRenderDropdown(): void
    {
        $p = $this->getFactory()->pagination()
            ->withTotalEntries(3)
            ->withPageSize(1)
            ->withDropdownAt(1);

        $expected_html = <<<EOT
<div class="il-viewcontrol-pagination l-bar__element">
        <span class="btn btn-ctrl browse previous">
                <a class="glyph disabled" aria-label="back" aria-disabled="true">
                        <span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
                </a>
        </span>

        <div class="dropdown" id="id_4">
                <button class="btn btn-default dropdown-toggle" type="button" aria-haspopup="true" aria-expanded="false" aria-controls="id_4_menu" >pagination_label_x_of_y<span class="caret"></span></button>
                <ul id="id_4_menu" class="dropdown-menu">
                        <li><button class="btn btn-link engaged" aria-pressed="true" data-action="?pagination_offset=0" id="id_1">1</button></li>
                        <li><button class="btn btn-link" data-action="?pagination_offset=1" id="id_2">2</button></li>
                        <li><button class="btn btn-link" data-action="?pagination_offset=2" id="id_3">3</button></li>
                </ul>
        </div>

        <span class="btn btn-ctrl browse next">
                <a tabindex="0" class="glyph" href="?pagination_offset=1" aria-label="next">
                        <span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
                </a>
        </span>
</div>
EOT;
        $html = $this->getDefaultRenderer()->render($p);
        $this->assertEquals($this->brutallyTrimHTML($expected_html), $this->brutallyTrimHTML($html));
    }

    public function testGetRangeOnNull(): void
    {
        $page_size = 0;
        $current_page = 1;
        $range = null;

        $pagination = $this->getFactory()->pagination()
            ->withCurrentPage($current_page)
            ->withPageSize($page_size);

        $this->assertNull($pagination->getRange());
        $this->assertEquals($range, $pagination->getRange());
    }

    public function testRenderWithOnePageOnly(): void
    {
        $p = $this->getFactory()->pagination()
            ->withTotalEntries(30)
            ->withPageSize(30);
        $expected_html = '';
        $html = $this->getDefaultRenderer()->render($p);
        $this->assertEquals($expected_html, $html);
    }

}