ILIAS\UI\examples\ViewControl\Pagination Namespace Reference

Functions
	base ()
	description: > Example for rendering a pagination view control. More...
	many_pages ()
	description: > Example of rendering a pagination view control with a lot of pages More...
	many_pages_dropdown ()
	description: > Example of rendering a pagination view control with many pages as dropdown More...
	no_pages ()
	description: > Example for a pagination view control with no pages More...
	with_signal ()
	description: > Example for rendering a pagination view control with a signal More...

Function Documentation

base()

ILIAS\UI\examples\ViewControl\Pagination\base

(

)

---

description: > Example for rendering a pagination view control.

expected output: > ILIAS shows a series of numbers 1-10 positioned between a "Back" (<) and "Next" (<) glyph. Clicking a number loads a new page: the updated number will be shown under the series of numbers, e.g. "entries 80-90" after clicking "9". You can browse the pages by using the glyphs too. Please note that the "Back" glyph can't be used on the first page and the

"Next" glyph can't be used on the last page.

Definition at line 35 of file base.php.

References $DIC, ILIAS\UI\examples\Layout\Page\Standard\$refinery, $renderer, ILIAS\UI\examples\Layout\Page\Standard\$request_wrapper, and $url.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $url = $DIC->http()->request()->getRequestTarget();
    $refinery = $DIC->refinery();
    $request_wrapper = $DIC->http()->wrapper()->query();

    $parameter_name = 'page';
    $current_page = 0;
    if ($request_wrapper->has($parameter_name)) {
        $current_page = $request_wrapper->retrieve($parameter_name, $refinery->kindlyTo()->int());
    }

    $pagination = $factory->viewControl()->pagination()
        ->withTargetURL($url, $parameter_name)
        ->withTotalEntries(98)
        ->withPageSize(10)
        ->withCurrentPage($current_page);

    list($range_offset, $range_length) = $pagination->getRange()->unpack();
    $result = "Show $range_length entries starting at $range_offset";

    return $renderer->render($pagination)
        . '<hr>'
        . $result;
}

many_pages()

ILIAS\UI\examples\ViewControl\Pagination\many_pages

(

)

---

description: > Example of rendering a pagination view control with a lot of pages

expected output: > ILIAS shows a series of numbers 1-500 in between the "Back" (<) and "Next" (>) glyph. The series of numbers is not displayed completely as it is limited to six elements (e.g. 1, 2, 3, 4, 5, 500). Navigating through the pagination

does not differ from the base pagination.

Definition at line 34 of file many_pages.php.

References $DIC, ILIAS\UI\examples\Layout\Page\Standard\$refinery, $renderer, ILIAS\UI\examples\Layout\Page\Standard\$request_wrapper, and $url.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $url = $DIC->http()->request()->getRequestTarget();
    $refinery = $DIC->refinery();
    $request_wrapper = $DIC->http()->wrapper()->query();

    $parameter_name = 'page2';
    $current_page = 0;
    if ($request_wrapper->has($parameter_name)) {
        $current_page = $request_wrapper->retrieve($parameter_name, $refinery->kindlyTo()->int());
    }

    $pagination = $factory->viewControl()->pagination()
        ->withTargetURL($url, $parameter_name)
        ->withTotalEntries(1000)
        ->withPageSize(2)
        ->withMaxPaginationButtons(5)
        ->withCurrentPage($current_page);

    list($range_offset, $range_length) = $pagination->getRange()->unpack();
    $result = "Show $range_length entries starting at $range_offset";

    return $renderer->render($pagination)
        . '<hr>'
        . $result;
}

many_pages_dropdown()

ILIAS\UI\examples\ViewControl\Pagination\many_pages_dropdown

(

)

---

description: > Example of rendering a pagination view control with many pages as dropdown

expected output: > ILIAS shows two dropdown fields in between the "Back" (<) and "Next" (>) glyph. Clicking onto one of the dropdown fields will open a list of numbers. You can navigate to other pages through clicking the number in the dropdown control. If a number was clicked you will get redirected to the specific page and the number appears also in the label of the second dropdown. You can also use the glyphs to navigate through the pages, but please note that the "Back" glyph can't be used

on the first page and the "Next" glyph can't be used on the last page.

Definition at line 36 of file many_pages_dropdown.php.

References $DIC, ILIAS\UI\examples\Layout\Page\Standard\$refinery, $renderer, ILIAS\UI\examples\Layout\Page\Standard\$request_wrapper, and $url.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $url = $DIC->http()->request()->getRequestTarget();
    $refinery = $DIC->refinery();
    $request_wrapper = $DIC->http()->wrapper()->query();

    $parameter_name = 'page3';
    $current_page = 0;
    if ($request_wrapper->has($parameter_name)) {
        $current_page = $request_wrapper->retrieve($parameter_name, $refinery->kindlyTo()->int());
    }

    $pagination = $factory->viewControl()->pagination()
        ->withTargetURL($url, $parameter_name)
        ->withTotalEntries(102)
        ->withPageSize(10)
        ->withDropdownAt(5)
        ->withCurrentPage($current_page);

    $custom_pagination = $pagination
        ->withDropdownLabel('current page is %1$d (of %2$d pages in total)');

    list($range_offset, $range_length) = $pagination->getRange()->unpack();
    $result = "Show $range_length entries starting at $range_offset";

    return $renderer->render([$pagination, $custom_pagination])
        . '<hr>'
        . $result;
}

no_pages()

ILIAS\UI\examples\ViewControl\Pagination\no_pages

(

)

---

description: > Example for a pagination view control with no pages

expected output: >

A Pagination with one page only will render as empty string which results into an empty display.

Definition at line 32 of file no_pages.php.

References $DIC, $renderer, and $url.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $url = $DIC->http()->request()->getRequestTarget();

    $pagination = $factory->viewControl()->pagination()
        ->withPageSize(10)
        ->withTotalEntries(10);

    return $renderer->render($pagination);
}

with_signal()

ILIAS\UI\examples\ViewControl\Pagination\with_signal

(

)

---

description: > Example for rendering a pagination view control with a signal

expected output: > ILIAS shows a series of numbers 1-10 in between the "Back" (<) and "Next" (>) glyph. Clicking a number or a glyph

will open a modal including an image.

Definition at line 33 of file with_signal.php.

References $DIC, and $renderer.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();

    $image = $factory->image()->responsive("assets/ui-examples/images/Image/mountains.jpg", "Image source: https://stocksnap.io, Creative Commons CC0 license");
    $page = $factory->modal()->lightboxImagePage($image, 'Mountains');
    $modal = $factory->modal()->lightbox($page);

    $pagination = $factory->viewControl()->pagination()
        ->withTotalEntries(98)
        ->withPageSize(10)
        ->withResetSignals()
        ->withOnSelect($modal->getShowSignal());

    return $renderer->render([$pagination, $modal]);
}