Pagination.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\Implementation\Component\ViewControl;
 
use ILIAS\UI\Component\Signal;
use ILIAS\UI\Component\ViewControl\Pagination as PaginationInterface;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Implementation\Component\SignalGeneratorInterface;
use ILIAS\UI\Implementation\Component\Triggerer;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use ILIAS\Data\Range;
 
class Pagination implements PaginationInterface
{
    use ComponentHelper;
    use JavaScriptBindable;
    use Triggerer;
 
    protected int $total_entries = 0;
    protected int $page_size;
    protected int $current_page = 0;
    protected Signal $internal_signal;
    protected ?string $target_url = null;
    protected string $parameter_name = "pagination_offset";
    protected ?int $max_pages_shown = null;
    protected ?int $dd_threshold = null;
    protected string $dropdown_label;
    protected SignalGeneratorInterface $signal_generator;
 
    public function __construct(SignalGeneratorInterface $signal_generator)
    {
        $this->signal_generator = $signal_generator;
        $this->initSignals();
        $this->dropdown_label = self::DEFAULT_DROPDOWN_LABEL;
    }
 
    public function withResetSignals(): PaginationInterface
    {
        $clone = clone $this;
        $clone->initSignals();
        return $clone;
    }
 
    protected function initSignals(): void
    {
        $this->internal_signal = $this->signal_generator->create();
    }
 
    public function getInternalSignal(): Signal
    {
        return $this->internal_signal;
    }
 
    public function withTargetURL(string $url, string $parameter_name): PaginationInterface
    {
        $clone = clone $this;
        $clone->target_url = $url;
        $clone->parameter_name = $parameter_name;
        return $clone;
    }
 
    public function getTargetURL(): ?string
    {
        return $this->target_url;
    }
 
    public function getParameterName(): string
    {
        return $this->parameter_name;
    }
 
    public function withTotalEntries(int $total): PaginationInterface
    {
        $clone = clone $this;
        $clone->total_entries = $total;
        return $clone;
    }
 
    public function withPageSize(int $size): PaginationInterface
    {
        //raise, if size < 1
        $clone = clone $this;
        $clone->page_size = $size;
        return $clone;
    }
 
    public function getPageSize(): int
    {
        return $this->page_size;
    }
 
    public function withCurrentPage(int $page): PaginationInterface
    {
        $clone = clone $this;
        $clone->current_page = $page;
        return $clone;
    }
 
    public function getCurrentPage(): int
    {
        return $this->current_page;
    }
 
    protected function getOffset(): int
    {
        return $this->page_size * $this->current_page;
    }
 
    public function withOnSelect(Signal $signal): PaginationInterface
    {
        return $this->withTriggeredSignal($signal, 'select');
    }
 
    public function getNumberOfPages(): int
    {
        $pages = ceil($this->total_entries / $this->page_size);
        return (int) $pages;
    }
 
    public function withMaxPaginationButtons(int $amount): PaginationInterface
    {
        $clone = clone $this;
        $clone->max_pages_shown = $amount;
        return $clone;
    }
 
    public function getMaxPaginationButtons(): ?int
    {
        return $this->max_pages_shown;
    }
 
    protected function getPageLength(): int
    {
        if ($this->getOffset() + $this->page_size > $this->total_entries) {
            return $this->total_entries - $this->getOffset();
        }
        return $this->page_size;
    }
 
    public function withDropdownAt(int $amount): PaginationInterface
    {
        $clone = clone $this;
        $clone->dd_threshold = $amount;
        return $clone;
    }
 
    public function getDropdownAt(): ?int
    {
        return $this->dd_threshold;
    }
 
    public function withDropdownLabel(string $template): PaginationInterface
    {
        $clone = clone $this;
        $clone->dropdown_label = $template;
        return $clone;
    }
 
    public function getDropdownLabel(): string
    {
        return $this->dropdown_label;
    }
 
    public function getDefaultDropdownLabel(): string
    {
        return self::DEFAULT_DROPDOWN_LABEL;
    }
 
    public function getRange(): ?Range
    {
        if ($this->getPageLength() < 1) {
            return null;
        }
        $f = new \ILIAS\Data\Factory();
        return $f->range($this->getOffset(), $this->getPageLength());
    }
}