Sayfalama Kütüphanesi

Sayfalama işlemlerini yapmak için oluşturulmuştur. Sayfalama işlemi için 2 izlenecebilecek yol vardır. Birincisi doğrudan doğruya Pagination sınıfının kullanılmasıdır. Diğeri ise Database kütüphanesinin DB::pagination() yöntemidir. İkinci yöntem aslında Pagination sınıfını kullanmaktadır pratikliği doğrudan Database sorgusuna göre sayfalama barının şekillenmesidir. Her ikisinin kullanımına yönelik aşağıda örnekler verilmiştir. Genellikle veritabanından gelen verilere göre sayfalama yapıldığı için ikinci yöntemin kullanımı tavsiye ederiz.

# Bölüm Başlıkları

# Kurulum
# Yapılandırma
# Şema
# Veritabanı Sayfalama
# Ajax Sayfalama

# Kurulum

ZN dağıtımları için kurulum gerekmez.

↓ composer require znframework/package-pagination

# Yapılandırma

Sayfalama ayarları aşağıdaki dosyada yer alır. Bu ayarlar ön tanımlı ayarlardır. İstenirse yöntemlerle ayarlara müdahale edilebilir.

string $output = 'bootstrap'

# Yöntemler

# Create

Sayfalama barı oluşturumak için kullanılır.

Parametreler

array $settings = NULL

Kullanımı

echo Pagination::create();

echo Pagination::create(URI::segment(-1),
[
     'style' => ['links' => 'color:red']
]);

2. Örnekte 1. parametre için URI::segment(-1) yönteminden yararlanmamızdaki amaç sayfalama kayıt numarasının URL'nin son bölümünde olduğu içindir. Eğer sayfalama kayıt numarası farklı bir bölümde ise o bölüme ait segmenti 1. parametreye atayabilirsiniz.

# URL

Sayfalama ayarlarından type:classic ayarlı olduğu sürece sayfalama kütüphanesi URL üzerinden çalışır. Bu nedenle sayfalama barının hangi URL ile çalışılacağı belirtilmelidir. Normalde bu yöntemi kullanmanıza gerek yoktur. Çünkü sayfalama kütüphanesi ön tanımlı olarak mevcut linki otomatik olarak ayarlar. Ancak istisnai durumlar nedeni ile URL belirtimeniz gerekirse bu yöntemden yararlanabilirsiniz.

Parametreler

Kullanımı

echo Pagination::url('products/comments')->create();

# Start 

Sayfama işlemine hangi kayıttan başlanacağı ayarlanır. create() yönteminin 1. parametresine eş değerdir. Sayfa geçildikçe kayıt numarası değişeceği için bu yönteme parametre olarak URL de yer alan kayıt indeksi atanır. Ancak sayfalama kütüphanesi ön tanımlı olarak bu işleme ihtiyaç duymaz. Otomatik olarak URL de yer alan son bölüme ait kayıt indeks numarası baz alınır. URL normal yapı dışında kullanılması gerektiği durumlarda  yani URL deki son bölümün kayıt indeksi olmadığı durumlarda bu yöntemin kullanılması gerekir.

Parametreler

Kullanımı

echo Pagination::start(URI::comments())
               ->create();

# Limit

Her bir sayfanın kaçar kayıt tutacağını ayarlamak için kullanılır.

Parametreler

Kullanımı

echo Pagination::limit(5)
               ->create();

# TotalRows

Toplam kaç kayıtın sayfalama işlemine konu olacağı belirtilir.

Parametreler

Kullanımı

echo Pagination::limit(15)
               ->totalRows(200)
               ->create();

# CountLinks

Sayfalama barında toplam kaç linkin görüntüleneceğidir.

Parametreler

Örnekler

echo Pagination::limit(15)
               ->totalRows(200)
               ->countLinks(3)
               ->create();

# LinkNames

Önceki, sonraki, ilk ve son sayfa linklerinin hangi isimle veya şekille görüntüleneceğini ayarlamak için kullanılır.

Parametreler

Kullanımı

echo Pagination::limit(15)
               ->totalRows(200)
               ->countLinks(3)
               ->linkNames('[ prev ]', '[ next ]', '[+ first +]', '[+ last +]')
               ->create();

# Style

Sayfalama barında yer alan linklere stil uygulamak için kullanılır.

Parametreler

Kullanımı

echo Pagination::limit(15)
               ->totalRows(200)
               ->countLinks(3)
               ->linkNames('[ prev ]', '[ next ]', '[+ first +]', '[+ last +]')
               ->style(['links' => 'color:green;', 'current' => 'font-size:30px;'])
               ->create();

# CSS

Yukarıda yer alan style kullamı ile bire bire aynı mantıktadır. Sadece stil yerine css sınıfları uygulanır.

Parametreler

# Type

Sayfalama barının ajax ile kullanılabilmesi için geliştirilmiştir.

Parametreler

Kullanımı

echo Pagination::type('ajax')->create();

Detaylı kullanımı için tıklayın.

# Paging [6.6.0][2021-03-09]

Normal kullanımda sayfalama işlemi URL üzerinde kayıt numaralarına göre yürütülür. Bu özellik sayesinde istenirse sayfalama işlemi sayfa numarasına göre yürütülür.

Parametreler

Kullanımı

echo Pagination::paging('page')->create();

# Output

Sayfalama barının çıktı türünü değiştirmek için kullanılır. Klasik kullanımda sayfalama barı sadece [a] etiketlerinden oluşurken bootstrap kullanımında [ul] ve [li] kullanımlarını da içerir.

Parametreler

Kullanımı

echo Pagination::output('bootstrap')
               ->limit(15)
               ->totalRows(75)
               ->countLinks(5)
               ->create();

# Veritabanı Entegreli Sayfalama

Veritabanı sorgularından sonra doğrudan sayfala barını oluşturmak için kullanılır.

Parametreler

Kullanımı

$get = DB::limit(NULL, 1)->get('users');

output( $get->result() );

echo $get->pagination(NULL,
[
    'style' =>
    [
        'current' => 'color:red'
    ]
]);

Sayfalama türünü row yerine page olarak ayarlamak için DB::limit() yönteminin 1. parametresini NULL yerine -1 olarak belirleyin.

$get = DB::limit(-1, 50)->get('users');

output( $get->result() );

echo $get->pagination();

# Ajax Sayfalama

Ajax sayfalama işlemi için öncelikle yapılandırma dosyasında yer alan type anahtarının ajax olarak yapılandırılması gerekmektedir.

'type' => 'ajax'

Bu aşamadan sonra sayfalama linkleri incelenirse ajax ile kullanabileceğiniz bazı değerler içerir.

Yukarıdaki etikette yer alan prow özelliği kayıt numarasını tutarken ptype değeri bu etiketi diğerlerinden ayıran bir seçici oluşturur. Bu değerler ajax gönderimi sırasında kullanılacaktır.

Kontrolcü Oluşturun

Sayfalama ve görünüm çağrımı için kontrolcü oluşturun.

<?php namespace Project<]Controllers;

use Import, Http;

class Home extends Controller
{
    public function main(string $params = NULL)
    {   
        
    }

    # void return type provides ajax control in controller.
    public function ajaxPagination() : void
    {
        Import::view('Home/pagination');
    }
}

Görünümleri Oluşturun

Home:main kontrolcüsünün otomatik olarak yükleyeceği görünüm dosyasını oluşturun.

@style('bootstrap')
@script('jquery', 'bootstrap')

<div id="content"> 
    @view('HomePagination') 
</div>

Sayfalama barında bulunan linke tıklandığında değişecek olan içeriklerin ayrı bir görünüm dosyasında tutulması gerekmektedir.

{[ $menus = DB::limit(Post::row() ?: NULL, 2)->menus(); ]}

<table class="table table-striped">
    <thead>
        <tr><td>ID</td><td>NAME</td><td>URL</td></tr>
    </thead>
    <tbody>
        @foreach( $menus->result() as $row )
        <tr><td>{{ $row->id }}</td>{{ $row->name }}</td><td>{{ $row->url }}</td></tr>
        @endforeach
        <tr><td colspan="3">{{ $menus->pagination() }}</td></tr>
    </tbody>
</table>

<script>
    $('#content a[ptype="ajax"]').click(function()
    {
        $.ajax
        ({
            url: '{{ URL::site('Home/ajaxPagination') }}',
            data: {'row': $(this).attr('prow')},
            type: 'post',
            success: function(data)
            {
                $('#content').html(data);
            }
        });
    })
</script>