使用 Laravel 视图合成器

file

我最早使用 Laravel 工作的版本是 4.2 ，现在我仍然是它忠实的粉丝。当然，多年来我学到了很多，也遇到了很多问题、困难，但我仍然期待 Laravel 接下来会发生怎样的变化。

Laravel 提供的令人兴奋的功能之一就是视图扩展这个功能，在我看来，一个非常强大的视图扩展，允许开发将变量从全局精准的传递到模板。

怎样使用视图（View）扩展？

首先你必须要知道两种不同类型的视图扩展，即基于类和闭包。


<?php 
View::composer('profile', function ($view) {
    $view->with('user', ['...']);
});
// 或者
View::composer('profile', 'App\Http\ViewComposers\ProfileComposer');

差别非常的明显，闭包容易使用，且不需要投入太多精力去设置，但他们会导致该服务提供者（Service Provider）日渐臃肿。

另一方面，基于类的 视图扩展 引导你直接将设计原则分离出来，另一个好处是，您可以测试隔离的这段代码，其他开发人员可以更轻松的维护现有代码。

在计算机科学中，关注点分离（SoC）是将计算机程序分解成尽可能少地在功能上重叠的不同特征的过程，关注点是程序中的任何有意思的地方或者焦点。通常，关注点与特征或行为是同义词，传统上通过模块化和封装在信息隐藏的帮助下实现 SoC 的进步。

理解 View::composer 方法的参数

在这个例子中，你可以看到 View::composer 方法有两个参数。

<?php 
View::composer('profile', function ($view) {
    $view->with('user', ['...']);
});
// 或者
View::composer('profile', 'App\Http\ViewComposers\ProfileComposer');

第一个参数是你想要监听的视图的名字，可以是一个字符串或者数组。意思是，如果这个模板视图被渲染了，你的 视图管理器 就会被触发，并且传递变量到视图。

你也可以使用通配符而不是手动选择所有的模板，你可以方便地使用星号（*），将数据附加到每一个视图，甚至是有很多个子目录的复杂模板。

使用场景通常是需要在每个视图中展示的侧边栏或者导航元素。

<?php
// 为一个视图添加合成器: ~/resources/views/profile
View::composer('profile', ...);
// 为多个视图添加: ~/resources/views/profile, ~/resources/views/profile_edit and ~/resources/views/profile_settings
View::composer(['profile', 'profile_edit', 'profile_settings'], ...);
// 目录通配符: all files in ~/resources/views/pages/*
View::composer(['*pages.*'], ...);

第二个参数可以是闭包函数也可以是 view composer 的类名。

两种方法都接收一个 $view 参数，通过这个参数很简单地就能用 method ->with() 来往视图中增加变量。

<?php 
View::composer('*', function ($view) {
    $view->with('breadcrumb', ['item 1', 'item ']);
});
// 或者 
View::composer('*', 'App\Http\ViewComposers\NavigationComposer');
// compose 方法也有 $view 参数 
namespace App\Http\View\Composers;
use Illuminate\View\View;
class NavigationComposer
{
    /**
     * @param  View  $view
     * @return void
     */
    public function compose(View $view)
    {
        $view->with('navigation', [
            'items1', 'items2', 'item3'
        ]);
    }
}

设置视图合成器

你可能知道 Laravel 会使用提供者做很多事情，你就能猜到接下来的是什么？是的，我们必须注册一个服务提供者，在提供者内，使用我们刚刚学习的 视图合成器。

ViewComposerServiceProvider.php

<?php
namespace App\Providers;
use Illuminate\Support\Facades\View;
use Illuminate\Support\ServiceProvider;
class ViewComposerServiceProvider extends ServiceProvider
{
    public function boot()
    {
        View::composer(
            'pages/*', 'App\Http\View\Composers\NavigationComposer'
        );
    }
    /**
     * 注册服务提供者
     *
     * @return void
     */
    public function register()
    {
        // TODO: 实现 register() 方法。
    }
}

现在只剩下一件事情就是在 ~/config/app.php 中注册一个新的服务提供者。

<?php
return [
  'providers' => [
        // ....
        /*
         * 应用的服务提供者...
         */
        App\Providers\AppServiceProvider::class,
        App\Providers\AuthServiceProvider::class,
        App\Providers\EventServiceProvider::class,
        App\Providers\RouteServiceProvider::class,
        App\Providers\ViewComposerServiceProvider::class,

        // ....
    ],
];

就是这样，现在我们可以测试 视图合成器

测试视图编辑器

假设我们有一个名为 /detail 的页面，这个页面需要一个数组形式的导航数据（如下）。

<?php
namespace App\Http\View\Composers;
use Illuminate\View\View;
class NavigationComposer
{
    /**
     * @param  View  $view
     * @return void
     */
    public function compose(View $view)
    {
        $view->with('navigation', [
            'items1', 'items2', 'item3'
        ]);
    }
}

我们可以通过 ->assertViewHas(). 方法来测试我们的 试图编辑器 ，这个方法可以检测 视图编辑器 是否在监听右侧视图并把 $navigation 变量传递给它。

<?php
class ViewComposerTest extends TestCase
{
    /**
     * @return void
     */
    public function testDetailHasNavigationItems()
    {
        $this->get('/detail')->assertViewHas('navigation');
    }
}

虽然这个测试看起来很简单，但至少我们可以知道 视图编辑器 是否生效。