diff --git a/source/_posts/laravel.md b/source/_posts/laravel.md index fdd365c..8726b9a 100644 --- a/source/_posts/laravel.md +++ b/source/_posts/laravel.md @@ -4,23 +4,22 @@ date: 2021-11-09 18:26:55 background: bg-[#e44230] label: PHP tags: - - web - - framework - - php + - web + - framework + - php categories: - - Programming + - Programming intro: | - [Laravel](https://laravel.com/docs/8.x/) is an expressive and progressive web application framework for PHP. - This cheat sheet provides a reference for common commands and features for Laravel 8. + [Laravel](https://laravel.com/docs/8.x/) is an expressive and progressive web application framework for PHP. + This cheat sheet provides a reference for common commands and features for Laravel 8. plugins: - - copyCode + - copyCode --- - -Getting Started ---------------- +## Getting Started ### Requirements {.row-span-2} + - PHP version >= 7.3 - BCMath PHP Extension - Ctype PHP Extension @@ -32,74 +31,78 @@ Getting Started - Tokenizer PHP Extension - XML PHP Extension -Ensure your web server directs all requests to your application's -`public/index.php` file, See: [Deployment](#deployment) - +Ensure your web server directs all requests to your application's `public/index.php` file, See: +[Deployment](#deployment) ### Windows + - #### Install [Docker Desktop](https://www.docker.com/products/docker-desktop) - #### Install & enable [WSL2](https://docs.microsoft.com/en-us/windows/wsl/install) - #### Ensure that Docker Desktop is [configured to use WSL2](https://docs.docker.com/desktop/windows/wsl/) - #### In WSL2 terminal: - ```shell - $ curl -s https://laravel.build/example-app | bash - $ cd example-app - $ ./vendor/bin/sail up - ``` -{.marker-timeline} + ```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](https://www.docker.com/products/docker-desktop) - #### In terminal: - ```shell - $ curl -s https://laravel.build/example-app | bash - $ cd example-app - $ ./vendor/bin/sail up - ``` -{.marker-timeline} + ```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](https://getcomposer.org) + ```bash $ composer create-project laravel/laravel example-app $ cd example-app $ php artisan serve ``` + Access application via `http://localhost` - - - -Configuration ---------------- +## Configuration ### .env {.cols-2} + 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'); @@ -107,20 +110,26 @@ $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 @@ -129,26 +138,32 @@ 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 ---------------- +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 {.row-span-2} + ```php Route::get($uri, $callback); Route::post($uri, $callback); @@ -157,7 +172,9 @@ Route::patch($uri, $callback); Route::delete($uri, $callback); Route::options($uri, $callback); ``` + Multiple HTTP methods + ```php Route::match(['get', 'post'], '/', function () { // @@ -169,6 +186,7 @@ Route::any('/', function () { ``` ### Basic Definition {.row-span-2} + ```php use Illuminate\Support\Facades\Route; @@ -185,6 +203,7 @@ Route::get( ``` ### Dependency Injection + ```php use Illuminate\Http\Request; @@ -192,10 +211,11 @@ 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'); @@ -203,13 +223,15 @@ Route::view('/welcome', 'welcome'); // with data Route::view('/welcome', 'welcome', ['name' => 'Taylor']); ``` -Route only needs to return a view. - +Route only needs to return a view. ### Route Model Binding {.row-span-4} + #### Implicit binding + With closure + ```php use App\Models\User; @@ -219,7 +241,9 @@ Route::get('/users/{user}', function (User $user) { // /user/1 --> User::where('id', '=', 1); ``` + With controller action + ```php use App\Http\Controllers\UserController; use App\Models\User; @@ -233,7 +257,9 @@ public function show(User $user) return view('user.profile', ['user' => $user]); } ``` + With custom resolution column + ```php use App\Models\Post; @@ -243,7 +269,9 @@ Route::get('/posts/{post:slug}', function (Post $post) { // /posts/my-post --> Post::where('slug', '=', 'my-post'); ``` + Always use a different column to resolve + ```php // in App\Models\Post public function getRouteKeyName() @@ -251,7 +279,9 @@ public function getRouteKeyName() return 'slug'; } ``` + Multiple models - second is child of first + ```php use App\Models\Post; use App\Models\User; @@ -260,20 +290,23 @@ 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 {.row-span-2} + 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; @@ -281,7 +314,9 @@ Route::get('/user/{id}', function (Request $request, $id) { return 'User '.$id; }); ``` + #### Optional Parameters + ```php Route::get('/user/{name?}', function ($name = null) { return $name; @@ -292,24 +327,28 @@ Route::get('/user/{name?}', function ($name = 'John') { }); ``` - - ### 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 {.cols-2} + ```php Route::get('/user/{name}', function ($name) { // @@ -323,28 +362,35 @@ Route::get('/user/{id}/{name}', function ($id, $name) { // })->where(['id' => '[0-9]+', 'name' => '[a-z]+']); ``` + See also: [Regex Cheatsheet](/regex) ### Named Routes + Route names should always be unique + ```php Route::get('/user/profile', function () { // })->name('profile'); ``` + See: [Helpers](#helpers-cols-3) - ### Fallback Routes + ```php Route::fallback(function () { // }); ``` + Executed when no other routes match ### Route Groups + #### Middleware + ```php Route::middleware(['first', 'second'])->group(function () { Route::get('/', function () { @@ -356,7 +402,9 @@ Route::middleware(['first', 'second'])->group(function () { }); }); ``` + #### URI Prefixes + ```php Route::prefix('admin')->group(function () { Route::get('/users', function () { @@ -364,7 +412,9 @@ Route::prefix('admin')->group(function () { }); }); ``` + #### Name Prefix + ```php Route::name('admin.')->group(function () { Route::get('/users', function () { @@ -372,10 +422,11 @@ Route::name('admin.')->group(function () { })->name('users'); }); ``` + Share attributes across routes - ### Accessing current route + ```php use Illuminate\Support\Facades\Route; @@ -389,16 +440,18 @@ $name = Route::currentRouteName(); $action = Route::currentRouteAction(); ``` - -Helpers ---------------- +## Helpers ### routes {.row-span-2} + #### Named route + ```php $url = route('profile'); ``` + With parameters + ```php // Route::get('/user/{id}/profile', /*...*/ )->name('profile); @@ -406,7 +459,9 @@ $url = route('profile', ['id' => 1]); // /user/1/profile/ ``` + With query string + ```php // Route::get('/user/{id}/profile', /*...*/ )->name('profile); @@ -416,22 +471,25 @@ $url = route('profile', ['id' => 1, '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](#routing-cols-4) + +The route helper will automatically extract the model's route key. See [Routing](#routing-cols-4) ### URL Generation -Generate arbitrary URLs for your application that will -automatically use the scheme (HTTP or HTTPS) and host -from the current request + +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); @@ -439,7 +497,9 @@ echo url("/posts/{$post->id}"); // http://example.com/posts/1 ``` + #### Current URL + ```php // Get the current URL without the query string... echo url()->current(); @@ -450,13 +510,17 @@ echo url()->full(); // Get the full URL for the previous request... echo url()->previous(); ``` + ### Named Route URL + ```php $url = route('profile'); ``` + See [Named Route](#named-route) ### Error Handling + ```php public function isValid($value) { @@ -469,9 +533,11 @@ public function isValid($value) } } ``` + Report an exception but continue handling the current request ### HTTP Exceptions + ```php // page not found abort(404); @@ -485,13 +551,13 @@ abort(403); // Server Error abort(500); ``` + Generate an HTTP exception response using status code - -Controllers ---------------- +## Controllers ### Basic + ```php namespace App\Http\Controllers; @@ -508,21 +574,24 @@ class UserController extends Controller } } ``` + Define a route for this controller method: + ```php use App\Http\Controllers\UserController; Route::get('/user/{id}', [UserController::class, 'show']); ``` -Requests ---------------- +## 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(); @@ -532,21 +601,25 @@ Route::get('/token', function (Request $request) { // ... }); ``` -`POST`, `PUT`, `PATCH`, or `DELETE` forms should include a hidden CSRF `_token` field -in the form to validate the request. + +`POST`, `PUT`, `PATCH`, or `DELETE` forms should include a hidden CSRF `_token` field in the form to validate the +request. + ```html
``` + See [Forms](#forms-cols-3) ### Accessing Request -Get an instance of the current request by type-hinting the -controller action or route closure + +Get an instance of the current request by type-hinting the controller action or route closure + ```php // controller action class UserController extends Controller @@ -561,25 +634,33 @@ class UserController extends Controller Route::get('/', function (Request $request) { // }); -``` +``` + [See Routing](#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.*')) { // @@ -587,7 +668,9 @@ if ($request->routeIs('admin.*')) { ``` ### URL + Full URL for the incoming request + ```php // URL without the query string $url = $request->url(); @@ -600,6 +683,7 @@ $request->fullUrlWithQuery(['type' => 'phone']); ``` ### Request Method + ```php $method = $request->method(); @@ -610,12 +694,13 @@ if ($request->isMethod('post')) { ``` ### Client IP + ```php $ipAddress = $request->ip(); ``` +### Headers -### Headers ```php $value = $request->header('X-Header-Name'); @@ -631,24 +716,31 @@ $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 {.row-span-4} + 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(); @@ -657,9 +749,11 @@ $request->collect('users')->each(function ($user) { // ... }); ``` + See [Helpers](#helpers-cols-3) Retrieve user input (also gets values from query string) + ```php $name = $request->input('name'); @@ -668,6 +762,7 @@ $name = $request->input('name', 'Sally'); ``` Access array inputs + ```php $name = $request->input('products.0.name'); @@ -675,11 +770,13 @@ $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'); @@ -688,26 +785,31 @@ $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"`. + +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']); @@ -719,7 +821,9 @@ $input = $request->except('credit_card'); ``` ### Check Existence + Determine if value(s) present + ```php if ($request->has('name')) { // @@ -737,24 +841,31 @@ 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 ``` + See: [Helpers](#helpers-cols-3) See: [Forms](#forms-cols-3) ### Uploaded Files + Retrieve uploaded file from request + ```php $file = $request->file('photo'); @@ -762,6 +873,7 @@ $file = $request->photo; ``` Get file path or extension + ```php $path = $request->photo->path(); @@ -769,47 +881,54 @@ $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'); +$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](https://laravel.com/docs/8.x/filesystem) +## Views -Views ---------------- ### Intro + - [Laravel Docs - Views](https://laravel.com/docs/8.x/views) - + ```html - -I'm looping forever.
@endwhile ``` + Loop Iteration: + ```php @foreach ($users as $user) @if ($loop->first) @@ -934,42 +1068,51 @@ Loop Iteration:This is user {{ $user->id }}
@endforeach ``` + See more: [Laravel Loop Variable](https://laravel.com/docs/8.x/blade#the-loop-variable) - ### Displaying Data -Blade's echo statements `{{ }}` are automatically sent through -PHP's `htmlspecialchars` function to prevent XSS attacks. + +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