README

允许您无缝地在 Laravel 中使用 Twig。

要求

TwigBridge >= 0.13 支持 Twig 3。如果您需要 Twig 1/2 支持，请使用 0.12 版本。

安装

使用 Composer 需要此包

composer require rcrowe/twigbridge

快速开始

Laravel 会自动注册 Service Provider。使用 Artisan 发布 twig 配置文件

php artisan vendor:publish --provider="TwigBridge\ServiceProvider"

到此为止，您现在可以像使用任何其他视图一样使用 twig 了

//app/Http/routes.php
//twig template resources/views/hello.twig
Route::get('/', function () {
    return View::make('hello');
});

您可以在 resources/views 中创建扩展名为 .twig 的 twig 文件。

resources/views/hello.twig

配置

一旦 Composer 安装或更新了您的包，您需要将 TwigBridge 注册到 Laravel 本身。打开 config/app.php 并找到底部的 providers 键，然后添加

'TwigBridge\ServiceProvider',

您可以添加 TwigBridge Facade，以便更容易地访问 TwigBridge（或 Twig\Environment）。

'Twig' => 'TwigBridge\Facade\Twig',

Twig::addExtension('TwigBridge\Extension\Loader\Functions');
Twig::render('mytemplate', $data);

您可以在 ConfigServiceProvider 下的 twigbridge 键扩展 TwigBridge 的配置文件。默认配置文件位于 vendor/rcrowe/twigbridge/config。

您应该使用 Artisan 使用以下命令将默认配置文件从 /vendor 目录复制到 /config/twigbridge.php

php artisan vendor:publish --provider="TwigBridge\ServiceProvider"

如果您更改了 /config/twigbridge.php 文件，您可能需要运行 twig:clean Artisan 命令以使更改生效。

Lumen 上的安装

对于 Lumen，您需要加载相同的 Service Provider，但您必须在本地配置中禁用 Auth、Translator 和 Url 扩展。将 config/twigbridge.php 文件复制到您的本地 config 文件夹，并在 bootstrap/app.php 中注册配置 + Service Provider

$app->configure('twigbridge');
$app->register('TwigBridge\ServiceProvider');

使用

您会像调用任何其他视图一样调用 Twig 模板

// Without the file extension
View::make('i_am_twig', [...])

TwigBridge 也支持其他包中的视图

View::make('pagination::simple')

在扩展另一个 Twig 模板时，上述规则继续适用

{% extends "parent" %}
{% extends "pagination::parent" %}

您可以调用带参数的函数

{{ link_to_route('tasks.edit', 'Edit', task.id, {'class': 'btn btn-primary'}) }}

并输出变量，默认情况下已转义。使用 raw 过滤器以跳过转义。

{{ some_var }}
{{ html_var | raw }}
{{ long_var | str_limit(50) }}

扩展

有时您想在 Twig 模板中使用扩展 / 添加新函数。将扩展列表添加到 config/twigbridge.php 中的 enabled 数组中，以供 Twig 加载。

'enabled' => array(
    'TwigBridge\Extensions\Example'
)

TwigBridge 支持字符串或闭包作为回调，因此例如，您可能像以下那样实现 Assetic Twig 扩展

'enabled' => [
    function($app) {
        $factory = new Assetic\Factory\AssetFactory($app['path'].'/../some/path/');
        $factory->setDebug(false);
        // etc.....
        return new Assetic\Extension\Twig\AsseticExtension($factory);
    }
]

TwigBridge 默认启用以下扩展

• Twig\Extension\DebugExtension
• TwigBridge\Extension\Laravel\Auth
• TwigBridge\Extension\Laravel\Config
• TwigBridge\Extension\Laravel\Dump
• TwigBridge\Extension\Laravel\Form
• TwigBridge\Extension\Laravel\Gate
• TwigBridge\Extension\Laravel\Html
• TwigBridge\Extension\Laravel\Input
• TwigBridge\Extension\Laravel\Session
• TwigBridge\Extension\Laravel\String
• TwigBridge\Extension\Laravel\Translator
• TwigBridge\Extension\Laravel\Url
• TwigBridge\Extension\Loader\Facades
• TwigBridge\Extension\Loader\Filters
• TwigBridge\Extension\Loader\Functions

要启用 '0.5.x' 样式的 Facades，请启用 Legacy Facades 扩展

• TwigBridge\Extension\Laravel\Legacy\Facades

FilterLoader 和 FunctionLoader

这些加载扩展将 Laravel 辅助函数作为 Twig 函数和过滤器公开。

查看 config/twigbridge.php 文件以查看定义的函数 / 过滤器的列表。您也可以添加自己的。

FacadeLoader

FacadeLoader 扩展允许您调用配置在 config/twigbridge.php 中的任何 facade。这使您的 Twig 模板能够与任何 Laravel 类以及任何其他别名类进行集成。

要使用 Laravel 集成（或任何别名类和方法），只需将您的 facade 添加到配置中，并像这样调用它们：URL.to(link)（而不是 URL::to($link)）

函数/过滤器/变量

以下默认扩展添加的帮助器/过滤器。它们基于帮助器和/或 facade，因此应该很容易理解。

函数

• asset, action, url, route, secure_url, secure_asset
• auth_check, auth_guest, auth_user
• can
• config_get, config_has
• dump
• form_* (所有 Form::* 方法，蛇形命名)
• html_* (所有 Html::* 方法，蛇形命名)
• input_get, input_old, input_has
• link_to, link_to_asset, link_to_route, link_to_action
• session_has, session_get, csrf_token, csrf_field, method_field
• str_* (所有 Str::* 方法，蛇形命名)
• trans, trans_choice
• url_* (所有 URL::* 方法，蛇形命名)

过滤器

• camel_case, snake_case, studly_case
• str_* (所有 Str::* 方法，蛇形命名)
• trans, trans_choice

全局变量

• app: Illuminate\Foundation\Application 对象
• errors: 验证器中的 $errors MessageBag（始终可用）

Artisan 命令

TwigBridge 提供了一个用于 CLI 交互的命令。

清空 Twig 缓存

$ php artisan twig:clean

检查所有 Twig 模板

$ php artisan twig:lint