Laradoc

Appearance

Laravel Folio ​

介紹 ​

Laravel Folio 是一個強大的頁面基礎路由，旨在簡化 Laravel 應用程式中的路由設定。有了 Laravel Folio，生成路由就像在應用程式的 resources/views/pages 目錄中建立一個 Blade 模板一樣輕鬆。

例如，要建立一個可透過 /greeting URL 存取的頁面，只需在應用程式的 resources/views/pages 目錄中建立一個 greeting.blade.php 檔案：

php
<div>
    Hello World
</div>

安裝 ​

首先，使用 Composer 套件管理工具將 Folio 安裝到您的專案中：

shell
composer require laravel/folio

安裝 Folio 後，您可以執行 folio:install Artisan 命令，這會將 Folio 的服務提供者安裝到您的應用程式中。此服務提供者會註冊 Folio 用於搜尋路由 / 頁面的目錄：

shell
php artisan folio:install

頁面路徑 / URIs ​

預設情況下，Folio 從應用程式的 resources/views/pages 目錄提供頁面，但您可以在 Folio 服務提供者的 boot 方法中自訂這些目錄。

例如，有時在同一個 Laravel 應用程式中指定多個 Folio 路徑可能很方便。您可能希望為應用程式的「admin」區域設定一個單獨的 Folio 頁面目錄，同時為應用程式的其他頁面使用另一個目錄。

您可以透過使用 Folio::path 和 Folio::uri 方法來實現此目的。path 方法註冊 Folio 在路由傳入 HTTP 請求時將掃描頁面的目錄，而 uri 方法則指定該頁面目錄的「基礎 URI」：

php
use Laravel\Folio\Folio;

Folio::path(resource_path('views/pages/guest'))->uri('/');

Folio::path(resource_path('views/pages/admin'))
    ->uri('/admin')
    ->middleware([
        '*' => [
            'auth',
            'verified',

            // ...
        ],
    ]);

子網域路由 ​

您也可以根據傳入請求的子網域路由到頁面。例如，您可能希望將來自 admin.example.com 的請求路由到與其他 Folio 頁面不同的頁面目錄。您可以透過在呼叫 Folio::path 方法後呼叫 domain 方法來實現此目的：

php
use Laravel\Folio\Folio;

Folio::domain('admin.example.com')
    ->path(resource_path('views/pages/admin'));

domain 方法還允許您將網域或子網域的部分作為參數捕獲。這些參數將被注入到您的頁面模板中：

php
use Laravel\Folio\Folio;

Folio::domain('{account}.example.com')
    ->path(resource_path('views/pages/admin'));

建立路由 ​

您可以透過將 Blade 模板放置在任何 Folio 掛載目錄中來建立 Folio 路由。預設情況下，Folio 掛載 resources/views/pages 目錄，但您可以在 Folio 服務提供者的 boot 方法中自訂這些目錄。

一旦 Blade 模板被放置在 Folio 掛載目錄中，您就可以立即透過瀏覽器存取它。例如，放置在 pages/schedule.blade.php 的頁面可以透過 http://example.com/schedule 在您的瀏覽器中存取。

若要快速查看所有 Folio 頁面 / 路由的列表，您可以呼叫 folio:list Artisan 命令：

shell
php artisan folio:list

巢狀路由 ​

您可以透過在其中一個 Folio 目錄中建立一個或多個目錄來建立巢狀路由。例如，要建立一個可透過 /user/profile 存取的頁面，請在 pages/user 目錄中建立一個 profile.blade.php 模板：

shell
php artisan folio:page user/profile

# pages/user/profile.blade.php → /user/profile

索引路由 ​

有時，您可能希望將特定頁面設為目錄的「索引」。透過在 Folio 目錄中放置 index.blade.php 模板，任何對該目錄根目錄的請求都將路由到該頁面：

shell
php artisan folio:page index
# pages/index.blade.php → /

php artisan folio:page users/index
# pages/users/index.blade.php → /users

路由參數 ​

通常，您需要將傳入請求 URL 的片段注入到您的頁面中，以便您可以與它們互動。例如，您可能需要存取正在顯示其個人資料的使用者「ID」。為此，您可以將頁面檔案名稱的一個片段用方括號括起來：

shell
php artisan folio:page "users/[id]"

# pages/users/[id].blade.php → /users/1

捕獲到的片段可以在您的 Blade 模板中作為變數存取：

html
<div>
    User {{ $id }}
</div>

若要捕獲多個片段，您可以將方括號內的片段加上三個點 ...：

shell
php artisan folio:page "users/[...ids]"

# pages/users/[...ids].blade.php → /users/1/2/3

捕獲多個片段時，捕獲到的片段將作為陣列注入頁面：

html
<ul>
    @foreach ($ids as $id)
        <li>User {{ $id }}</li>
    @endforeach
</ul>

路由模型綁定 ​

如果您的頁面模板檔案名稱中的萬用字元片段對應到您的應用程式的 Eloquent 模型之一，Folio 將自動利用 Laravel 的路由模型綁定功能，並嘗試將解析後的模型實例注入到您的頁面中：

shell
php artisan folio:page "users/[User]"

# pages/users/[User].blade.php → /users/1

捕獲到的模型可以在您的 Blade 模板中作為變數存取。模型的變數名稱將被轉換為「駝峰式大小寫」：

html
<div>
    User {{ $user->id }}
</div>

自訂鍵名 ​

有時，您可能希望使用 id 以外的欄位來解析綁定的 Eloquent 模型。為此，您可以在頁面檔案名稱中指定欄位。例如，檔案名稱為 [Post:slug].blade.php 的頁面將嘗試透過 slug 欄位而不是 id 欄位來解析綁定的模型。

在 Windows 上，您應該使用 - 來分隔模型名稱和鍵：[Post-slug].blade.php。

模型位置 ​

預設情況下，Folio 將在您應用程式的 app/Models 目錄中搜尋您的模型。但是，如果需要，您可以在模板的檔案名稱中指定完整的模型類別名稱：

shell
php artisan folio:page "users/[.App.Models.User]"

# pages/users/[.App.Models.User].blade.php → /users/1

軟刪除模型 ​

預設情況下，解析隱式模型綁定時不會檢索已被軟刪除的模型。但是，如果您願意，可以在頁面模板中呼叫 withTrashed 函數來指示 Folio 檢索軟刪除的模型：

php
<?php

use function Laravel\Folio\{withTrashed};

withTrashed();

?>

<div>
    User {{ $user->id }}
</div>

渲染掛鉤 ​

預設情況下，Folio 將頁面 Blade 模板的內容作為對傳入請求的回應。但是，您可以在頁面模板中呼叫 render 函數來自訂回應。

render 函數接受一個閉包，該閉包將接收 Folio 正在渲染的 View 實例，允許您向視圖添加額外資料或自訂整個回應。除了接收 View 實例外，任何額外的路由參數或模型綁定也將提供給 render 閉包：

php
<?php

use App\Models\Post;
use Illuminate\Support\Facades\Auth;
use Illuminate\View\View;

use function Laravel\Folio\render;

render(function (View $view, Post $post) {
    if (! Auth::user()->can('view', $post)) {
        return response('Unauthorized', 403);
    }

    return $view->with('photos', $post->author->photos);
}); ?>

<div>
    {{ $post->content }}
</div>

<div>
    This author has also taken {{ count($photos) }} photos.
</div>

具名路由 ​

您可以使用 name 函數為指定頁面的路由定義名稱：

php
<?php

use function Laravel\Folio\name;

name('users.index');

就像 Laravel 的具名路由一樣，您可以使用 route 函數來生成已指定名稱的 Folio 頁面 URL：

php
<a href="{{ route('users.index') }}">
    All Users
</a>

如果頁面包含參數，您只需將其值傳遞給 route 函數即可：

php
route('users.show', ['user' => $user]);

中介層 ​

您可以在頁面的範本內呼叫 middleware 函數，將中介層應用於特定頁面：

php
<?php

use function Laravel\Folio\{middleware};

middleware(['auth', 'verified']);

?>

<div>
    Dashboard
</div>

或者，若要將中介層指定給多個頁面，您可以在呼叫 Folio::path 方法後，串接 middleware 方法。

為了指定中介層應該應用於哪些頁面，中介層的陣列可以使用相應頁面的 URL 模式作為鍵。* 字元可用作萬用字元：

php
use Laravel\Folio\Folio;

Folio::path(resource_path('views/pages'))->middleware([
    'admin/*' => [
        'auth',
        'verified',

        // ...
    ],
]);

您可以在中介層陣列中包含閉包，以定義行內匿名中介層：

php
use Closure;
use Illuminate\Http\Request;
use Laravel\Folio\Folio;

Folio::path(resource_path('views/pages'))->middleware([
    'admin/*' => [
        'auth',
        'verified',

        function (Request $request, Closure $next) {
            // ...

            return $next($request);
        },
    ],
]);

路由快取 ​

使用 Folio 時，您應該始終利用 Laravel 的路由快取功能。Folio 會監聽 route:cache Artisan 命令，以確保 Folio 頁面定義和路由名稱正確快取，從而實現最佳效能。