Skip to content

Blade 模板

简介

Blade 是 Laravel 内置的简洁而强大的模板引擎。与某些 PHP 模板引擎不同,Blade 不会限制你在模板中使用原生 PHP 代码。实际上,所有 Blade 模板都会被编译为原生 PHP 代码并缓存起来,直到被修改为止,这意味着 Blade 基本上不会给你的应用增加任何额外开销。Blade 模板文件使用 .blade.php 文件扩展名,通常存储在 resources/views 目录中。

Blade 视图可以通过全局 view 辅助函数从路由或控制器中返回。当然,正如视图文档中所提到的,可以使用 view 辅助函数的第二个参数将数据传递给 Blade 视图:

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

使用 Livewire 增强 Blade

想要将 Blade 模板提升到更高的层次,轻松构建动态界面?请查看 Laravel Livewire。Livewire 允许你编写具有动态功能的 Blade 组件,这些功能通常只有通过 React、Svelte 或 Vue 等前端框架才能实现,为构建现代的、响应式的前端提供了一种极佳的方式,无需面对许多 JavaScript 框架带来的复杂性、客户端渲染或构建步骤。

显示数据

你可以通过将变量包裹在花括号中来显示传递给 Blade 视图的数据。例如,给定以下路由:

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

你可以这样显示 name 变量的内容:

blade
Hello, {{ $name }}.

NOTE

Blade 的 echo 语句会自动通过 PHP 的 htmlspecialchars 函数处理以防止 XSS 攻击。

你不仅可以显示传递给视图的变量内容,还可以输出任何 PHP 函数的结果。实际上,你可以在 Blade echo 语句中放入任何 PHP 代码:

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

HTML 实体编码

默认情况下,Blade(以及 Laravel 的 e 函数)会对 HTML 实体进行双重编码。如果你希望禁用双重编码,可以在 AppServiceProviderboot 方法中调用 Blade::withoutDoubleEncoding 方法:

php
<?php

namespace App\Providers;

use Illuminate\Support\Facades\Blade;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 引导任何应用服务。
     */
    public function boot(): void
    {
        Blade::withoutDoubleEncoding();
    }
}

显示未转义的数据

默认情况下,Blade 语句会自动通过 PHP 的 htmlspecialchars 函数处理以防止 XSS 攻击。如果你不希望数据被转义,可以使用以下语法:

blade
Hello, {!! $name !!}.

WARNING

在输出应用用户提供的内容时要格外小心。通常应该使用转义的双花括号语法来防止 XSS 攻击。

Blade 与 JavaScript 框架

由于许多 JavaScript 框架也使用「花括号」来表示应在浏览器中显示的表达式,你可以使用 @ 符号来告知 Blade 渲染引擎保留该表达式不做处理。例如:

blade
<h1>Laravel</h1>

Hello, @{{ name }}.

在这个例子中,@ 符号会被 Blade 移除;但 表达式将不会被 Blade 引擎处理,从而可以由你的 JavaScript 框架来渲染。

@ 符号也可用于转义 Blade 指令:

blade
{{-- Blade template --}}
@@if()

<!-- HTML output -->
@if()

渲染 JSON

有时你可能会将一个数组传递给视图,并打算将其渲染为 JSON 以初始化 JavaScript 变量。例如:

php
<script>
    var app = <?php echo json_encode($array); ?>;
</script>

然而,你可以使用 Illuminate\Support\Js::from 方法来代替手动调用 json_encodefrom 方法接受与 PHP 的 json_encode 函数相同的参数;但它会确保生成的 JSON 已正确转义以便在 HTML 引号中包含。from 方法将返回一个 JSON.parse JavaScript 语句,它会将给定的对象或数组转换为有效的 JavaScript 对象:

blade
<script>
    var app = {{ Illuminate\Support\Js::from($array) }};
</script>

最新版本的 Laravel 应用骨架包含了一个 Js facade,可以在 Blade 模板中方便地使用此功能:

blade
<script>
    var app = {{ Js::from($array) }};
</script>

WARNING

你应该只使用 Js::from 方法来渲染已有的变量为 JSON。Blade 模板基于正则表达式,尝试向指令传递复杂表达式可能会导致意外的失败。

@verbatim 指令

如果你在模板的大部分区域显示 JavaScript 变量,可以将 HTML 包裹在 @verbatim 指令中,这样你就不必在每个 Blade echo 语句前加上 @ 符号:

blade
@verbatim
    <div class="container">
        Hello, {{ name }}.
    </div>
@endverbatim

Blade 指令

除了模板继承和数据显示之外,Blade 还为常见的 PHP 控制结构(如条件语句和循环)提供了便捷的快捷方式。这些快捷方式提供了一种非常简洁的方式来处理 PHP 控制结构,同时保持与其 PHP 对应物的相似性。

If 语句

你可以使用 @if@elseif@else@endif 指令来构造 if 语句。这些指令的功能与其 PHP 对应物完全相同:

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

为了方便,Blade 还提供了 @unless 指令:

blade
@unless (Auth::check())
    You are not signed in.
@endunless

除了前面讨论的条件指令外,@isset@empty 指令也可以作为其对应 PHP 函数的便捷快捷方式:

blade
@isset($records)
    // $records 已定义且不为 null...
@endisset

@empty($records)
    // $records 为「空」...
@endempty

认证指令

@auth@guest 指令可用于快速判断当前用户是否已认证或是访客:

blade
@auth
    // 用户已认证...
@endauth

@guest
    // 用户未认证...
@endguest

如果需要,你可以在使用 @auth@guest 指令时指定应检查的认证守卫:

blade
@auth('admin')
    // 用户已认证...
@endauth

@guest('admin')
    // 用户未认证...
@endguest

环境指令

你可以使用 @production 指令检查应用是否运行在生产环境中:

blade
@production
    // 生产环境特定内容...
@endproduction

或者,你可以使用 @env 指令判断应用是否运行在特定的环境中:

blade
@env('staging')
    // 应用正运行在 "staging" 环境中...
@endenv

@env(['staging', 'production'])
    // 应用正运行在 "staging" 或 "production" 环境中...
@endenv

Section 指令

你可以使用 @hasSection 指令来判断模板继承的 section 是否有内容:

blade
@hasSection('navigation')
    <div class="pull-right">
        @yield('navigation')
    </div>

    <div class="clearfix"></div>
@endif

你可以使用 sectionMissing 指令来判断某个 section 是否没有内容:

blade
@sectionMissing('navigation')
    <div class="pull-right">
        @include('default-navigation')
    </div>
@endif

Session 指令

@session 指令可用于判断某个 session 值是否存在。如果 session 值存在,则会执行 @session@endsession 指令之间的模板内容。在 @session 指令的内容中,你可以输出 $value 变量来显示 session 值:

blade
@session('status')
    <div class="p-4 bg-green-100">
        {{ $value }}
    </div>
@endsession

Context 指令

@context 指令可用于判断某个 context 值是否存在。如果 context 值存在,则会执行 @context@endcontext 指令之间的模板内容。在 @context 指令的内容中,你可以输出 $value 变量来显示 context 值:

blade
@context('canonical')
    <link href="{{ $value }}" rel="canonical">
@endcontext

Switch 语句

Switch 语句可以使用 @switch@case@break@default@endswitch 指令来构造:

blade
@switch($i)
    @case(1)
        First case...
        @break

    @case(2)
        Second case...
        @break

    @default
        Default case...
@endswitch

循环

除了条件语句外,Blade 还提供了用于处理 PHP 循环结构的简洁指令。同样,这些指令的功能与其 PHP 对应物完全相同:

blade
@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

NOTE

在遍历 foreach 循环时,你可以使用循环变量来获取关于循环的有用信息,例如你是否处于循环的第一次或最后一次迭代中。

使用循环时,你还可以使用 @continue@break 指令来跳过当前迭代或结束循环:

blade
@foreach ($users as $user)
    @if ($user->type == 1)
        @continue
    @endif

    <li>{{ $user->name }}</li>

    @if ($user->number == 5)
        @break
    @endif
@endforeach

你还可以在指令声明中直接包含跳过或中断条件:

blade
@foreach ($users as $user)
    @continue($user->type == 1)

    <li>{{ $user->name }}</li>

    @break($user->number == 5)
@endforeach

循环变量

在遍历 foreach 循环时,循环内部会有一个 $loop 变量可用。此变量提供了一些有用的信息,例如当前循环索引以及当前是否为循环的第一次或最后一次迭代:

blade
@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

如果你处于嵌套循环中,可以通过 parent 属性访问父循环的 $loop 变量:

blade
@foreach ($users as $user)
    @foreach ($user->posts as $post)
        @if ($loop->parent->first)
            This is the first iteration of the parent loop.
        @endif
    @endforeach
@endforeach

$loop 变量还包含其他多种有用的属性:

属性描述
$loop->index当前循环迭代的索引(从 0 开始)。
$loop->iteration当前循环迭代次数(从 1 开始)。
$loop->remaining循环中剩余的迭代次数。
$loop->count被迭代数组中元素的总数。
$loop->first是否为循环的第一次迭代。
$loop->last是否为循环的最后一次迭代。
$loop->even是否为循环的偶数次迭代。
$loop->odd是否为循环的奇数次迭代。
$loop->depth当前循环的嵌套层级。
$loop->parent在嵌套循环中,父循环的 loop 变量。

条件类与样式

@class 指令可以有条件地编译 CSS 类字符串。该指令接受一个类数组,其中数组键包含你希望添加的类,而值是一个布尔表达式。如果数组元素具有数字键,它将始终被包含在渲染的类列表中:

blade
@php
    $isActive = false;
    $hasError = true;
@endphp

<span @class([
    'p-4',
    'font-bold' => $isActive,
    'text-gray-500' => ! $isActive,
    'bg-red' => $hasError,
])></span>

<span class="p-4 text-gray-500 bg-red"></span>

类似地,@style 指令可用于有条件地向 HTML 元素添加内联 CSS 样式:

blade
@php
    $isActive = true;
@endphp

<span @style([
    'background-color: red',
    'font-weight: bold' => $isActive,
])></span>

<span style="background-color: red; font-weight: bold;"></span>

附加属性

为了方便,你可以使用 @checked 指令来轻松指示给定的 HTML 复选框输入是否被「选中」。如果提供的条件为 true,该指令将输出 checked

blade
<input
    type="checkbox"
    name="active"
    value="active"
    @checked(old('active', $user->active))
/>

类似地,@selected 指令可用于指示给定的 select 选项是否应被「选中」:

blade
<select name="version">
    @foreach ($product->versions as $version)
        <option value="{{ $version }}" @selected(old('version') == $version)>
            {{ $version }}
        </option>
    @endforeach
</select>

此外,@disabled 指令可用于指示给定元素是否应被「禁用」:

blade
<button type="submit" @disabled($errors->isNotEmpty())>Submit</button>

另外,@readonly 指令可用于指示给定元素是否应为「只读」:

blade
<input
    type="email"
    name="email"
    value="email@laravel.com"
    @readonly($user->isNotAdmin())
/>

同样,@required 指令可用于指示给定元素是否应为「必填」:

blade
<input
    type="text"
    name="title"
    value="title"
    @required($user->isAdmin())
/>

引入子视图

NOTE

虽然你可以自由使用 @include 指令,但 Blade 组件提供了类似的功能,并且相比 @include 指令有多项优势,例如数据和属性绑定。

Blade 的 @include 指令允许你在一个视图中引入另一个 Blade 视图。父视图中可用的所有变量都将对被引入的视图可用:

blade
<div>
    @include('shared.errors')

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

尽管被引入的视图会继承父视图中所有可用的数据,你也可以传递一个额外数据数组给被引入的视图:

blade
@include('view.name', ['status' => 'complete'])

如果你尝试 @include 一个不存在的视图,Laravel 将抛出错误。如果你希望引入一个可能存在也可能不存在的视图,应该使用 @includeIf 指令:

blade
@includeIf('view.name', ['status' => 'complete'])

如果你希望在给定布尔表达式为 truefalse@include 一个视图,可以使用 @includeWhen@includeUnless 指令:

blade
@includeWhen($boolean, 'view.name', ['status' => 'complete'])

@includeUnless($boolean, 'view.name', ['status' => 'complete'])

要从给定的视图数组中引入第一个存在的视图,你可以使用 includeFirst 指令:

blade
@includeFirst(['custom.admin', 'admin'], ['status' => 'complete'])

如果你希望引入一个视图但不继承父视图的任何变量,可以使用 @includeIsolated 指令。被引入的视图将只能访问你显式传递的变量:

blade
@includeIsolated('view.name', ['user' => $user])

WARNING

你应该避免在 Blade 视图中使用 __DIR____FILE__ 常量,因为它们将引用缓存的编译视图的位置。

为集合渲染视图

你可以使用 Blade 的 @each 指令将循环和引入合并为一行:

blade
@each('view.name', $jobs, 'job')

@each 指令的第一个参数是要为数组或集合中的每个元素渲染的视图。第二个参数是你希望迭代的数组或集合,第三个参数是将分配给视图中当前迭代的变量名。例如,如果你正在迭代一个 jobs 数组,通常你会希望在视图中以 job 变量访问每个 job。当前迭代的数组键将作为 key 变量在视图中可用。

你还可以向 @each 指令传递第四个参数。此参数指定当给定数组为空时将渲染的视图。

blade
@each('view.name', $jobs, 'job', 'view.empty')

WARNING

通过 @each 渲染的视图不会继承父视图的变量。如果子视图需要这些变量,你应该改用 @foreach@include 指令。

@once 指令

@once 指令允许你定义模板中只在每个渲染周期内执行一次的部分。这对于使用 stacks 将给定的 JavaScript 代码推入页面头部非常有用。例如,如果你在循环中渲染一个给定的组件,你可能希望只在组件第一次渲染时将 JavaScript 推入头部:

blade
@once
    @push('scripts')
        <script>
            // 你的自定义 JavaScript...
        </script>
    @endpush
@endonce

由于 @once 指令常与 @push@prepend 指令一起使用,@pushOnce@prependOnce 指令也可供你使用:

blade
@pushOnce('scripts')
    <script>
        // 你的自定义 JavaScript...
    </script>
@endPushOnce

如果你从两个单独的 Blade 模板推入重复内容,应该为 @pushOnce 指令提供一个唯一标识符作为第二个参数,以确保内容只渲染一次:

blade
<!-- pie-chart.blade.php -->
@pushOnce('scripts', 'chart.js')
    <script src="/chart.js"></script>
@endPushOnce

<!-- line-chart.blade.php -->
@pushOnce('scripts', 'chart.js')
    <script src="/chart.js"></script>
@endPushOnce

原生 PHP

在某些情况下,将 PHP 代码嵌入视图中是有用的。你可以使用 Blade 的 @php 指令在模板中执行一段原生 PHP 代码:

blade
@php
    $counter = 1;
@endphp

或者,如果你只需要使用 PHP 来导入一个类,可以使用 @use 指令:

blade
@use('App\Models\Flight')

可以向 @use 指令提供第二个参数来为导入的类设置别名:

blade
@use('App\Models\Flight', 'FlightModel')

如果你有多个类在同一命名空间下,可以将这些类的导入分组:

blade
@use('App\Models\{Flight, Airport}')

@use 指令还支持通过在导入路径前添加 functionconst 修饰符来导入 PHP 函数和常量:

blade
@use(function App\Helpers\format_currency)
@use(const App\Constants\MAX_ATTEMPTS)

与类导入一样,函数和常量也支持别名:

blade
@use(function App\Helpers\format_currency, 'formatMoney')
@use(const App\Constants\MAX_ATTEMPTS, 'MAX_TRIES')

function 和 const 修饰符也支持分组导入,允许你在单个指令中从同一命名空间导入多个符号:

blade
@use(function App\Helpers\{format_currency, format_date})
@use(const App\Constants\{MAX_ATTEMPTS, DEFAULT_TIMEOUT})

注释

Blade 也允许你在视图中定义注释。但是,与 HTML 注释不同,Blade 注释不会包含在应用返回的 HTML 中:

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

组件

组件和插槽提供了与 section、布局和引入类似的好处;但是,有些人可能会发现组件和插槽的思维模型更容易理解。编写组件有两种方式:基于类的组件和匿名组件。

要创建基于类的组件,你可以使用 make:component Artisan 命令。为了说明如何使用组件,我们将创建一个简单的 Alert 组件。make:component 命令会将组件放在 app/View/Components 目录中:

shell
php artisan make:component Alert

make:component 命令还会为组件创建一个视图模板。该视图将放在 resources/views/components 目录中。在为你自己的应用编写组件时,组件会在 app/View/Components 目录和 resources/views/components 目录中被自动发现,因此通常不需要额外的组件注册。

你也可以在子目录中创建组件:

shell
php artisan make:component Forms/Input

上面的命令将在 app/View/Components/Forms 目录中创建一个 Input 组件,视图将放在 resources/views/components/forms 目录中。

手动注册包组件

在为你自己的应用编写组件时,组件会在 app/View/Components 目录和 resources/views/components 目录中被自动发现。

但是,如果你正在构建一个使用 Blade 组件的包,则需要手动注册组件类及其 HTML 标签别名。你通常应该在包的 service provider 的 boot 方法中注册组件:

php
use Illuminate\Support\Facades\Blade;

/**
 * 引导包的服务。
 */
public function boot(): void
{
    Blade::component('package-alert', Alert::class);
}

注册组件后,可以使用其标签别名来渲染它:

blade
<x-package-alert/>

或者,你可以使用 componentNamespace 方法按约定自动加载组件类。例如,一个 Nightshade 包可能有 CalendarColorPicker 组件,它们位于 Package\Views\Components 命名空间中:

php
use Illuminate\Support\Facades\Blade;

/**
 * 引导包的服务。
 */
public function boot(): void
{
    Blade::componentNamespace('Nightshade\\Views\\Components', 'nightshade');
}

这将允许使用 package-name:: 语法通过其供应商命名空间来使用包组件:

blade
<x-nightshade::calendar />
<x-nightshade::color-picker />

Blade 会通过将组件名称转为 Pascal 大小写来自动检测链接到此组件的类。也支持使用「点」记法的子目录。

渲染组件

要显示组件,你可以在 Blade 模板中使用 Blade 组件标签。Blade 组件标签以字符串 x- 开头,后跟组件类的 kebab-case 名称:

blade
<x-alert/>

<x-user-profile/>

如果组件类嵌套在 app/View/Components 目录的更深层,你可以使用 . 字符来表示目录嵌套。例如,如果我们假设组件位于 app/View/Components/Inputs/Button.php,可以这样渲染它:

blade
<x-inputs.button/>

如果你希望有条件地渲染组件,可以在组件类上定义一个 shouldRender 方法。如果 shouldRender 方法返回 false,则组件不会被渲染:

php
use Illuminate\Support\Str;

/**
 * 组件是否应该被渲染。
 */
public function shouldRender(): bool
{
    return Str::length($this->message) > 0;
}

索引组件

有时组件是组件组的一部分,你可能希望将相关组件分组到单个目录中。例如,想象一个具有以下类结构的 "card" 组件:

text
App\Views\Components\Card\Card
App\Views\Components\Card\Header
App\Views\Components\Card\Body

由于根 Card 组件嵌套在 Card 目录中,你可能会认为需要通过 <x-card.card> 来渲染组件。但是,当组件的文件名与组件目录名匹配时,Laravel 会自动将该组件视为「根」组件,允许你在不重复目录名的情况下渲染它:

blade
<x-card>
    <x-card.header>...</x-card.header>
    <x-card.body>...</x-card.body>
</x-card>

向组件传递数据

你可以使用 HTML 属性向 Blade 组件传递数据。硬编码的原始值可以使用简单的 HTML 属性字符串传递给组件。PHP 表达式和变量应该通过以 : 字符为前缀的属性传递给组件:

blade
<x-alert type="error" :message="$message"/>

你应该在组件类的构造函数中定义所有组件的数据属性。组件上的所有公共属性都将自动对组件视图可用。不必从组件的 render 方法向视图传递数据:

php
<?php

namespace App\View\Components;

use Illuminate\View\Component;
use Illuminate\View\View;

class Alert extends Component
{
    /**
     * 创建组件实例。
     */
    public function __construct(
        public string $type,
        public string $message,
    ) {}

    /**
     * 获取表示组件的视图/内容。
     */
    public function render(): View
    {
        return view('components.alert');
    }
}

当组件被渲染时,你可以通过按名称输出变量来显示组件公共变量的内容:

blade
<div class="alert alert-{{ $type }}">
    {{ $message }}
</div>

大小写

组件构造函数参数应使用 camelCase 指定,而在 HTML 属性中引用参数名时应使用 kebab-case。例如,给定以下组件构造函数:

php
/**
 * 创建组件实例。
 */
public function __construct(
    public string $alertType,
) {}

可以这样向组件提供 $alertType 参数:

blade
<x-alert alert-type="danger" />

简短属性语法

向组件传递属性时,你也可以使用「简短属性」语法。这通常很方便,因为属性名经常与其对应的变量名匹配:

blade
{{-- Short attribute syntax... --}}
<x-profile :$userId :$name />

{{-- Is equivalent to... --}}
<x-profile :user-id="$userId" :name="$name" />

转义属性渲染

由于某些 JavaScript 框架(如 Alpine.js)也使用冒号前缀的属性,你可以使用双冒号(::)前缀来告知 Blade 该属性不是 PHP 表达式。例如,给定以下组件:

blade
<x-button ::class="{ danger: isDeleting }">
    Submit
</x-button>

Blade 将渲染以下 HTML:

blade
<button :class="{ danger: isDeleting }">
    Submit
</button>

组件方法

除了公共变量对组件模板可用外,组件上的任何公共方法也可以被调用。例如,想象一个具有 isSelected 方法的组件:

php
/**
 * 判断给定选项是否为当前选中的选项。
 */
public function isSelected(string $option): bool
{
    return $option === $this->selected;
}

你可以在组件模板中通过调用与方法名匹配的变量来执行此方法:

blade
<option {{ $isSelected($value) ? 'selected' : '' }} value="{{ $value }}">
    {{ $label }}
</option>

在组件类中访问属性和插槽

Blade 组件还允许你在类的 render 方法中访问组件名称、属性和插槽。但是,要访问此数据,你应该从组件的 render 方法返回一个闭包:

php
use Closure;

/**
 * 获取表示组件的视图/内容。
 */
public function render(): Closure
{
    return function () {
        return '<div {{ $attributes }}>Components content</div>';
    };
}

组件的 render 方法返回的闭包也可以接收一个 $data 数组作为其唯一参数。此数组将包含多个提供组件信息的元素:

php
return function (array $data) {
    // $data['componentName'];
    // $data['attributes'];
    // $data['slot'];

    return '<div {{ $attributes }}>Components content</div>';
}

WARNING

$data 数组中的元素永远不应直接嵌入到 render 方法返回的 Blade 字符串中,因为这样做可能会通过恶意属性内容导致远程代码执行。

componentName 等于 HTML 标签中 x- 前缀之后的名称。所以 <x-alert />componentName 将是 alertattributes 元素将包含 HTML 标签上的所有属性。slot 元素是一个 Illuminate\Support\HtmlString 实例,包含组件插槽的内容。

闭包应该返回一个字符串。如果返回的字符串对应一个已有的视图,则该视图将被渲染;否则,返回的字符串将作为内联 Blade 视图进行求值。

附加依赖

如果你的组件需要来自 Laravel service container 的依赖,你可以在组件的数据属性之前列出它们,它们将由容器自动注入:

php
use App\Services\AlertCreator;

/**
 * 创建组件实例。
 */
public function __construct(
    public AlertCreator $creator,
    public string $type,
    public string $message,
) {}

隐藏属性/方法

如果你希望阻止某些公共方法或属性作为变量暴露给组件模板,你可以将它们添加到组件的 $except 数组属性中:

php
<?php

namespace App\View\Components;

use Illuminate\View\Component;

class Alert extends Component
{
    /**
     * 不应暴露给组件模板的属性/方法。
     *
     * @var array
     */
    protected $except = ['type'];

    /**
     * 创建组件实例。
     */
    public function __construct(
        public string $type,
    ) {}
}

组件属性

我们已经了解了如何向组件传递数据属性;但是,有时你可能需要指定额外的 HTML 属性,例如 class,这些属性不是组件功能所需的数据的一部分。通常,你希望将这些额外属性传递到组件模板的根元素。例如,假设我们想要这样渲染一个 alert 组件:

blade
<x-alert type="error" :message="$message" class="mt-4"/>

所有不属于组件构造函数的属性都将自动添加到组件的「属性包」中。此属性包通过 $attributes 变量自动对组件可用。所有属性都可以通过输出此变量在组件中渲染:

blade
<div {{ $attributes }}>
    <!-- Component content -->
</div>

WARNING

目前不支持在组件标签中使用 @env 等指令。例如,<x-alert :live="@env('production')"/> 将不会被编译。

默认/合并属性

有时你可能需要为属性指定默认值或将额外的值合并到组件的某些属性中。为此,你可以使用属性包的 merge 方法。此方法对于定义一组应始终应用于组件的默认 CSS 类特别有用:

blade
<div {{ $attributes->merge(['class' => 'alert alert-'.$type]) }}>
    {{ $message }}
</div>

如果我们假设此组件被这样使用:

blade
<x-alert type="error" :message="$message" class="mb-4"/>

组件最终渲染的 HTML 将如下所示:

blade
<div class="alert alert-error mb-4">
    <!-- $message 变量的内容 -->
</div>

条件合并类

有时你可能希望在给定条件为 true 时合并类。你可以通过 class 方法来实现,该方法接受一个类数组,其中数组键包含你希望添加的类,值是一个布尔表达式。如果数组元素具有数字键,它将始终被包含在渲染的类列表中:

blade
<div {{ $attributes->class(['p-4', 'bg-red' => $hasError]) }}>
    {{ $message }}
</div>

如果你需要将其他属性合并到组件上,可以将 merge 方法链接到 class 方法:

blade
<button {{ $attributes->class(['p-4'])->merge(['type' => 'button']) }}>
    {{ $slot }}
</button>

NOTE

如果你需要在其他不应接收合并属性的 HTML 元素上有条件地编译类,可以使用 @class 指令

非 class 属性合并

合并非 class 属性时,提供给 merge 方法的值将被视为属性的「默认」值。但是,与 class 属性不同,这些属性不会与注入的属性值合并,而是会被覆盖。例如,button 组件的实现可能如下所示:

blade
<button {{ $attributes->merge(['type' => 'button']) }}>
    {{ $slot }}
</button>

要使用自定义的 type 渲染按钮组件,可以在使用组件时指定它。如果未指定类型,将使用 button 类型:

blade
<x-button type="submit">
    Submit
</x-button>

此示例中 button 组件的渲染 HTML 为:

blade
<button type="submit">
    Submit
</button>

如果你希望 class 以外的属性将其默认值和注入的值连接在一起,可以使用 prepends 方法。在此示例中,data-controller 属性将始终以 profile-controller 开头,任何额外注入的 data-controller 值将放在此默认值之后:

blade
<div {{ $attributes->merge(['data-controller' => $attributes->prepends('profile-controller')]) }}>
    {{ $slot }}
</div>

获取和过滤属性

你可以使用 filter 方法过滤属性。此方法接受一个闭包,如果你希望在属性包中保留该属性,闭包应返回 true

blade
{{ $attributes->filter(fn (string $value, string $key) => $key == 'foo') }}

为了方便,你可以使用 whereStartsWith 方法检索所有键以给定字符串开头的属性:

blade
{{ $attributes->whereStartsWith('wire:model') }}

相反,whereDoesntStartWith 方法可用于排除所有键以给定字符串开头的属性:

blade
{{ $attributes->whereDoesntStartWith('wire:model') }}

使用 first 方法,你可以渲染给定属性包中的第一个属性:

blade
{{ $attributes->whereStartsWith('wire:model')->first() }}

如果你想检查某个属性是否存在于组件上,可以使用 has 方法。此方法接受属性名作为其唯一参数,并返回一个布尔值表示该属性是否存在:

blade
@if ($attributes->has('class'))
    <div>Class attribute is present</div>
@endif

如果向 has 方法传递一个数组,该方法将判断所有给定属性是否都存在于组件上:

blade
@if ($attributes->has(['name', 'class']))
    <div>All of the attributes are present</div>
@endif

hasAny 方法可用于判断给定属性中是否有任何一个存在于组件上:

blade
@if ($attributes->hasAny(['href', ':href', 'v-bind:href']))
    <div>One of the attributes is present</div>
@endif

你可以使用 get 方法检索特定属性的值:

blade
{{ $attributes->get('class') }}

only 方法可用于仅检索具有给定键的属性:

blade
{{ $attributes->only(['class']) }}

except 方法可用于检索除给定键以外的所有属性:

blade
{{ $attributes->except(['class']) }}

保留关键字

默认情况下,某些关键字是为 Blade 内部使用而保留的,用于渲染组件。以下关键字不能定义为组件中的公共属性或方法名:

  • data
  • render
  • resolve
  • resolveView
  • shouldRender
  • view
  • withAttributes
  • withName

插槽

你经常需要通过「插槽」向组件传递额外的内容。组件插槽通过输出 $slot 变量来渲染。为了探索这个概念,让我们假设一个 alert 组件具有以下标记:

blade
<!-- /resources/views/components/alert.blade.php -->

<div class="alert alert-danger">
    {{ $slot }}
</div>

我们可以通过向组件中注入内容来传递内容给 slot

blade
<x-alert>
    <strong>Whoops!</strong> Something went wrong!
</x-alert>

有时组件可能需要在组件内的不同位置渲染多个不同的插槽。让我们修改 alert 组件以允许注入一个 "title" 插槽:

blade
<!-- /resources/views/components/alert.blade.php -->

<span class="alert-title">{{ $title }}</span>

<div class="alert alert-danger">
    {{ $slot }}
</div>

你可以使用 x-slot 标签定义命名插槽的内容。任何不在显式 x-slot 标签内的内容都将通过 $slot 变量传递给组件:

xml
<x-alert>
    <x-slot:title>
        Server Error
    </x-slot>

    <strong>Whoops!</strong> Something went wrong!
</x-alert>

你可以调用插槽的 isEmpty 方法来判断插槽是否包含内容:

blade
<span class="alert-title">{{ $title }}</span>

<div class="alert alert-danger">
    @if ($slot->isEmpty())
        This is default content if the slot is empty.
    @else
        {{ $slot }}
    @endif
</div>

此外,hasActualContent 方法可用于判断插槽是否包含任何非 HTML 注释的「实际」内容:

blade
@if ($slot->hasActualContent())
    The scope has non-comment content.
@endif

作用域插槽

如果你使用过 Vue 等 JavaScript 框架,你可能熟悉「作用域插槽」,它允许你在插槽中访问组件的数据或方法。你可以在 Laravel 中通过在组件上定义公共方法或属性,并在插槽中通过 $component 变量访问组件来实现类似的行为。在此示例中,我们假设 x-alert 组件在其组件类上定义了一个公共的 formatAlert 方法:

blade
<x-alert>
    <x-slot:title>
        {{ $component->formatAlert('Server Error') }}
    </x-slot>

    <strong>Whoops!</strong> Something went wrong!
</x-alert>

插槽属性

与 Blade 组件一样,你可以为插槽分配额外的属性,例如 CSS 类名:

xml
<x-card class="shadow-sm">
    <x-slot:heading class="font-bold">
        Heading
    </x-slot>

    Content

    <x-slot:footer class="text-sm">
        Footer
    </x-slot>
</x-card>

要与插槽属性交互,你可以访问插槽变量的 attributes 属性。有关如何与属性交互的更多信息,请参阅组件属性文档:

blade
@props([
    'heading',
    'footer',
])

<div {{ $attributes->class(['border']) }}>
    <h1 {{ $heading->attributes->class(['text-lg']) }}>
        {{ $heading }}
    </h1>

    {{ $slot }}

    <footer {{ $footer->attributes->class(['text-gray-700']) }}>
        {{ $footer }}
    </footer>
</div>

内联组件视图

对于非常小的组件,同时管理组件类和组件的视图模板可能会感觉很繁琐。因此,你可以直接从 render 方法返回组件的标记:

php
/**
 * 获取表示组件的视图/内容。
 */
public function render(): string
{
    return <<<'blade'
        <div class="alert alert-danger">
            {{ $slot }}
        </div>
    blade;
}

生成内联视图组件

要创建一个渲染内联视图的组件,你可以在执行 make:component 命令时使用 inline 选项:

shell
php artisan make:component Alert --inline

动态组件

有时你可能需要渲染一个组件,但在运行时才知道应该渲染哪个组件。在这种情况下,你可以使用 Laravel 内置的 dynamic-component 组件根据运行时的值或变量来渲染组件:

blade
// $componentName = "secondary-button";

<x-dynamic-component :component="$componentName" class="mt-4" />

手动注册组件

WARNING

以下关于手动注册组件的文档主要适用于编写包含视图组件的 Laravel 包的开发者。如果你不是在编写包,组件文档的这部分可能与你无关。

在为你自己的应用编写组件时,组件会在 app/View/Components 目录和 resources/views/components 目录中被自动发现。

但是,如果你正在构建一个使用 Blade 组件的包或将组件放在非常规目录中,你需要手动注册组件类及其 HTML 标签别名,以便 Laravel 知道在哪里找到组件。你通常应该在包的 service provider 的 boot 方法中注册组件:

php
use Illuminate\Support\Facades\Blade;
use VendorPackage\View\Components\AlertComponent;

/**
 * 引导包的服务。
 */
public function boot(): void
{
    Blade::component('package-alert', AlertComponent::class);
}

注册组件后,可以使用其标签别名来渲染它:

blade
<x-package-alert/>

自动加载包组件

或者,你可以使用 componentNamespace 方法按约定自动加载组件类。例如,一个 Nightshade 包可能有 CalendarColorPicker 组件,它们位于 Package\Views\Components 命名空间中:

php
use Illuminate\Support\Facades\Blade;

/**
 * 引导包的服务。
 */
public function boot(): void
{
    Blade::componentNamespace('Nightshade\\Views\\Components', 'nightshade');
}

这将允许使用 package-name:: 语法通过其供应商命名空间来使用包组件:

blade
<x-nightshade::calendar />
<x-nightshade::color-picker />

Blade 会通过将组件名称转为 Pascal 大小写来自动检测链接到此组件的类。也支持使用「点」记法的子目录。

匿名组件

与内联组件类似,匿名组件提供了一种通过单个文件管理组件的机制。但是,匿名组件使用单个视图文件且没有关联的类。要定义匿名组件,你只需将 Blade 模板放在 resources/views/components 目录中。例如,假设你在 resources/views/components/alert.blade.php 定义了一个组件,你可以简单地这样渲染它:

blade
<x-alert/>

你可以使用 . 字符来表示组件嵌套在 components 目录的更深层。例如,假设组件定义在 resources/views/components/inputs/button.blade.php,你可以这样渲染它:

blade
<x-inputs.button/>

要通过 Artisan 创建匿名组件,你可以在调用 make:component 命令时使用 --view 标志:

shell
php artisan make:component forms.input --view

上面的命令将在 resources/views/components/forms/input.blade.php 创建一个 Blade 文件,可以通过 <x-forms.input /> 作为组件渲染。

匿名索引组件

有时,当一个组件由许多 Blade 模板组成时,你可能希望将给定组件的模板分组到单个目录中。例如,想象一个具有以下目录结构的 "accordion" 组件:

text
/resources/views/components/accordion.blade.php
/resources/views/components/accordion/item.blade.php

此目录结构允许你这样渲染 accordion 组件及其 item:

blade
<x-accordion>
    <x-accordion.item>
        ...
    </x-accordion.item>
</x-accordion>

但是,为了通过 x-accordion 渲染 accordion 组件,我们不得不将 "index" accordion 组件模板放在 resources/views/components 目录中,而不是将其嵌套在 accordion 目录中与其他 accordion 相关模板在一起。

值得庆幸的是,Blade 允许你将与组件目录名匹配的文件放在组件目录本身中。当此模板存在时,即使它嵌套在目录中,也可以作为组件的「根」元素渲染。因此,我们可以继续使用上面示例中给出的相同 Blade 语法;但是,我们将调整目录结构如下:

text
/resources/views/components/accordion/accordion.blade.php
/resources/views/components/accordion/item.blade.php

数据属性/Attributes

由于匿名组件没有任何关联的类,你可能想知道如何区分哪些数据应作为变量传递给组件,哪些属性应放在组件的属性包中。

你可以使用组件 Blade 模板顶部的 @props 指令来指定哪些属性应被视为数据变量。组件上的所有其他属性将通过组件的属性包可用。如果你希望给数据变量一个默认值,可以将变量名指定为数组键,将默认值指定为数组值:

blade
<!-- /resources/views/components/alert.blade.php -->

@props(['type' => 'info', 'message'])

<div {{ $attributes->merge(['class' => 'alert alert-'.$type]) }}>
    {{ $message }}
</div>

给定上面的组件定义,我们可以这样渲染组件:

blade
<x-alert type="error" :message="$message" class="mb-4"/>

访问父组件数据

有时你可能想在子组件中访问父组件的数据。在这种情况下,你可以使用 @aware 指令。例如,假设我们正在构建一个由父组件 <x-menu> 和子组件 <x-menu.item> 组成的复杂菜单组件:

blade
<x-menu color="purple">
    <x-menu.item>...</x-menu.item>
    <x-menu.item>...</x-menu.item>
</x-menu>

<x-menu> 组件可能有如下实现:

blade
<!-- /resources/views/components/menu/index.blade.php -->

@props(['color' => 'gray'])

<ul {{ $attributes->merge(['class' => 'bg-'.$color.'-200']) }}>
    {{ $slot }}
</ul>

因为 color prop 只传递给了父组件(<x-menu>),所以它在 <x-menu.item> 内部不可用。但是,如果我们使用 @aware 指令,也可以使其在 <x-menu.item> 内部可用:

blade
<!-- /resources/views/components/menu/item.blade.php -->

@aware(['color' => 'gray'])

<li {{ $attributes->merge(['class' => 'text-'.$color.'-800']) }}>
    {{ $slot }}
</li>

WARNING

@aware 指令无法访问未通过 HTML 属性显式传递给父组件的父级数据。未显式传递给父组件的默认 @props 值无法被 @aware 指令访问。

匿名组件路径

如前所述,匿名组件通常通过将 Blade 模板放在 resources/views/components 目录中来定义。但是,你有时可能希望在默认路径之外向 Laravel 注册其他匿名组件路径。

anonymousComponentPath 方法接受匿名组件位置的「路径」作为其第一个参数,以及组件应放在其下的可选「命名空间」作为其第二个参数。通常,应从应用的某个 service providerboot 方法中调用此方法:

php
/**
 * 引导任何应用服务。
 */
public function boot(): void
{
    Blade::anonymousComponentPath(__DIR__.'/../components');
}

如上例所示,当组件路径在注册时没有指定前缀时,它们也可以在 Blade 组件中不带相应前缀地渲染。例如,如果在上面注册的路径中存在 panel.blade.php 组件,可以这样渲染:

blade
<x-panel />

可以将前缀「命名空间」作为第二个参数提供给 anonymousComponentPath 方法:

php
Blade::anonymousComponentPath(__DIR__.'/../components', 'dashboard');

当提供了前缀时,该「命名空间」中的组件可以在渲染时通过在组件名称前加上组件的命名空间来渲染:

blade
<x-dashboard::panel />

构建布局

使用组件的布局

大多数 Web 应用在各个页面之间保持相同的通用布局。如果我们必须在创建的每个视图中重复整个布局 HTML,维护应用将会非常繁琐。值得庆幸的是,将此布局定义为单个 Blade 组件然后在整个应用中使用它是很方便的。

定义布局组件

例如,假设我们正在构建一个 "todo" 列表应用。我们可以定义一个如下所示的 layout 组件:

blade
<!-- resources/views/components/layout.blade.php -->

<html>
    <head>
        <title>{{ $title ?? 'Todo Manager' }}</title>
    </head>
    <body>
        <h1>Todos</h1>
        <hr/>
        {{ $slot }}
    </body>
</html>

应用布局组件

一旦定义了 layout 组件,我们就可以创建一个使用该组件的 Blade 视图。在这个例子中,我们将定义一个显示任务列表的简单视图:

blade
<!-- resources/views/tasks.blade.php -->

<x-layout>
    @foreach ($tasks as $task)
        <div>{{ $task }}</div>
    @endforeach
</x-layout>

请记住,注入到组件中的内容将提供给 layout 组件中的默认 $slot 变量。你可能已经注意到,如果提供了 $title 插槽,我们的 layout 也会使用它;否则,将显示默认标题。我们可以使用组件文档中讨论的标准插槽语法从任务列表视图注入自定义标题:

blade
<!-- resources/views/tasks.blade.php -->

<x-layout>
    <x-slot:title>
        Custom Title
    </x-slot>

    @foreach ($tasks as $task)
        <div>{{ $task }}</div>
    @endforeach
</x-layout>

现在我们已经定义了布局和任务列表视图,我们只需要从路由返回 task 视图:

php
use App\Models\Task;

Route::get('/tasks', function () {
    return view('tasks', ['tasks' => Task::all()]);
});

使用模板继承的布局

定义布局

布局也可以通过「模板继承」来创建。这是在引入组件之前构建应用的主要方式。

首先,让我们看一个简单的例子。我们将检查一个页面布局。由于大多数 Web 应用在各个页面之间保持相同的通用布局,将此布局定义为单个 Blade 视图是很方便的:

blade
<!-- resources/views/layouts/app.blade.php -->

<html>
    <head>
        <title>App Name - @yield('title')</title>
    </head>
    <body>
        @section('sidebar')
            This is the master sidebar.
        @show

        <div class="container">
            @yield('content')
        </div>
    </body>
</html>

如你所见,此文件包含典型的 HTML 标记。但是,请注意 @section@yield 指令。@section 指令,顾名思义,定义了一段内容,而 @yield 指令用于显示给定 section 的内容。

现在我们已经为应用定义了布局,让我们定义一个继承该布局的子页面。

继承布局

定义子视图时,使用 @extends Blade 指令来指定子视图应该「继承」哪个布局。继承 Blade 布局的视图可以使用 @section 指令向布局的 section 中注入内容。请记住,如上面的例子所示,这些 section 的内容将使用 @yield 在布局中显示:

blade
<!-- resources/views/child.blade.php -->

@extends('layouts.app')

@section('title', 'Page Title')

@section('sidebar')
    @@parent

    <p>This is appended to the master sidebar.</p>
@endsection

@section('content')
    <p>This is my body content.</p>
@endsection

在这个例子中,sidebar section 使用 @@parent 指令来追加(而不是覆盖)内容到布局的侧边栏。@@parent 指令将在视图渲染时被布局的内容替换。

NOTE

与前面的例子不同,这个 sidebar section 以 @endsection 结尾而不是 @show@endsection 指令只会定义一个 section,而 @show 会定义并立即输出该 section。

@yield 指令也接受一个默认值作为其第二个参数。如果被 yield 的 section 未定义,将渲染此值:

blade
@yield('content', 'Default content')

表单

CSRF 字段

每当你在应用中定义 HTML 表单时,都应该在表单中包含一个隐藏的 CSRF 令牌字段,以便 CSRF 保护 middleware 可以验证请求。你可以使用 @csrf Blade 指令来生成令牌字段:

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

    ...
</form>

Method 字段

由于 HTML 表单无法发出 PUTPATCHDELETE 请求,你需要添加一个隐藏的 _method 字段来伪造这些 HTTP 动词。@method Blade 指令可以为你创建此字段:

blade
<form action="/foo/bar" method="POST">
    @method('PUT')

    ...
</form>

验证错误

@error 指令可用于快速检查给定属性是否存在验证错误消息。在 @error 指令中,你可以输出 $message 变量来显示错误消息:

blade
<!-- /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

由于 @error 指令编译为 "if" 语句,你可以使用 @else 指令在属性没有错误时渲染内容:

blade
<!-- /resources/views/auth.blade.php -->

<label for="email">Email address</label>

<input
    id="email"
    type="email"
    class="@error('email') is-invalid @else is-valid @enderror"
/>

你可以将特定错误包的名称作为第二个参数传递给 @error 指令,以在包含多个表单的页面上检索验证错误消息:

blade
<!-- /resources/views/auth.blade.php -->

<label for="email">Email address</label>

<input
    id="email"
    type="email"
    class="@error('email', 'login') is-invalid @enderror"
/>

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

Stacks

Blade 允许你推送到命名栈,这些栈可以在另一个视图或布局中的其他地方渲染。这对于指定子视图所需的任何 JavaScript 库特别有用:

blade
@push('scripts')
    <script src="/example.js"></script>
@endpush

如果你希望在给定布尔表达式为 true@push 内容,你可以使用 @pushIf 指令:

blade
@pushIf($shouldPush, 'scripts')
    <script src="/example.js"></script>
@endPushIf

你可以根据需要多次推送到栈。要渲染完整的栈内容,将栈名传递给 @stack 指令:

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

    @stack('scripts')
</head>

如果你希望将内容前置到栈的开头,应该使用 @prepend 指令:

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

// Later...

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

@hasstack 指令可用于判断栈是否为空:

blade
@hasstack('list')
    <ul>
        @stack('list')
    </ul>
@endif

服务注入

@inject 指令可用于从 Laravel service container 中检索服务。传递给 @inject 的第一个参数是服务将被放入的变量名,第二个参数是你希望解析的服务的类名或接口名:

blade
@inject('metrics', 'App\Services\MetricsService')

<div>
    Monthly Revenue: {{ $metrics->monthlyRevenue() }}.
</div>

渲染内联 Blade 模板

有时你可能需要将原始 Blade 模板字符串转换为有效的 HTML。你可以使用 Blade facade 提供的 render 方法来完成此操作。render 方法接受 Blade 模板字符串和一个可选的数据数组提供给模板:

php
use Illuminate\Support\Facades\Blade;

return Blade::render('Hello, {{ $name }}', ['name' => 'Julian Bashir']);

Laravel 通过将内联 Blade 模板写入 storage/framework/views 目录来渲染它们。如果你希望 Laravel 在渲染 Blade 模板后删除这些临时文件,可以向方法提供 deleteCachedView 参数:

php
return Blade::render(
    'Hello, {{ $name }}',
    ['name' => 'Julian Bashir'],
    deleteCachedView: true
);

渲染 Blade 片段

当使用 Turbohtmx 等前端框架时,你有时可能只需要在 HTTP 响应中返回 Blade 模板的一部分。Blade「片段」允许你做到这一点。首先,将 Blade 模板的一部分放在 @fragment@endfragment 指令中:

blade
@fragment('user-list')
    <ul>
        @foreach ($users as $user)
            <li>{{ $user->name }}</li>
        @endforeach
    </ul>
@endfragment

然后,在渲染使用此模板的视图时,你可以调用 fragment 方法来指定只有指定的片段应包含在传出的 HTTP 响应中:

php
return view('dashboard', ['users' => $users])->fragment('user-list');

fragmentIf 方法允许你根据给定条件有条件地返回视图的片段。否则,将返回整个视图:

php
return view('dashboard', ['users' => $users])
    ->fragmentIf($request->hasHeader('HX-Request'), 'user-list');

fragmentsfragmentsIf 方法允许你在响应中返回多个视图片段。片段将被连接在一起:

php
view('dashboard', ['users' => $users])
    ->fragments(['user-list', 'comment-list']);

view('dashboard', ['users' => $users])
    ->fragmentsIf(
        $request->hasHeader('HX-Request'),
        ['user-list', 'comment-list']
    );

扩展 Blade

Blade 允许你使用 directive 方法定义自己的自定义指令。当 Blade 编译器遇到自定义指令时,它将使用指令包含的表达式调用提供的回调。

以下示例创建了一个 @datetime($var) 指令,它格式化给定的 $var,该变量应该是 DateTime 的实例:

php
<?php

namespace App\Providers;

use Illuminate\Support\Facades\Blade;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 注册任何应用服务。
     */
    public function register(): void
    {
        // ...
    }

    /**
     * 引导任何应用服务。
     */
    public function boot(): void
    {
        Blade::directive('datetime', function (string $expression) {
            return "<?php echo ($expression)->format('m/d/Y H:i'); ?>";
        });
    }
}

如你所见,我们将 format 方法链接到传入指令的任何表达式上。因此,在此示例中,此指令生成的最终 PHP 代码将是:

php
<?php echo ($var)->format('m/d/Y H:i'); ?>

WARNING

更新 Blade 指令的逻辑后,你需要删除所有缓存的 Blade 视图。可以使用 view:clear Artisan 命令删除缓存的 Blade 视图。

自定义 Echo 处理器

如果你尝试使用 Blade「echo」一个对象,将会调用该对象的 __toString 方法。__toString 方法是 PHP 内置的「魔术方法」之一。但是,有时你可能无法控制给定类的 __toString 方法,例如当你交互的类属于第三方库时。

在这些情况下,Blade 允许你为该特定类型的对象注册自定义 echo 处理器。为此,你应该调用 Blade 的 stringable 方法。stringable 方法接受一个闭包。该闭包应类型提示它负责渲染的对象类型。通常,stringable 方法应在应用的 AppServiceProvider 类的 boot 方法中调用:

php
use Illuminate\Support\Facades\Blade;
use Money\Money;

/**
 * 引导任何应用服务。
 */
public function boot(): void
{
    Blade::stringable(function (Money $money) {
        return $money->formatTo('en_GB');
    });
}

定义自定义 echo 处理器后,你可以简单地在 Blade 模板中 echo 该对象:

blade
Cost: {{ $money }}

自定义 If 语句

在定义简单的自定义条件语句时,编写自定义指令有时比必要的更复杂。因此,Blade 提供了 Blade::if 方法,允许你使用闭包快速定义自定义条件指令。例如,让我们定义一个检查应用配置的默认「磁盘」的自定义条件。我们可以在 AppServiceProviderboot 方法中完成此操作:

php
use Illuminate\Support\Facades\Blade;

/**
 * 引导任何应用服务。
 */
public function boot(): void
{
    Blade::if('disk', function (string $value) {
        return config('filesystems.default') === $value;
    });
}

定义自定义条件后,你可以在模板中使用它:

blade
@disk('local')
    <!-- 应用正在使用 local 磁盘... -->
@elsedisk('s3')
    <!-- 应用正在使用 s3 磁盘... -->
@else
    <!-- 应用正在使用其他磁盘... -->
@enddisk

@unlessdisk('local')
    <!-- 应用未使用 local 磁盘... -->
@enddisk