Database - 3. Pagination

Basic Usage

Paginating Query Builder Results

Es gibt mehrere Möglichkeiten, um Elemente umzupaginieren. Die einfachste ist die Verwendung der paginate-Methode im Query Builder oder eine Eloquent-Abfrage. Die paginate-Methode sorgt automatisch für die Einstellung der richtigen Grenze und des richtigen Offsets, basierend auf der aktuellen Seite, die der Benutzer betrachtet. Standardmäßig wird die aktuelle Seite durch den Wert des Page Query String Arguments auf der HTTP-Anfrage erkannt. Dieser Wert wird automatisch von Laravel erkannt und wird auch automatisch in die vom Paginator generierten Links eingefügt.

In diesem Beispiel ist das einzige Argument, das an die paginate-Methode übergeben wird, die Anzahl der Elemente, die "pro Seite" angezeigt werden sollen. In diesem Fall geben wir an, dass wir 15 Elemente pro Seite anzeigen möchten:

<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\DB;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * Show all of the users for the application.
     *
     * @return Response
     */
    public function index()
    {
        $users = DB::table('users')->paginate(15);

        return view('user.index', ['users' => $users]);
    }
}

"Simple Pagination"

Wenn Sie nur einfache "Nächste" und "Vorherige" Links in Ihrer Paginierungsansicht anzeigen müssen, können Sie die simplePaginate Methode verwenden, um eine effizientere Abfrage durchzuführen. Dies ist sehr nützlich für große Datensätze, wenn Sie beim Rendern Ihrer Ansicht nicht für jede Seitennummer einen Link anzeigen müssen:

$users = DB::table('users')->simplePaginate(15);

Paginating Eloquent Results

Sie können auch eloquente Abfragen paginieren. In diesem Beispiel paginieren wir das User-Modell mit 15 Elementen pro Seite. Wie Sie sehen können, ist die Syntax fast identisch mit der Paginierung von Query Builder-Ergebnissen:

$users = App\User::paginate(15);

Sie können paginieren, nachdem Sie andere Einschränkungen auf die Abfrage gesetzt haben, wie z.B. where Klauseln:

$users = User::where('votes', '>', 100)->paginate(15);

Sie können auch die simplePaginate Methode verwenden, wenn Sie eloquente Modelle paginieren:

$users = User::where('votes', '>', 100)->simplePaginate(15);

Manually Creating A Paginator

Manchmal möchten Sie vielleicht eine Paginierungsinstanz manuell erstellen und ihr ein Array von Elementen übergeben. Sie können dies tun, indem Sie entweder eine Illuminate\Pagination\Paginator oder Illuminate\Pagination\LengthAwarePaginator Instanz erstellen, je nach Ihren Bedürfnissen.

Die Paginator Klasse muss nicht die Gesamtzahl der Elemente in der Ergebnismenge kennen; aus diesem Grund hat die Klasse jedoch keine Methoden zum Abrufen des Index der letzten Seite. Der LengthAwarePaginator akzeptiert fast die gleichen Argumente wie der Paginator; er benötigt jedoch eine Zählung der Gesamtzahl der Elemente in der Ergebnismenge.

Mit anderen Worten, der Paginator entspricht der Methode simplePaginate im Query Builder und Eloquent, während der LengthAwarePaginator der Methode paginate entspricht.

Displaying Pagination Results

Beim Aufruf der Methode paginate erhalten Sie eine Instanz von Illuminate\Pagination\LengthAwarePaginator. Wenn Sie die Methode simplePaginate aufrufen, erhalten Sie eine Instanz von Illuminate\Pagination\Paginator. Diese Objekte stellen mehrere Methoden zur Verfügung, die die Ergebnismenge beschreiben. Zusätzlich zu diesen Hilfsmethoden sind die Paginator-Instanzen Iteratoren und können als Array in einer Schleife ausgeführt werden. Sobald Sie also die Ergebnisse abgerufen haben, können Sie die Ergebnisse anzeigen und die Seitenlinks mit Blade rendern:

<div class="container">
    @foreach ($users as $user)
        {{ $user->name }}
    @endforeach
</div>

{{ $users->links() }}

Die links-Methode wird die Links zu den restlichen Seiten in der Ergebnismenge rendern. Jeder dieser Links wird bereits die richtige Seitenabfrage-String-Variable enthalten. Denken Sie daran, dass das durch die links-Methode generierte HTML mit dem Bootstrap CSS-Framework kompatibel ist.

Customizing The Paginator URI

Mit der withPath-Methode können Sie den vom Paginator bei der Erzeugung von Links verwendeten URI anpassen. Wenn Sie beispielsweise möchten, dass der Paginator Links wie http://example.com/custom/url?page=N generiert, sollten Sie custom/url an die withPath-Methode übergeben:

Route::get('users', function () {
    $users = App\User::paginate(15);

    $users->withPath('custom/url');

    //
});

Appending To Pagination Links

Sie können an den Abfrage-String von Paginierungslinks mit der appends-Methode anhängen. Um z.B. sort=votes an jeden Paginierungslink anzuhängen, sollten Sie den folgenden Aufruf an appends machen:

{{ $users->appends(['sort' => 'votes'])->links() }}

Wenn Sie an die URLs des Paginators ein "Hash-Fragment" anhängen möchten, können Sie die fragment-Methode verwenden. Um beispielsweise #foo an das Ende jedes Paginierungslinks anzuhängen, rufen Sie die fragment-Methode wie folgt auf:

{{ $users->fragment('foo')->links() }}

Adjusting The Pagination Link Window

Sie können steuern, wie viele zusätzliche Links auf jeder Seite des URL-"Fensters" des Paginators angezeigt werden. Standardmäßig werden drei Links auf jeder Seite der primären Paginator-Links angezeigt. Sie können diese Anzahl jedoch mit der onEachSide-Methode steuern:

{{ $users->onEachSide(5)->links() }}

Converting Results To JSON

Die Laravel Paginator Ergebnisklassen implementieren den Illuminate\Contracts\Support\Json Interface Vertrag und stellen die toJson-Methode dar, so dass es sehr einfach ist, Ihre Paginierungsergebnisse in JSON zu konvertieren. Sie können auch eine Paginator-Instanz in JSON konvertieren, indem Sie sie von einer Route oder einer Controller-Aktion zurückgeben:

Route::get('users', function () {
    return App\User::paginate();
});

Der JSON aus dem Paginator wird Meta-Informationen wie total, current_page, last_page und mehr enthalten. Die eigentlichen Ergebnisobjekte werden über den data key im JSON-Array verfügbar sein. Hier ist ein Beispiel für das JSON, das durch die Rückgabe einer Paginator-Instanz von einer Route erzeugt wird:

{
   "total": 50,
   "per_page": 15,
   "current_page": 1,
   "last_page": 4,
   "first_page_url": "http://laravel.app?page=1",
   "last_page_url": "http://laravel.app?page=4",
   "next_page_url": "http://laravel.app?page=2",
   "prev_page_url": null,
   "path": "http://laravel.app",
   "from": 1,
   "to": 15,
   "data":[
        {
            // Result Object
        },
        {
            // Result Object
        }
   ]
}

Customizing The Pagination View

Standardmäßig sind die Ansichten, die zur Anzeige der Paginierungslinks gerendert werden, mit dem Bootstrap-CSS-Framework kompatibel. Wenn Sie jedoch nicht Bootstrap verwenden, können Sie Ihre eigenen Ansichten definieren, um diese Links zu rendern. Wenn Sie die links-Methode auf einer Paginator-Instanz aufrufen, übergeben Sie den View-Namen als erstes Argument an die Methode:

{{ $paginator->links('view.name') }}

// Passing data to the view...
{{ $paginator->links('view.name', ['foo' => 'bar']) }}

Am einfachsten ist es jedoch, die Paginierungsansichten anzupassen, indem Sie sie mit dem Befehl vendor:publish in Ihr Verzeichnis resources/views/vendor exportieren:

php artisan vendor:publish --tag=laravel-pagination

Dieser Befehl platziert die Ansichten im Verzeichnis resources/views/vendor/pagination. Die Datei bootstrap-4.blade.php innerhalb dieses Verzeichnisses entspricht der Standard-Paginierungsansicht. Sie können diese Datei bearbeiten, um die Paginierung HTML zu ändern.

Wenn Sie eine andere Datei als die Standard-Paginierungsansicht festlegen möchten, können Sie die Methoden defaultView und defaultSimpleView des Paginators innerhalb Ihres AppServiceProviders verwenden:

use Illuminate\Pagination\Paginator;

public function boot()
{
    Paginator::defaultView('view-name');

    Paginator::defaultSimpleView('view-name');
}

Paginator Instance Methods

Jede Paginator-Instanz liefert zusätzliche Paginierungsinformationen über die folgenden Methoden:

$results->count()

$results->currentPage()

$results->firstItem()

$results->getOptions()

$results->getUrlRange($start, $end)

$results->hasMorePages()

$results->items()

$results->lastItem()

$results->lastPage()

$results->nextPageUrl()

$results->onFirstPage()

$results->perPage()

$results->previousPageUrl()

$results->total()

$results->url($page)