Digging Deeper - 07.5 Helpers - Miscellaneous

Die abort-Funktion wirft eine HTTP-Exception, die vom Exception-Handler gerendert wird:

abort(403);

Sie können auch den Antworttext der Ausnahme und benutzerdefinierte Antwortkopfzeilen bereitstellen:

abort(403, 'Unauthorized.', $headers);

Die Funktion abort_if wirft eine HTTP-Ausnahme, wenn ein gegebener boolescher Ausdruck als true ausgewertet wird:

abort_if(! Auth::user()->isAdmin(), 403);

Wie bei der abort-Methode können Sie auch hier den Antworttext der Ausnahme als drittes Argument und eine Reihe von benutzerdefinierten Antwortkopfzeilen als viertes Argument angeben.

Die Funktion abort_unless wirft eine HTTP-Ausnahme, wenn ein gegebener boolescher Ausdruck als false gewertet wird:

abort_unless(Auth::user()->isAdmin(), 403);

Wie bei der abort-Methode können Sie auch hier den Antworttext der Ausnahme als drittes Argument und eine Reihe von benutzerdefinierten Antwortkopfzeilen als viertes Argument angeben.

Die Funktion app gibt die Service-Container-Instanz zurück:

$container = app();

Sie können einen Klassen- oder Interfacenamen übergeben, um ihn aus dem Container aufzulösen:

$api = app('HelpSpot\API');

Die auth-Funktion gibt eine Authentifizierungsinstanz zurück. Sie können sie der Einfachheit halber anstelle der Auth-Fassade verwenden:

$user = auth()->user();

Falls erforderlich, können Sie angeben, auf welche Wächterinstanz (guard instance) Sie zugreifen möchten:

$user = auth('admin')->user();

Die back-Funktion erzeugt eine Umleitung der HTTP-Antwort auf den vorherigen Standort des Benutzers:

return back($status = 302, $headers = [], $fallback = false);

return back();

Die Funktion bcrypt hasht den angegebenen Wert mit Bcrypt. Sie können sie als Alternative zur Hash-Fassade verwenden:

$password = bcrypt('my-secret-password');

Die Funktion blank gibt zurück, ob der angegebene Wert "blank" ist:

blank('');
blank('   ');
blank(null);
blank(collect());

// true

blank(0);
blank(true);
blank(false);

// false

Für die Umkehrung von blank siehe die filled-Methode.

Die broadcast-Funktion überträgt das jeweilige Ereignis an seine Zuhörer:

broadcast(new UserRegistered($user));

Die cache-Funktion kann verwendet werden, um Werte aus dem Cache zu erhalten. Wenn der angegebene Schlüssel im Cache nicht existiert, wird ein optionaler Standardwert zurückgegeben:

$value = cache('key');

$value = cache('key', 'default');

Sie können Elemente zum Cache hinzufügen, indem Sie ein Array von Schlüssel/Wert-Paaren an die Funktion übergeben. Sie sollten auch die Anzahl der Sekunden oder die Dauer übergeben, die der gecachte Wert als gültig betrachtet werden soll:

cache(['key' => 'value'], 300);

cache(['key' => 'value'], now()->addSeconds(10));

Die Funktion class_uses_recursive gibt alle Merkmale zurück, die von einer Klasse verwendet werden, einschließlich der Merkmale, die von allen ihren Elternklassen verwendet werden:

$traits = class_uses_recursive(App\User::class);

Die Funktion collect erzeugt aus dem gegebenen Wert eine Sammelinstanz (Collection):

$collection = collect(['taylor', 'abigail']);

Die config-Funktion erhält den Wert einer Konfigurationsvariablen. Auf die Konfigurationswerte kann mit der "Punkt"-Syntax zugegriffen werden, die den Namen der Datei und die Option, auf die Sie zugreifen möchten, enthält. Ein Standardwert kann angegeben werden und wird zurückgegeben, wenn die Konfigurationsoption nicht existiert:

$value = config('app.timezone');

$value = config('app.timezone', $default);

Sie können Konfigurationsvariablen zur Laufzeit setzen, indem Sie ein Array von Schlüssel/Wert-Paaren übergeben:

config(['app.debug' => true]);

Die cookie-Funktion erzeugt eine neue Cookie-Instanz:

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

Die Funktion csrf_field erzeugt ein verborgenes (hidden) HTML-Eingabefeld, das den Wert des CSRF-Tokens enthält. Zum Beispiel unter Verwendung der Blade-Syntax:

{{ csrf_field() }}

Die Funktion csrf_token ruft den Wert des aktuellen CSRF-Tokens ab:

$token = csrf_token();

Die Funktion dd (die and dump) gibt die angegebenen Variablen aus und beendet die Ausführung des Skripts:

dd($value);

dd($value1, $value2, $value3, ...);

Wenn Sie die Ausführung Ihres Skripts nicht anhalten wollen, verwenden Sie stattdessen die dump-Funktion.

Die decrypt-Funktion entschlüsselt den gegebenen Wert mit Hilfe des Laravel-Encrypter:

$decrypted = decrypt($encrypted_value);

Die dispatch-Funktion schiebt den gegebenen Job in die Laravel-Job-Warteschlange:

dispatch(new App\Jobs\SendEmails);

Die Funktion dispatch_now führt den angegebenen Auftrag sofort aus und gibt den Wert aus seiner Handle-Methode zurück:

$result = dispatch_now(new App\Jobs\SendEmails);

Die dump-Funktion dumpt die angegebenen Variablen:

dump($value);

dump($value1, $value2, $value3, ...);

Wenn Sie die Ausführung des Skripts nach dem Dumping der Variablen beenden möchten, verwenden Sie stattdessen die Funktion dd.

Die encrypt-Funktion verschlüsselt den gegebenen Wert mit dem Laravel-Encrypter:

$encrypted = encrypt($unencrypted_value);

Die env-Funktion ruft den Wert einer Umgebungsvariablen ab oder gibt einen Standardwert zurück:

$env = env('APP_ENV');

// Returns 'production' if APP_ENV is not set...
$env = env('APP_ENV', 'production');

Die event-Funktion sendet das gegebene Events an seine Listener:

event(new UserRegistered($user));

Die factory-Funktion erstellt einen Modell-Fabrik-Builder für eine bestimmte Klasse, einen Namen und eine bestimmte Menge. Sie kann während des Testing oder dem Seeding verwendet werden:

$user = factory(App\User::class)->make();

Die filled-Funktion gibt zurück, ob der angegebene Wert nicht "leer" ist:

filled(0);
filled(true);
filled(false);

// true

filled('');
filled('   ');
filled(null);
filled(collect());

// false

Für die Umkehrung von filled siehe die blank-Methode.

Die info-Funktion schreibt Informationen in das Protokoll:

info('Some helpful information!');

Eine Reihe von kontextabhängigen Daten können ebenfalls an die Funktion übergeben werden:

info('User login attempt failed.', ['id' => $user->id]);

Die logger-Funktion kann verwendet werden, um eine Nachricht auf Debug-Ebene in das Protokoll zu schreiben:

logger('Debug message');

Eine Reihe von kontextabhängigen Daten können ebenfalls an die Funktion übergeben werden:

logger('User has logged in.', ['id' => $user->id]);

Eine logger-Instanz wird zurückgegeben, wenn kein Wert an die Funktion übergeben wird:

logger()->error('You are not allowed here.');

Die Funktion method_field generiert ein verborgenes (hidden) HTML-Eingabefeld, das den gefälschten Wert des HTTP-Verbs des Formulars enthält. Zum Beispiel unter Verwendung der Blade-Syntax:

<form method="POST">
    {{ method_field('DELETE') }}
</form>

Die now-Funktion erstellt eine neue Instanz von Illuminate\Support\Carbon für die aktuelle Zeit:

$now = now();

Die old-Funktion ruft einen alten Eingabewert ab, der in der Sitzung geflasht wurde:

$value = old('value');

$value = old('value', 'default');

Die optional-Funktion akzeptiert jedes Argument und erlaubt Ihnen den Zugriff auf Eigenschaften oder den Aufruf von Methoden auf dieses Objekt. Wenn das angegebene Objekt null ist, geben Eigenschaften und Methoden null zurück, anstatt einen Fehler zu verursachen:

return optional($user->address)->street;

{!! old('name', optional($user)->name) !!}

Die optional-Funktion akzeptiert auch eine Schließung als zweites Argument. Das Closure wird aufgerufen, wenn der als erstes Argument angegebene Wert nicht null ist:

return optional(User::find($id), function ($user) {
    return new DummyUser;
});

Die policy-Methode ruft eine Policy-Instanz für eine bestimmte Klasse ab:

$policy = policy(App\User::class);

Die redirect-Funktion gibt eine HTTP-Antwort zurück, oder gibt die Umleitungsinstanz zurück, wenn sie ohne Argumente aufgerufen wird:

return redirect($to = null, $status = 302, $headers = [], $secure = null);

return redirect('/home');

return redirect()->route('route.name');

Die report-Funktion meldet eine Ausnahme mit der report-Methode Ihres Exception Handler's:

report($e);

Die request-Funktion gibt die aktuelle request-Instanz zurück oder ruft ein Eingabeelement ab:

$request = request();

$value = request('key', $default);

Die rescue-Funktion führt die gegebene Closure aus und fängt alle Ausnahmen ab, die während ihrer Ausführung auftreten. Alle abgefangenen Ausnahmen werden an die report-Methode Ihres Exception Handler's gesendet; die Anfrage wird jedoch weiter verarbeitet:

return rescue(function () {
    return $this->method();
});

Sie können auch ein zweites Argument an die rescue-Funktion übergeben. Dieses Argument ist der "Standard"-Wert, der zurückgegeben werden soll, wenn während der Ausführung des Closures eine Ausnahme auftritt:

return rescue(function () {
    return $this->method();
}, false);

return rescue(function () {
    return $this->method();
}, function () {
    return $this->failure();
});

Die Funktion resolve löst einen gegebenen Klassen- oder Interfacenamen mit Hilfe des Service-Containers in seine Instanz auf:

$api = resolve('HelpSpot\API');

Die response-Funktion erzeugt eine response-Instanz oder erhält eine Instanz der response-Factory:

return response('Hello World', 200, $headers);

return response()->json(['foo' => 'bar'], 200, $headers);

Die retry-Funktion versucht, den gegebenen Rückruf auszuführen, bis die vorgegebene maximale Versuchsschwelle erreicht ist. Wenn der Rückruf keine Ausnahme auslöst, wird sein Rückgabewert zurückgegeben. Wenn der Rückruf eine Ausnahme auslöst, wird er automatisch erneut versucht. Wenn die maximale Versuchszahl überschritten wird, wird die Ausnahme geworfen:

return retry(5, function () {
    // Attempt 5 times while resting 100ms in between attempts...
}, 100);

Die session-Funktion kann verwendet werden, um Session-Werte zu erhalten oder einzustellen:

$value = session('key');

Sie können Werte setzen, indem Sie ein Array von Schlüssel/Wert-Paaren an die Funktion übergeben:

session(['chairs' => 7, 'instruments' => 3]);

Der Session-Speicher wird zurückgegeben, wenn kein Wert an die Funktion übergeben wird:

$value = session()->get('key');

session()->put('key', $value);

Die tap-Funktion akzeptiert zwei Argumente: einen beliebigen $value und ein Closure. Der $value wird an die Funktion Closure übergeben und dann von der tap-Funktion zurückgegeben. Der Rückgabewert der Closure-Funktion ist irrelevant:

$user = tap(User::first(), function ($user) {
    $user->name = 'taylor';

    $user->save();
});

Wenn der tap-Funktion kein Closure übergeben wird, können Sie jede beliebige Methode für den gegebenen $value aufrufen. Der Rückgabewert der von Ihnen aufgerufenen Methode ist immer $value, unabhängig davon, was die Methode in ihrer Definition tatsächlich zurückgibt. Zum Beispiel gibt die Eloquent update-Methode normalerweise eine ganze Zahl zurück. Wir können die Methode jedoch zwingen, das Modell selbst zurückzugeben, indem wir den Aufruf der update-Methode über die tap-Funktion verketten:

$user = tap($user)->update([
    'name' => $name,
    'email' => $email,
]);

Um eine tap-Methode zu einer Klasse hinzuzufügen, können Sie die Eigenschaft Illuminate\Support\Traits\Tappable der Klasse hinzufügen. Die tap-Methode dieser Eigenschaft akzeptiert eine Schließung als einziges Argument. Die Objektinstanz selbst wird an die Closure übergeben und dann von der tap-Methode zurückgegeben:

return $user->tap(function ($user) {
    //
});

Die Funktion throw_if wirft die gegebene Ausnahme, wenn ein gegebener boolescher Ausdruck als true ausgewertet wird:

throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);

throw_if(
    ! Auth::user()->isAdmin(),
    AuthorizationException::class,
    'You are not allowed to access this page'
);

Die Funktion throw_unless wirft die gegebene Ausnahme, wenn ein gegebener boolescher Ausdruck als false gewertet wird:

throw_unless(! Auth::user()->isAdmin(), AuthorizationException::class);

throw_unless(
    Auth::user()->isAdmin(),
    AuthorizationException::class,
    'You are not allowed to access this page'
);

Die today-Funktion erstellt eine neue Instanz von Illuminate\Support\Carbon für das aktuelle Datum:

$today = today();

Die Funktion trait_uses_recursive gibt alle Merkmale zurück, die von einem Merkmal verwendet werden:

$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);

Die transform-Funktion führt eine Closure für einen gegebenen Wert aus, wenn der Wert nicht leer (blank) ist, und gibt das Ergebnis der Closure zurück:

$callback = function ($value) {
    return $value * 2;
};

$result = transform(5, $callback);

// 10

Als dritter Parameter kann der Methode auch ein Standardwert oder Closure übergeben werden. Dieser Wert wird zurückgegeben, wenn der angegebene Wert leer (blank) ist:

$result = transform(null, $callback, 'The value is blank');

// The value is blank

Die validator-Funktion erzeugt eine neue Validator-Instanz mit den angegebenen Argumenten. Sie können sie der Einfachheit halber anstelle der validator-Fassade verwenden:

$validator = validator($data, $rules, $messages);

Die value-Funktion gibt den ihr gegebenen Wert zurück. Wenn Sie der Funktion jedoch eine Closure übergeben, wird die Closure ausgeführt und das Ergebnis zurückgegeben:

$result = value(true);

// true

$result = value(function () {
    return false;
});

// false

Die view-Funktion ruft eine view-Instanz ab:

return view('auth.login');

Die with-Funktion gibt den Wert zurück, der ihr gegeben wird. Wenn ein Closure als zweites Argument an die Funktion übergeben wird, wird der Closure ausgeführt und sein Ergebnis zurückgegeben:

$callback = function ($value) {
    return (is_numeric($value)) ? $value * 2 : 0;
};

$result = with(5, $callback);

// 10

$result = with(null, $callback);

// 0

$result = with(5, null);

// 5