Basics - 05. Http Requests

Request Path & Method

Die Instanz Illuminate\Http\Request bietet eine Vielzahl von Methoden zur Untersuchung der HTTP-Anfrage für Ihre Anwendung und erweitert die Klasse Symfony\Component\HttpFoundation\Request. Im Folgenden werden einige der wichtigsten Methoden diskutiert.

Retrieving The Request Path

Die Path-Methode gibt die Pfadinformationen der Anforderung zurück. Wenn also die eingehende Anforderung auf http://domain.com/foo/bar gerichtet ist, gibt die Path-Methode foo/bar zurück:

$uri = $request->path();

Mit der is-Methode können Sie überprüfen, ob der eingehende Anforderungspfad mit einem bestimmten Muster übereinstimmt. Sie können das Zeichen * als Platzhalter verwenden, wenn Sie diese Methode verwenden:

if ($request->is('admin/*')) {
    //
}

Retrieving The Request URL

Um die vollständige URL für die eingehende Anforderung abzurufen, können Sie die Methoden url oder fullUrl verwenden. Die URL-Methode gibt die URL ohne die Suchzeichenfolge zurück, während die FullUrl-Methode die Suchzeichenfolge enthält:

// Without Query String...
$url = $request->url();

// With Query String...
$url = $request->fullUrl();

Retrieving The Request Method

Die Method-Methode gibt das HTTP-Verb für die Anforderung zurück. Sie können die isMethod-Methode verwenden, um sicherzustellen, dass das HTTP-Verb mit einer bestimmten Zeichenkette übereinstimmt:

$method = $request->method();

if ($request->isMethod('post')) {
    //
}

PSR-7 Requests

Der PSR-7-Standard spezifiziert Schnittstellen für HTTP-Nachrichten, einschließlich Anfragen und Antworten. Wenn Sie eine Instanz einer PSR-7-Anfrage anstelle einer Laravel-Anfrage erhalten möchten, müssen Sie zunächst einige Bibliotheken installieren. Laravel verwendet die Komponente Symfony HTTP Message Bridge, um typische Laravel-Anfragen und -Antworten in PSR-7-kompatible Implementierungen zu konvertieren:

composer require symfony/psr-http-message-bridge
composer require zendframework/zend-diactoros

Nachdem Sie diese Bibliotheken installiert haben, können Sie eine PSR-7-Anforderung erhalten, indem Sie ihr Interface auf Ihrer Route Closure oder Controller-Methode hinweisen (type-hinting):

use Psr\Http\Message\ServerRequestInterface;

Route::get('/', function (ServerRequestInterface $request) {
    //
});

Input Trimming & Normalization (Eingangsabgleich & Normalisierung)

Standardmäßig beinhaltet Laravel die Middleware TrimStrings und ConvertEmptyStringsToNull in den globalen Middleware-Stapel Ihrer Anwendung. Diese Middleware wird im Stapel von der Klasse App\Http\Kernel aufgelistet. Diese Middleware schneidet automatisch alle eingehenden Zeichenkettenfelder auf die Anfrage zu und konvertiert alle leeren Zeichenkettenfelder in Null. Dies ermöglicht es Ihnen, sich keine Sorgen um diese Normierungsprobleme in Ihren Routen und Steuerungen machen zu müssen.

Wenn Sie dieses Verhalten deaktivieren möchten, können Sie die beiden Middleware aus dem Middleware-Stapel Ihrer Anwendung entfernen, indem Sie sie aus der $middleware-Eigenschaft Ihrer App\Http\Kernel-Klasse entfernen.

Retrieving Input

Abrufen aller Eingangsdaten
Sie können auch alle Eingabedaten als Array mit der all-Methode abrufen:

$input = $request->all();

Retrieving An Input Value

Mit ein paar einfachen Methoden können Sie auf alle Benutzereingaben aus Ihrer Illuminate\Http\Request-Instanz zugreifen, ohne sich Gedanken darüber zu machen, welches HTTP-Verb für die Anfrage verwendet wurde. Unabhängig vom HTTP-Verb kann die input-Methode verwendet werden, um Benutzereingaben abzurufen:

$name = $request->input('name');

Sie können der input-Methode einen Standardwert als zweites Argument übergeben. Dieser Wert wird zurückgegeben, wenn der angeforderte Eingangswert bei der Anforderung nicht vorhanden ist:

$name = $request->input('name', 'Sally');

Wenn Sie mit Formularen arbeiten, die Array-Eingaben enthalten, verwenden Sie die "Punkt"-Notation (dot notation), um auf die Arrays zuzugreifen:

$name = $request->input('products.0.name');

$name = $request->input('products.*.name');

Sie können die input-Methode ohne Argumente aufrufen, um alle Eingabewerte als assoziatives Array abzurufen:

$input = $request->input();

Retrieving Input From The Query String

Während die input-Methode Werte aus der gesamten Anforderungs-Nutzlast (einschließlich des Query-Strings) abruft, ruft die query-Methode nur Werte aus dem Query-String ab:

$name = $request->query('name');

Wenn die angeforderten Daten des Query-String-Wertes nicht vorhanden sind, wird das zweite Argument dieser Methode zurückgegeben:

$name = $request->query('name','Helen');

Sie können die query-Methode ohne Argumente aufrufen, um alle Werte der Abfragezeichenkette als assoziatives Array abzurufen:

$name = $request->query();

Retrieving Input Via Dynamic Properties

Sie können auch auf Benutzereingaben über dynamische Eigenschaften in der Instanz Illuminate\Http\Request zugreifen. Wenn beispielsweise eines der Formulare Ihrer Anwendung ein Namensfeld (name-field) enthält, können Sie auf den Wert des Feldes wie folgt zugreifen:

$name = $request->name;

Bei der Verwendung dynamischer Eigenschaften sucht Laravel zunächst nach dem Wert des Parameters in der Request-Payload. Wenn es nicht vorhanden ist, sucht Laravel nach dem Feld in den Routenparametern.

Retrieving JSON Input Values

Wenn Sie JSON-Anfragen an Ihre Anwendung senden, können Sie über die input-Methode auf die JSON-Daten zugreifen, solange der Content-Type-Header der Anforderung korrekt auf application/json gesetzt ist. Sie können sogar die "Punkt"-Syntax verwenden, um sich in JSON-Arrays zu vertiefen:

$name = $request->input('user.name');

Retrieving A Portion Of The Input Data

Wenn Sie eine Teilmenge der Eingabedaten abrufen müssen, können Sie die only-Methode und die except-Methode verwenden. Beide Methoden akzeptieren ein einzelnes Array oder eine dynamische Liste von Argumenten:

$input = $request->only(['username', 'password']);

$input = $request->only('username', 'password');

$input = $request->except(['credit_card']);

$input = $request->except('credit_card');

Determining If An Input Value Is Present

Sie sollten die has-Methode verwenden, um zu bestimmen, ob ein Wert auf der Anforderung vorhanden ist. Die has-Methode gibt true zurück, wenn der Wert auf der Anforderung vorhanden ist:

if ($request->has('name')) {
    //
}

Wenn ein Array angegeben wird, bestimmt die has-Methode, ob alle angegebenen Werte vorhanden sind:

if ($request->has(['name', 'email'])) {
    //
}

Wenn Sie feststellen möchten, ob ein Wert auf der Anfrage vorhanden ist und nicht leer ist, können Sie die filled-Methode verwenden:

if ($request->filled('name')) {
    //
}

Old Input

Laravel ermöglicht es Ihnen, die Eingabe von einer Anforderung während der nächsten Anforderung beizubehalten. Diese Funktion ist besonders nützlich, um Formulare nach der Erkennung von Validierungsfehlern neu zu füllen. Wenn Sie jedoch die in Laravel enthaltenen Validierungsfunktionen verwenden, ist es unwahrscheinlich, dass Sie diese Methoden manuell verwenden müssen, da einige der in Laravel integrierten Validierungsfunktionen sie automatisch aufrufen.

Flashing Input To The Session

Die flash-Methode der Klasse Illuminate\Http\Request flasht die aktuelle Eingabe in die Session, so dass sie bei der nächsten Anfrage des Benutzers an die Anwendung verfügbar ist:

$request->flash();

Sie können auch die Methoden flashOnly und flashExcept verwenden, um eine Teilmenge der Anforderungsdaten in die Sitzung zu flashen. Diese Methoden sind nützlich, um sensible Informationen wie Passwörter aus der Sitzung herauszuhalten:

$request->flashOnly(['username', 'email']);

$request->flashExcept('password');

Flashing Input Then Redirecting

Da Sie oft die Eingabe in die Sitzung flashen und dann zur vorherigen Seite umleiten möchten, können Sie die Eingabe, die auf eine Umleitung blinkt, mit der withInput-Methode einfach verketten:

return redirect('form')->withInput();

return redirect('form')->withInput(
    $request->except('password')
);

Retrieving Old Input

Um geflashte Eingaben aus dem vorherigen Request abzurufen, verwenden Sie die old-Methode auf der Request Instanz. Die old-Methode zieht die zuvor geflashten Eingabedaten aus der Session:

$username = $request->old('username');

Laravel bietet auch einen globalen old-Helfer. Wenn Sie alte Eingaben innerhalb einer Blade-Template anzeigen, ist es bequemer, den old-Helfer zu verwenden. Wenn für das angegebene Feld keine alte Eingabe existiert, wird null zurückgegeben:

<input type="text" name="username" value="{{ old('username') }}">

Cookies

Retrieving Cookies From Requests

Alle vom Laravel-Framework erstellten Cookies werden verschlüsselt und mit einem Authentifizierungscode signiert, d.h. sie gelten als ungültig, wenn sie vom Client geändert wurden. Um einen Cookie-Wert aus der Anforderung abzurufen, verwenden Sie die Cookie-Methode auf einer Illuminate\Http\Request-Instanz:

$value = $request->cookie('name');

Alternativ können Sie auch die Cookie-Facade verwenden, um auf Cookie-Werte zuzugreifen:

use Illuminate\Support\Facades\Cookie;

$value = Cookie::get('name');

Attaching Cookies To Responses

Sie können ein Cookie an eine ausgehende Illuminate\Http\Response-Instanz mit der Cookie-Methode anhängen. Sie sollten den Namen, den Wert und die Anzahl der Minuten übergeben, die das Cookie als gültig für diese Methode angesehen werden sollte:

return response('Hello World')->cookie(
    'name', 'value', $minutes
);

Die Cookie-Methode akzeptiert auch ein paar weitere Argumente, die weniger häufig verwendet werden. Im Allgemeinen haben diese Argumente den gleichen Zweck und die gleiche Bedeutung wie die Argumente, die der nativen setcookie-Methode von PHP gegeben würden:

return response('Hello World')->cookie(
    'name', 'value', $minutes, $path, $domain, $secure, $httpOnly
);

Alternativ können Sie die Cookie-Facade verwenden, um Cookies in die "Queue" zu stellen, um sie an die ausgehende Antwort Ihrer Anwendung anzuhängen. Die queue -Methode akzeptiert eine Cookie-Instanz oder die Argumente, die zum Erstellen einer Cookie-Instanz benötigt werden. Diese Cookies werden an die ausgehende Antwort angehängt, bevor sie an den Browser gesendet werden:

Cookie::queue(Cookie::make('name', 'value', $minutes));

Cookie::queue('name', 'value', $minutes);

Generating Cookie Instances

Wenn Sie eine Symfony\Component\HttpFoundation\Cookie-Instanz erzeugen möchten, die zu einem späteren Zeitpunkt an eine Response-Instanz übergeben werden kann, können Sie den globalen Cookie-Helfer verwenden. Dieses Cookie wird nicht an den Client zurückgesendet, es sei denn, es ist an eine Antwortinstanz (Response-Instance) gebunden:

$cookie = cookie('name', 'value', $minutes);

return response('Hello World')->cookie($cookie);

Files

Retrieving Uploaded Files

Sie können auf hochgeladene Dateien aus einer Illuminate\Http\Request-Instanz mit der Datei-Methode oder mit dynamischen Eigenschaften zugreifen. Die file-Methode gibt eine Instanz der Klasse Illuminate\Http\UploadedFile zurück, die die PHP SplFileInfo-Klasse erweitert und eine Vielzahl von Methoden zur Interaktion mit der Datei bereitstellt:

$file = $request->file('photo');

$file = $request->photo;

Ob eine Datei auf der Anfrage vorhanden ist, können Sie mit der hasFile-Methode feststellen:

if ($request->hasFile('photo')) {
    //
}

Validating Successful Uploads

Zusätzlich zur Überprüfung, ob die Datei vorhanden ist, können Sie überprüfen, ob es keine Probleme beim Hochladen der Datei mit der isValid-Methode gab:

if ($request->file('photo')->isValid()) {
    //
}

File Paths & Extensions

Die Klasse UploadedFile enthält auch Methoden für den Zugriff auf den voll qualifizierten Pfad der Datei und deren Erweiterung. Die extension-Methode versucht, die Erweiterung der Datei anhand ihres Inhalts zu erraten. Diese Erweiterung kann sich von der vom Kunden bereitgestellten Erweiterung unterscheiden:

$path = $request->photo->path();

$extension = $request->photo->extension();

Es gibt eine Vielzahl anderer Methoden, die auf UploadedFile-Instanzen verfügbar sind. Weitere Informationen zu diesen Methoden finden Sie in der API-Dokumentation der Klasse.

Storing Uploaded Files

Um eine hochgeladene Datei zu speichern, verwenden Sie in der Regel eines Ihrer konfigurierten Dateisysteme. Die Klasse UploadedFile hat eine store-Methode, die eine hochgeladene Datei auf eine Ihrer Festplatten verschiebt, die ein Ort auf Ihrem lokalen Dateisystem oder sogar ein Cloud-Speicherort wie Amazon S3 sein kann.

Die store-Methode akzeptiert den Pfad, in dem die Datei gespeichert werden soll, relativ zum konfigurierten Stammverzeichnis des Dateisystems. Dieser Pfad sollte keinen Dateinamen enthalten, da automatisch eine eindeutige ID generiert wird, die als Dateiname dient.

Die store-Methode akzeptiert auch ein optionales zweites Argument für den Namen der Festplatte, die zum Speichern der Datei verwendet werden soll. Die Methode gibt den Pfad der Datei relativ zum Stammverzeichnis der Festplatte zurück:

$path = $request->photo->store('images');

$path = $request->photo->store('images', 's3');

Wenn Sie nicht möchten, dass ein Dateiname automatisch generiert wird, können Sie die storeAs-Methode verwenden, die den Pfad, Dateinamen und Festplattennamen als Argumente akzeptiert:

$path = $request->photo->storeAs('images', 'filename.jpg');

$path = $request->photo->storeAs('images', 'filename.jpg', 's3');

Configuring Trusted Proxies

Wenn Sie Ihre Anwendungen hinter einem Load Balancer betreiben, der TLS-/SSL-Zertifikate beendet, werden Sie feststellen, dass Ihre Anwendung manchmal keine HTTPS-Links generiert. Typischerweise liegt das daran, dass Ihre Anwendung den Datenverkehr von Ihrem Load Balancer auf Port 80 weitergeleitet bekommt und nicht weiß, dass sie sichere Verbindungen erzeugen sollte.

Um dies zu lösen, können Sie die in Ihrer Laravel-Anwendung enthaltene Middleware App\Http\Middleware\TrustProxies verwenden, mit der Sie die Lastausgleiche oder Proxies, denen Ihre Anwendung vertrauen sollte, schnell anpassen können. Ihre vertrauenswürdigen Proxies sollten als Array auf der $proxies-Eigenschaft dieser Middleware aufgelistet werden. Zusätzlich zur Konfiguration der vertrauenswürdigen Proxies können Sie die Proxy-$header konfigurieren, denen vertraut werden soll:

<?php

namespace App\Http\Middleware;

use Illuminate\Http\Request;
use Fideloper\Proxy\TrustProxies as Middleware;

class TrustProxies extends Middleware
{
    /**
     * The trusted proxies for this application.
     *
     * @var array
     */
    protected $proxies = [
        '192.168.1.1',
        '192.168.1.2',
    ];

    /**
     * The headers that should be used to detect proxies.
     *
     * @var string
     */
    protected $headers = Request::HEADER_X_FORWARDED_ALL;
}

Trusting All Proxies

Wenn Sie Amazon AWS oder einen anderen "Cloud"-load balancer provider verwenden, kennen Sie möglicherweise die IP-Adressen Ihrer aktuellen Balancers (Ausgleicher) nicht. In diesem Fall können Sie * verwenden, um allen Proxies zu vertrauen:

/**
 * The trusted proxies for this application.
 *
 * @var array
 */
protected $proxies = '*';