ibn-dev-support/twigbridge

为 Laravel 增强了 Twig 的功能

1.0.0 2022-06-26 06:49 UTC

This package is auto-updated.

Last update: 2024-09-26 12:13:31 UTC


README

允许您在 Laravel 5 中无缝使用 Twig

Latest Stable Version Total Downloads License

需求

TwigBridge >=0.7 需要 Laravel 5。

如果您需要支持 Laravel 4.1/4.2,请查看 TwigBridge 0.6.x 版本,或 Laravel 4.0 的 0.5.x 版本。

安装

使用 Composer 安装此包

composer require ibn-dev-support/twigbridge

快速入门

一旦 Composer 安装或更新了您的包,您需要将 TwigBridge 注册到 Laravel 本身。打开 config/app.php,找到 providers 键,文件末尾,并添加 'TwigBridge\ServiceProvider' 到末尾

'providers' => [
     ...
                TwigBridge\ServiceProvider::class,
],

现在找到 aliases 键,再次在文件末尾,并添加 'Twig' => 'TwigBridge\Facade\Twig' 以便更容易访问 TwigBridge(或 Twig_Environment)

'aliases' => [
    ... 
                'Twig' => TwigBridge\Facade\Twig::class,
],

现在我们已将这两行添加到 config/app.php 中,我们将使用 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,但您必须禁用本地配置中的 AuthTranslatorUrl 扩展。将 config/twigbridge.php 文件复制到您的本地 config 文件夹,并在 bootstrap/app.php 中注册配置和服务提供程序

$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 数组中添加一个要加载的扩展列表。

'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_Debug
  • TwigBridge\Extension\Laravel\Auth
  • TwigBridge\Extension\Laravel\Config
  • TwigBridge\Extension\Laravel\Dump
  • TwigBridge\Extension\Laravel\Form
  • TwigBridge\Extension\Laravel\Html
  • TwigBridge\Extension\Laravel\Input
  • TwigBridge\Extension\Laravel\Session
  • TwigBridge拓展\String
  • TwigBridge拓展\Laravel\Translator
  • TwigBridge拓展\Laravel\Url
  • TwigBridge拓展\Loader\Facades
  • TwigBridge拓展\Loader\Filters
  • TwigBridge拓展\Loader\Functions

要启用'0.5.x'风格的Facades,请启用Legacy Facades扩展

  • TwigBridge拓展\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
  • 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:来自验证器的$messages MessageBag(始终可用)

Artisan命令

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

清空Twig缓存

$ php artisan twig:clean

检查所有Twig模板

$ php artisan twig:lint