⚙️ 后端框架

Laravel

Laravel Cheat Sheet - 快速参考指南，收录常用语法、命令与实践。

📂 分类 · 后端框架🧭 Markdown 速查🏷️ 2 个标签

#laravel#php

向下滚动查看内容

返回全部 Cheat Sheets

Getting Started

Requirements

PHP version >= 7.3
BCMath PHP Extension
Ctype PHP Extension
Fileinfo PHP Extension
JSON PHP Extension
Mbstring PHP Extension
OpenSSL PHP Extension
PDO PHP Extension
Tokenizer PHP Extension
XML PHP Extension

Ensure your web server directs all requests to your application's public/index.php file, See: Deployment

Windows

Install Docker Desktop
Install & enable WSL2
Ensure that Docker Desktop is configured to use WSL2

In WSL2 terminal:

CODE

滚动查看更多

```shell
$ curl -s https://laravel.build/example-app | bash
$ cd example-app
$ ./vendor/bin/sail up
```

{.marker-timeline}

Access application via http://localhost

Mac

Install Docker Desktop

In terminal:

CODE

滚动查看更多

```shell
$ curl -s https://laravel.build/example-app | bash
$ cd example-app
$ ./vendor/bin/sail up
```

{.marker-timeline}

Access application via http://localhost

Linux

SHELL

滚动查看更多

$ curl -s https://laravel.build/example-app | bash
$ cd example-app
$ ./vendor/bin/sail up

Installation via Composer

BASH

滚动查看更多

$ composer create-project laravel/laravel example-app
$ cd example-app
$ php artisan serve

Access application via http://localhost

Configuration

.env

Retrieve values from .env file

PHP

滚动查看更多

env('APP_DEBUG');

// with default value
env('APP_DEBUG', false);

Determine current environment

PHP

滚动查看更多

use Illuminate\Support\Facades\App;

$environment = App::environment();

Accessing configuration values using "dot" syntax

PHP

滚动查看更多

// config/app.php --> ['timezone' => '']
$value = config('app.timezone');

// Retrieve a default value if the configuration value does not exist...
$value = config('app.timezone', 'Asia/Seoul');

Set configuration values at runtime:

PHP

滚动查看更多

config(['app.timezone' => 'America/Chicago']);

Debug Mode

Turn on (local dev):

PHP

滚动查看更多

// .env file
APP_ENV=local
APP_DEBUG=true
// ...

Turn off (production):

PHP

滚动查看更多

// .env file
APP_ENV=production
APP_DEBUG=false
// ...

Maintenance Mode

Temporarily disable application (503 status code)

BASH

滚动查看更多

php artisan down

Disable maintenance mode

BASH

滚动查看更多

php artisan up

Bypass Maintenance Mode

BASH

滚动查看更多

php artisan down --secret="1630542a-246b-4b66-afa1-dd72a4c43515"

Visit your application URL https://example.com/1630542a-246b-4b66-afa1-dd72a4c43515 to set a cookie and bypass the maintenance screen

Routing

Router HTTP Methods

PHP

滚动查看更多

Route::get($uri, $callback);
Route::post($uri, $callback);
Route::put($uri, $callback);
Route::patch($uri, $callback);
Route::delete($uri, $callback);
Route::options($uri, $callback);

Multiple HTTP methods

PHP

滚动查看更多

Route::match(['get', 'post'], '/', function () {
    //
});

Route::any('/', function () {
    //
});

Basic Definition

PHP

滚动查看更多

use Illuminate\Support\Facades\Route;

// closure
Route::get('/greeting', function () {
    return 'Hello World';
});

// controller action
Route::get(
    '/user/profile',
    [UserProfileController::class, 'show']
);

Dependency Injection

PHP

滚动查看更多

use Illuminate\Http\Request;

Route::get('/users', function (Request $request) {
    // ...
});

Type hint concrete dependencies for auto-injection

View Routes

PHP

滚动查看更多

// Argument 1: URI, Argument 2: view name
Route::view('/welcome', 'welcome');

// with data
Route::view('/welcome', 'welcome', ['name' => 'Taylor']);

Route only needs to return a view.

Route Model Binding

Implicit binding

With closure

PHP

滚动查看更多

use App\Models\User;

Route::get('/users/{user}', function (User $user) {
    return $user->email;
});

// /user/1 --> User::where('id', '=', 1);

With controller action

PHP

滚动查看更多

use App\Http\Controllers\UserController;
use App\Models\User;

// Route definition...
Route::get('/users/{user}', [UserController::class, 'show']);

// Controller method definition...
public function show(User $user)
{
    return view('user.profile', ['user' => $user]);
}

With custom resolution column

PHP

滚动查看更多

use App\Models\Post;

Route::get('/posts/{post:slug}', function (Post $post) {
    return $post;
});

// /posts/my-post --> Post::where('slug', '=', 'my-post');

Always use a different column to resolve

PHP

滚动查看更多

// in App\Models\Post
public function getRouteKeyName()
{
    return 'slug';
}

Multiple models - second is child of first

PHP

滚动查看更多

use App\Models\Post;
use App\Models\User;

Route::get('/users/{user}/posts/{post:slug}', function (User $user, Post $post) {
    return $post;
});

Convenient way to automatically inject the model instances directly into your routes

Route Parameters

Capture segments of the URI within your route

Required parameters

PHP

滚动查看更多

Route::get('/user/{id}', function ($id) {
    return 'User '.$id;
});

With dependency injection

PHP

滚动查看更多

use Illuminate\Http\Request;

Route::get('/user/{id}', function (Request $request, $id) {
    return 'User '.$id;
});

Optional Parameters

PHP

滚动查看更多

Route::get('/user/{name?}', function ($name = null) {
    return $name;
});

Route::get('/user/{name?}', function ($name = 'John') {
    return $name;
});

Redirect Routes

HTTP 302 status

PHP

滚动查看更多

Route::redirect('/here', '/there');

Set the status code

PHP

滚动查看更多

Route::redirect('/here', '/there', 301);

Permanent 301 redirect

PHP

滚动查看更多

Route::permanentRedirect('/here', '/there');

Regular Expression Constraints

PHP

滚动查看更多

Route::get('/user/{name}', function ($name) {
    //
})->where('name', '[A-Za-z]+');

Route::get('/user/{id}', function ($id) {
    //
})->where('id', '[0-9]+');

Route::get('/user/{id}/{name}', function ($id, $name) {
    //
})->where(['id' => '[0-9]+', 'name' => '[a-z]+']);

Middleware

PHP

滚动查看更多

Route::middleware(['first', 'second'])->group(function () {
    Route::get('/', function () {
        // Uses first & second middleware...
    });

    Route::get('/user/profile', function () {
        // Uses first & second middleware...
    });
});

URI Prefixes

PHP

滚动查看更多

Route::prefix('admin')->group(function () {
    Route::get('/users', function () {
        // Matches The "/admin/users" URL
    });
});

Name Prefix

PHP

滚动查看更多

Route::name('admin.')->group(function () {
    Route::get('/users', function () {
        // Route assigned name "admin.users"...
    })->name('users');
});

Share attributes across routes

Accessing current route

PHP

滚动查看更多

use Illuminate\Support\Facades\Route;

// Illuminate\Routing\Route
$route = Route::current();

// string
$name = Route::currentRouteName();

// string
$action = Route::currentRouteAction();

Helpers

routes

Named route

PHP

滚动查看更多

$url = route('profile');

With parameters

PHP

滚动查看更多

// Route::get('/user/{id}/profile', /*...*/ )->name('profile);

$url = route('profile', ['id' => 1]);

// /user/1/profile/

With query string

PHP

滚动查看更多

// Route::get('/user/{id}/profile', /*...*/ )->name('profile);

$url = route('profile', ['id' => 1, 'photos'=>'yes']);

// /user/1/profile?photos=yes

Redirects

PHP

滚动查看更多

// Generating Redirects...
return redirect()->route('profile');

Eloquent Models

PHP

滚动查看更多

echo route('post.show', ['post' => $post]);

The route helper will automatically extract the model's route key. See Routing

URL Generation

Generate arbitrary URLs for your application that will automatically use the scheme (HTTP or HTTPS) and host from the current request

PHP

滚动查看更多

$post = App\Models\Post::find(1);

echo url("/posts/{$post->id}");

// http://example.com/posts/1

Current URL

PHP

滚动查看更多

// Get the current URL without the query string...
echo url()->current();

// Get the current URL including the query string...
echo url()->full();

// Get the full URL for the previous request...
echo url()->previous();

Named Route URL

PHP

滚动查看更多

$url = route('profile');

See Named Route

Error Handling

PHP

滚动查看更多

public function isValid($value)
{
    try {
        // Validate the value...
    } catch (Throwable $e) {
        report($e);

        return false;
    }
}

Report an exception but continue handling the current request

HTTP Exceptions

PHP

滚动查看更多

// page not found
abort(404);

// Unauthorized
abort(401);

// Forbidden
abort(403);

// Server Error
abort(500);

Generate an HTTP exception response using status code

Controllers

Basic

PHP

滚动查看更多

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\User;

class UserController extends Controller
{
    public function show($id)
    {
        return view('user.profile', [
            'user' => User::findOrFail($id)
        ]);
    }
}

Define a route for this controller method:

PHP

滚动查看更多

use App\Http\Controllers\UserController;

Route::get('/user/{id}', [UserController::class, 'show']);

Requests

CSRF Protection

Laravel automatically generates a CSRF "token" for each active user session.
This token is used to verify that the authenticated user is the person actually making the requests.

Get current session's token:

PHP

滚动查看更多

Route::get('/token', function (Request $request) {
    $token = $request->session()->token();

    $token = csrf_token();

    // ...
});

POST, PUT, PATCH, or DELETE forms should include a hidden CSRF _token field in the form to validate the request.

HTML

滚动查看更多

<form method="POST" action="/profile">
	@csrf

	<!-- Equivalent to... -->
	<input type="hidden" name="_token" value="{{ csrf_token() }}" />
</form>

See Forms

Accessing Request

Get an instance of the current request by type-hinting the controller action or route closure

PHP

滚动查看更多

// controller action
class UserController extends Controller
{
    public function store(Request $request)
    {
        $name = $request->input('name');
    }
}

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

See Routing

Path

The request's path information

PHP

滚动查看更多

$uri = $request->path();

// https://example.com/foo/bar --> foo/bar

Match path to pattern

Verify that the incoming request path matches a given pattern

PHP

滚动查看更多

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

Determine if the incoming request matches a named route

PHP

滚动查看更多

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

URL

Full URL for the incoming request

PHP

滚动查看更多

// URL without the query string
$url = $request->url();

// URL including query string
$urlWithQueryString = $request->fullUrl();

// append data to query string
$request->fullUrlWithQuery(['type' => 'phone']);

Request Method

PHP

滚动查看更多

$method = $request->method();

// verify that the HTTP verb matches a given string
if ($request->isMethod('post')) {
    //
}

Client IP

PHP

滚动查看更多

$ipAddress = $request->ip();

Headers

PHP

滚动查看更多

$value = $request->header('X-Header-Name');

$value = $request->header('X-Header-Name', 'default value');

// determine if the request contains a given header
if ($request->hasHeader('X-Header-Name')) {
    //
}

// retrieve a bearer token from the Authorization header
$token = $request->bearerToken();

Content Type

Return an array containing all the content types accepted by the request

PHP

滚动查看更多

$contentTypes = $request->getAcceptableContentTypes();

Boolean check for content types are accepted by the request

PHP

滚动查看更多

if ($request->accepts(['text/html', 'application/json'])) {
    // ...
}

Input

Retrieve all the incoming request's input data as an array

PHP

滚动查看更多

$input = $request->all();

Retrieve all the incoming request's input data as a collection

PHP

滚动查看更多

$input = $request->collect();

// retrieve subset as collection
$request->collect('users')->each(function ($user) {
    // ...
});

See Helpers

Retrieve user input (also gets values from query string)

PHP

滚动查看更多

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

// with default value if none present
$name = $request->input('name', 'Sally');

Access array inputs

PHP

滚动查看更多

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

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

Retrieve all the input values as an associative array:

PHP

滚动查看更多

$input = $request->input();

Only retrieve values from the query string:

PHP

滚动查看更多

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

// with default value
$name = $request->query('name', 'Helen');

Retrieve all the query string values as an associative array:

PHP

滚动查看更多

$query = $request->query();

Boolean Input Values

Helpful for checkbox inputs or other booleans. Return true for 1, "1", true, "true", "on", and "yes".
All other values will return false

PHP

滚动查看更多

$archived = $request->boolean('archived');

Dynamic Properties

Access inputs via properties.
If not found as an input, the route parameters will be checked.

PHP

滚动查看更多

$name = $request->name;

Retrieve Partial Input

PHP

滚动查看更多

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

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

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

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

Check Existence

Determine if value(s) present

PHP

滚动查看更多

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

// check if ALL values are present
if ($request->has(['name', 'email'])) {
    //
}

// if any values are present
if ($request->hasAny(['name', 'email'])) {
    //
}

// if a file is present on request
if ($request->hasFile('image')) {
    //
}

Old Input

Retrieve input from the previous request

PHP

滚动查看更多

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

Or use the old() helper

PHP

滚动查看更多

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

See: Helpers
See: Forms

Uploaded Files

Retrieve uploaded file from request

PHP

滚动查看更多

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

$file = $request->photo;

Get file path or extension

PHP

滚动查看更多

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

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

Store uploaded file with a randomly generated filename

PHP

滚动查看更多

// path where the file should be stored relative to
// the filesystem's configured root directory
$path = $request->photo->store('images');

// optional 2nd param to specify the filesystem disk
$path = $request->photo->store('images', 's3');

Store uploaded file and specify the name

PHP

滚动查看更多

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

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

See More: Laravel File Storage

Views

Intro

Laravel Docs - Views

HTML

滚动查看更多

<!-- View stored in resources/views/greeting.blade.php -->

<html>
	<body>
		<h1>
			Hello,
			<?php echo $name; ?>
		</h1>
	</body>
</html>

Create a view by placing a file with the .blade.php extension in the resources/views directory.

Pass Data to Views

As an array

PHP

滚动查看更多

return view('greetings', ['name' => 'Victoria']);

Using with()

PHP

滚动查看更多

return view('greeting')
            ->with('name', 'Victoria')
            ->with('occupation', 'Astronaut');

Access each value using the data's keys

HTML

滚动查看更多

<html>
	<body>
		<h1>Hello, {{ $name }}</h1>
		<!-- Or -->
		<h1>
			Hello,
			<?php echo $name; ?>
		</h1>
	</body>
</html>

view helper

Return a view from a route with the view() helper

PHP

滚动查看更多

Route::get('/', function () {
    return view('greeting', ['name' => 'James']);
});

See: View Routes and Helpers

Subdirectories

PHP

滚动查看更多

// resources/views/admin.profile.blade.php
return view('admin.profile');

Blade Templates

Intro

Laravel Docs - Blade Templates

Blade is the templating engine included in Laravel that also allows you to use plain PHP.

Views

Blade views are returned using the view() helper

PHP

滚动查看更多

Route::get('/', function () {
    return view('welcome', ['name' => 'Samantha']);
});

See: Views

Comments

HTML

滚动查看更多

{{-- This comment will not be present in the rendered HTML --}}

Directives

if Statements

PHP

滚动查看更多

@if (count($records) === 1)
    I have one record!
@elseif (count($records) > 1)
    I have multiple records!
@else
    I don't have any records!
@endif

isset & empty

PHP

滚动查看更多

@isset($records)
    // $records is defined and is not null...
@endisset

@empty($records)
    // $records is "empty"...
@endempty

Authentication

PHP

滚动查看更多

@auth
    // The user is authenticated...
@endauth

@guest
    // The user is not authenticated...
@endguest

Loops

HTML

滚动查看更多

@for ($i = 0; $i < 10; $i++)
    The current value is {{ $i }}
@endfor

@foreach ($users as $user)
    <p>This is user {{ $user->id }}</p>
@endforeach

@forelse ($users as $user)
    <li>{{ $user->name }}</li>
@empty
    <p>No users</p>
@endforelse

@while (true)
    <p>I'm looping forever.</p>
@endwhile

Loop Iteration:

PHP

滚动查看更多

@foreach ($users as $user)
    @if ($loop->first)
        This is the first iteration.
    @endif

    @if ($loop->last)
        This is the last iteration.
    @endif

    <p>This is user {{ $user->id }}</p>
@endforeach

See more: Laravel Loop Variable

Displaying Data

Blade's echo statements {{ }} are automatically sent through PHP's htmlspecialchars function to prevent XSS attacks.

Display the contents of the name variable:

HTML

滚动查看更多

Hello, {{ $name }}.

Display results of a PHP function:

HTML

滚动查看更多

The current UNIX timestamp is {{ time() }}.

Display data without escaping with htmlspecialchars

HTML

滚动查看更多

Hello, {!! $name !!}.

Including Subviews

Include a Blade view from within another view.
All variables that are available to the parent view are also available to the included view

HTML

滚动查看更多

<div>
	<!-- resources/views/shared/errors/blade.php -->
	@include('shared.errors')

	<form>
		<!-- Form Contents -->
	</form>
</div>

Raw PHP

Execute a block of plain PHP

PHP

滚动查看更多

@php
    $counter = 1;
@endphp

Stacks

Blade allows you to push to named stacks which can be rendered in another view or layout.
Useful for javascript libraries required by child views

HTML

滚动查看更多

<!-- Add to the stack -->
@push('scripts')
<script src="/example.js"></script>
@endpush

Render the stack

HTML

滚动查看更多

<head>
	<!-- Head Contents -->

	@stack('scripts')
</head>

Prepend to the beginning of a stack

PHP

滚动查看更多

@push('scripts')
    This will be second...
@endpush

// Later...

@prepend('scripts')
    This will be first...
@endprepend

Forms

Intro

Laravel Docs - Forms

CSRF Field

Include a hidden CSRF token field to validate the request

HTML

滚动查看更多

<form method="POST" action="/profile">
  @csrf

  ...
</form>

See: CSRF Protection

Method Field

Since HTML forms can't make PUT, PATCH, or DELETE requests, you will need to add a hidden _method field to spoof these HTTP verbs:

HTML

滚动查看更多

<form action="/post/my-post" method="POST">
  @method('PUT')

  ...
</form>

Validation Errors

HTML

滚动查看更多

<!-- /resources/views/post/create.blade.php -->

<label for="title">Post Title</label>

<input id="title" type="text" class="@error('title') is-invalid @enderror" />

@error('title')
  <div class="alert alert-danger">{{ $message }}</div>
@enderror

See: Validation

Repopulating Forms

When redirecting due to a validation error, request input is flashed to the session.
Retrieve the input from the previous request with the old method

PHP

滚动查看更多

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

Or the old() helper

HTML

滚动查看更多

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

Validation

Intro

Laravel Docs - Validation

If validation fails, a redirect response to the previous URL will be generated.
If the incoming request is an XHR request, a JSON response with the validation error messages will be returned.

Logic

PHP

滚动查看更多

// in routes/web.php
Route::get('/post/create', [App\Http\Controllers\PostController::class, 'create']);
Route::post('/post', [App\Http\Controllers\PostController::class, 'store']);

// in app/Http/Controllers/PostController...
public function store(Request $request)
{
    $validated = $request->validate([
        // input name => validation rules
        'title' => 'required|unique:posts|max:255',
        'body' => 'required',
    ]);

    // The blog post is valid...
}

Rules

Can also be passed as an array

PHP

滚动查看更多

$validatedData = $request->validate([
    'title' => ['required', 'unique:posts', 'max:255'],
    'body' => ['required'],
]);

after:date

Field must be a value after a given date.

PHP

滚动查看更多

'start_date' => 'required|date|after:tomorrow'

Instead of a date string, you may specify another field to compare against the date

PHP

滚动查看更多

'finish_date' => 'required|date|after:start_date'

See before:date

after_or_equal:date

Field must be a value after or equal to the given date.
See after:date

before:date

Field must be a value preceding the given date.
The name of another field may be supplied as the value of date.
See after:date

alpha_num

Field must be entirely alpha-numeric characters

boolean

Field must be able to be cast as a boolean.
Accepted input are true, false, 1, 0, "1", and "0"

confirmed

Field must have a matching field of {field}_confirmation.
For example, if the field is password, a matching password_confirmation field must be present

current_password

Field must match the authenticated user's password.

date

Field must be a valid, non-relative date according to the strtotime PHP function.

email

Field must be formatted as an email address.

file

Field must be a successfully uploaded file.
See: Uploaded Files

max:value

Field must be less than or equal to a maximum value.
Strings, numerics, arrays, and files are evaluated like the size rule.

min:value

Field must have a minimum value.
Strings, numerics, arrays, and files are evaluated like the size rule.

mimetypes:text/plain,...

File must match one of the given MIME types:

PHP

滚动查看更多

'video' => 'mimetypes:video/avi,video/mpeg,video/quicktime'

File's contents will be read and the framework will attempt to guess the MIME type, regardless of the client's provided MIME type.

mimes:foo,bar,...

Field must have a MIME type corresponding to one of the listed extensions.

PHP

滚动查看更多

'photo' => 'mimes:jpg,bmp,png'

File's contents will be read and the framework will attempt to guess the MIME type, regardless of the client's provided MIME type.

Full listing of MIME types & extensions

nullable

Field may be null.

numeric

Field must be numeric.

password

Field must match the authenticated user's password.

prohibited

Field must be empty or not present.

prohibited_if:anotherfield,value,...

Field must be empty or not present if the anotherfield field is equal to any value.

prohibited_unless:anotherfield,value,...

Field must be empty or not present unless the anotherfield field is equal to any value.

required

Field must be present in the input data and not empty.
A field is considered "empty" if one of the following conditions are true:

The value is null.
The value is an empty string.
The value is an empty array or empty Countable object.
The value is an uploaded file with no path.

required_with:foo,bar,...

Field must be present and not empty, only if any of the other specified fields are present and not empty

size:value

Field must have a size matching the given value.

For strings: number of characters
For numeric data: integer value (must also have the numeric or integer rule).
For arrays: count of the array
For files: file size in kilobytes

PHP

滚动查看更多

// Validate that a string is exactly 12 characters long...
'title' => 'size:12';
// Validate that a provided integer equals 10...
'seats' => 'integer|size:10';
// Validate that an array has exactly 5 elements...
'tags' => 'array|size:5';
// Validate that an uploaded file is exactly 512 kilobytes...
'image' => 'file|size:512';

unique:table,column

Field must not exist within the given database table

url

Field must be a valid URL

See all available rules

Validate Passwords

Ensure passwords have an adequate level of complexity

PHP

滚动查看更多

$validatedData = $request->validate([
    'password' => ['required', 'confirmed', Password::min(8)],
]);

Password rule object allows you to easily customize the password complexity requirements

PHP

滚动查看更多

// Require at least 8 characters...
Password::min(8)

// Require at least one letter...
Password::min(8)->letters()

// Require at least one uppercase and one lowercase letter...
Password::min(8)->mixedCase()

// Require at least one number...
Password::min(8)->numbers()

// Require at least one symbol...
Password::min(8)->symbols()

Ensure a password has not been compromised in a public password data breach leak

PHP

滚动查看更多

Password::min(8)->uncompromised()

Uses the k-Anonymity model via the haveibeenpwned.com service without sacrificing the user's privacy or security

Methods can be chained

PHP

滚动查看更多

Password::min(8)
    ->letters()
    ->mixedCase()
    ->numbers()
    ->symbols()
    ->uncompromised()

Display Validation Errors

PHP

滚动查看更多

<!-- /resources/views/post/create.blade.php -->

<h1>Create Post</h1>

@if ($errors->any())
    <div class="alert alert-danger">
        <ul>
            @foreach ($errors->all() as $error)
                <li>{{ $error }}</li>
            @endforeach
        </ul>
    </div>
@endif

<!-- Create Post Form -->

See: Validation Errors

Optional Fields

You will often need to mark your "optional" request fields as nullable if you do not want the validator to consider null values as invalid

PHP

滚动查看更多

// publish_at field may be either null or a valid date representation
$request->validate([
    'title' => 'required|unique:posts|max:255',
    'body' => 'required',
    'publish_at' => 'nullable|date',
]);

Validated Input

Retrieve the request data that underwent validation

PHP

滚动查看更多

$validated = $request->validated();

Or with safe(), which returns an instance of Illuminate\Support\ValidatedInput

PHP

滚动查看更多

$validated = $request->safe()->only(['name', 'email']);

$validated = $request->safe()->except(['name', 'email']);

$validated = $request->safe()->all();

Iterate

PHP

滚动查看更多

foreach ($request->safe() as $key => $value) {
    //
}

Access as an array

PHP

滚动查看更多

$validated = $request->safe();

$email = $validated['email'];

Session

Intro

Laravel Docs - Session

Laravel ships with a variety of session backends that are accessed through a unified API. Memcached, Redis, and database support is included.

Configuration

Session configuration is in config/session.php.
By default, Laravel is configured to use the file session driver

Check Isset / Exists

Returns true if the item is present and is not null:

PHP

滚动查看更多

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

Returns true if present, even if it's null:

PHP

滚动查看更多

if ($request->session()->exists('users')) {
    //
}

Returns true if the item is null or is not present:

PHP

滚动查看更多

if ($request->session()->missing('users')) {
    //
}

Retrieving Data

Via Request

PHP

滚动查看更多

// ...
class UserController extends Controller
{
    public function show(Request $request, $id)
    {
        $value = $request->session()->get('key');

        //
    }
}

Pass a default value as the second argument to use if the key does not exist

PHP

滚动查看更多

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

// closure can be passed and executed as a default
$value = $request->session()->get('key', function () {
    return 'default';
});

Via session helper

PHP

滚动查看更多

Route::get('/home', function () {
    // Retrieve a piece of data from the session...
    $value = session('key');

    // Specifying a default value...
    $value = session('key', 'default');

    // Store a piece of data in the session...
    session(['key' => 'value']);
});

See: Session Helper

All Session Data

PHP

滚动查看更多

$data = $request->session()->all();

Retrieve and Delete

Retrieve and delete an item from the session

PHP

滚动查看更多

$value = $request->session()->pull('key', 'default');

Store Data

Via a request instance

PHP

滚动查看更多

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

Via the global "session" helper

PHP

滚动查看更多

session(['key' => 'value']);

Push a new value onto a session value that is an array

PHP

滚动查看更多

// array of team names
$request->session()->push('user.teams', 'developers');

Logging

Configuration

Configuration options for logging behavior is in config/logging.php.
By default, Laravel will use the stack channel when logging messages, which aggregates multiple log channels into a single channel.

Levels

All the log levels defined in the RFC 5424 specification are available:

emergency
alert
critical
error
warning
notice
info
debug

Log Facade

PHP

滚动查看更多

use Illuminate\Support\Facades\Log;

Log::emergency($message);
Log::alert($message);
Log::critical($message);
Log::error($message);
Log::warning($message);
Log::notice($message);
Log::info($message);
Log::debug($message);

Contextual Info

PHP

滚动查看更多

use Illuminate\Support\Facades\Log;

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

Deployment

Intro

Laravel Docs - Deployment

Ensure your web server directs all requests to your application's public/index.php file

Optimization

Composer's autoloader map

BASH

滚动查看更多

composer install --optimize-autoloader --no-dev

Configuration Loading

Be sure that you are only calling the env function from within your configuration files.
Once the configuration has been cached, the .env file will not be loaded and all calls to the env function for .env variables will return null

BASH

滚动查看更多

php artisan config:cache

Route Loading

BASH

滚动查看更多

php artisan route:cache

View Loading

BASH

滚动查看更多

php artisan view:cache

Debug Mode

The debug option in your config/app.php determines how much information about an error is actually displayed to the user.
By default, this option is set to the value of the APP_DEBUG environment variable in your .env file. In your production environment, this value should always be false.
If the APP_DEBUG variable is set to true in production, you risk exposing sensitive configuration values to end users.

Laravel

Getting Started

Install Docker Desktop

Install & enable WSL2

Ensure that Docker Desktop is configured to use WSL2

In WSL2 terminal:

Install Docker Desktop

In terminal:

Configuration

Disable maintenance mode

Bypass Maintenance Mode

Routing

Implicit binding

Required parameters

Optional Parameters

Middleware

URI Prefixes

Name Prefix

Helpers

Named route

Redirects

Eloquent Models

Current URL

Controllers

Requests

Match path to pattern

Boolean Input Values

Views

As an array

Using with()

Blade Templates

if Statements

isset & empty

Authentication

Loops

Forms

Validation

after:date

after_or_equal:date

before:date

alpha_num

boolean

confirmed

current_password

date

email

file

max:value

min:value

mimetypes:text/plain,...

mimes:foo,bar,...

nullable

numeric

password

prohibited

prohibited_if:anotherfield,value,...

prohibited_unless:anotherfield,value,...

required

required_with:foo,bar,...

size:value

unique:table,column

url

Iterate

Access as an array

Session

Configuration

Via Request

Via session helper

All Session Data

Retrieve and Delete

Logging

Deployment

Composer's autoloader map

Configuration Loading

Route Loading

View Loading

Also see

相关 Cheat Sheets

Django

Flask