muhammetsafak/php-pagination

PHP Pagination Class

0.1 2022-04-23 03:55 UTC

Requires

• php: >=7.4

MIT

• Muhammet ŞAFAK

README

PHP Sayfalama Sınıfı

Kurulum

composer require muhammetsafak/php-pagination

Yöntemler

__construct()

Sınıfın kurucu metodudur.

public function __construct(int $page, int $totalRow, int $perPageLimit = 10, string $linkTemplate = '?page={page}')

• $page : Geçerli sayfa
• $totalRow : Sayfalanacak toplam satır/içerik sayısı
• $perPageLimit : Sayfa başına listelenecek satır/içerik sayısı
• $linkTemplate : Sayfaların link şablonunu tanımlar.

getPage()

Geçerli sayfayı döndürür.

public function getPage(): int

getLimit()

Sayfa başına gösterilen içerik/satır sayısını döndürür.

public function getLimit(): int

getOffset()

Geçerli sayfanın son satır/içerik sayısını döndürür.

public function getOffset(): int

linkTemplate()

Link şablonunu tanımlar.

public function linkTemplate(string $template): self

setPerPageLimit()

Sayfa başına gösterilen satır/içerik sayısını tanımlar.

public function setPerPageLimit(int $perPageLimit = 10): self

setTotalRow()

Sayfalanacak toplam satır/içerik sayısını tanımlar.

public function setTotalRow(int $totalRow = 0): self

setHowDisplayedPage()

Gösterilecek toplam sayfa sayısını tanımlar.

public function setHowDisplayedPage(int $howDisplayedPage = 8): self

• $howDisplayedPage : Bir çift sayı.

getPagination()

Sayfalama HTML'i oluşturabileceğiniz bir dizi döndürür.

public function getPagination(): array

Dönecek dizi şuna benzer;

array(
    array(
        'url' => 'http://example.com/page/1',
        'page => 1,
        'active' => false
    ),
    array(
        'url' => 'http://example.com/page/2',
        'page => 2,
        'active' => true
    ),
    array(
        'url' => 'http://example.com/page/3',
        'page => 3,
        'active' => false
    )
);

nextPage()

Varsa sonraki sayfanın URL'sini içeren bir dizi döndürür. Yoksa NULL döndürür.

public function nextPage(): array|null

Dönecek dizi şuna benzer;

[
    'url'   => 'http://example.com/?page=4',
    'page'  => 4,
];

prevPage()

Varsa önceki sayfanın URL'sini içeren bir dizi döndürür. Yoksa NULL döndürür.

public function prevPage(): array|null

Dönecek dizi şuna benzer;

[
    'url'   => 'http://example.com/?page=3',
    'page'  => 3,
];

showPagination()

Bootstrap 5 için uyumlu bir pagination oluşturur ve döndürür.

public function showPagination(array $configs = []): string

$configs dizisi aşağıdaki elemanlara sahip olabilir;

• ul_class : ul html etiketinin class niteliğine eklenecek dize.
• li_class : li html etiketinin class niteliğine eklenecek dize.
• prev_display : Önceki sayfa iteminin eklenip eklenmeyeceğini belirten mantıksal değer. Varsayılan true.
• next_display : Sonraki sayfa iteminin eklenip eklenmeyeceğini belirten mantıksal değer. Varsayılan true.
• prev_li_class : Önceki sayfa iteminin class niteliğine eklenecek dize.
• next_li_class : Sonraki sayfa iteminin class niteliğine eklenecek dize.
• prev_text : Önceki sayfa iteminde görünecek dize. Varsayılan "Previous"
• next_text : Sonraki sayfa iteminde görünecek dize. Varsayılan "Next"

Kullanımı

$pagination = new \MuhammetSafak\Pagination\Pagination(1, 100, 10, 'https://www.example.com/page/{page}');

Lisans

Bu kütüphane Muhammet ŞAFAK tarafından geliştirilip MIT Lisansı ile birlikte dağıtılmaktadır.