Allows you to use Twig seamlessly in Laravel.
Requirements
TwigBridge >= 0.13 supports Twig 3. If you need Twig 1/2 support, use the 0.12 versions.
Installation
Require this package with Composer
composer require rcrowe/twigbridge
Quick Start
Once Composer has installed or updated your packages you need to register TwigBridge with Laravel itself. Open up config/app.php and find the providers key, towards the end of the file, and add 'TwigBridge\ServiceProvider', to the end:
'providers' => [
...
TwigBridge\ServiceProvider::class,
],
Now find the aliases key, again towards the end of the file, and add 'Twig' => 'TwigBridge\Facade\Twig', to have easier access to the TwigBridge (or Twig\Environment):
'aliases' => [
...
'Twig' => TwigBridge\Facade\Twig::class,
],
Now that you have both of those lines added to config/app.php we will use Artisan to add the new twig config file:
php artisan vendor:publish --provider="TwigBridge\ServiceProvider"
At this point you can now begin using twig like you would any other view
//app/Http/routes.php
//twig template resources/views/hello.twig
Route::get('/', function () {
return View::make('hello');
});
You can create the twig files in resources/views with the .twig file extension.
resources/views/hello.twig
Configuration
Once Composer has installed or updated your packages you need to register TwigBridge with Laravel itself. Open up config/app.php and find the providers key towards the bottom and add:
'TwigBridge\ServiceProvider',
You can add the TwigBridge Facade, to have easier access to the TwigBridge (or Twig\Environment).
'Twig' => 'TwigBridge\Facade\Twig',
Twig::addExtension('TwigBridge\Extension\Loader\Functions');
Twig::render('mytemplate', $data);
TwigBridge's configuration file can be extended in your ConfigServiceProvider, under the twigbridge key. You can find the default configuration file at vendor/rcrowe/twigbridge/config.
You should use Artisan to copy the default configuration file from the /vendor directory to /config/twigbridge.php with the following command:
php artisan vendor:publish --provider="TwigBridge\ServiceProvider"
If you make changes to the /config/twigbridge.php file you will most likely have to run the twig:clean Artisan command for the changes to take effect.
Installation on Lumen
For Lumen, you need to load the same Service Provider, but you have to disable the Auth, Translator and Url extensions in your local configuration. Copy the config/twigbridge.php file to your local config folder and register the configuration + Service Provider in bootstrap/app.php:
$app->configure('twigbridge');
$app->register('TwigBridge\ServiceProvider');
Usage
You call the Twig template like you would any other view:
// Without the file extension
View::make('i_am_twig', [...])
TwigBridge also supports views in other packages:
View::make('pagination::simple')
The above rules continue when extending another Twig template:
{% extends "parent" %}
{% extends "pagination::parent" %}
You can call functions with parameters:
{{ link_to_route('tasks.edit', 'Edit', task.id, {'class': 'btn btn-primary'}) }}
And output variables, escaped by default. Use the raw filter to skip escaping.
{{ some_var }}
{{ html_var | raw }}
{{ long_var | str_limit(50) }}
Extensions
Sometimes you want to extend / add new functions for use in Twig templates. Add to the enabled array in config/twigbridge.php a list of extensions for Twig to load.
'enabled' => array(
'TwigBridge\Extensions\Example'
)
TwigBridge supports both a string or a closure as a callback, so for example you might implement the Assetic Twig extension as follows:
'enabled' => [
function($app) {
$factory = new Assetic\Factory\AssetFactory($app['path'].'/../some/path/');
$factory->setDebug(false);
// etc.....
return new Assetic\Extension\Twig\AsseticExtension($factory);
}
]
TwigBridge comes with the following extensions enabled by default:
- 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
To enable '0.5.x' style Facades, enable the Legacy Facades extension:
- TwigBridge\Extension\Laravel\Legacy\Facades
FilterLoader and FunctionLoader
These loader extensions exposes Laravel helpers as both Twig functions and filters.
Check out the config/twigbridge.php file to see a list of defined function / filters. You can also add your own.
FacadeLoader
The FacadeLoader extension allows you to call any facade you have configured in config/twigbridge.php. This gives your Twig templates integration with any Laravel class as well as any other classes you alias.
To use the Laravel integration (or indeed any aliased class and method), just add your facades to the config and call them like URL.to(link) (instead of URL::to($link))
Functions/Filters/Variables
The following helpers/filters are added by the default Extensions. They are based on the helpers and/or facades, so should be self explaining.
Functions:
- asset, action, url, route, secure_url, secure_asset
- auth_check, auth_guest, auth_user
- can
- config_get, config_has
- dump
- form_* (All the Form::* methods, snake_cased)
- html_* (All the Html::* methods, snake_cased)
- 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_* (All the Str::* methods, snake_cased)
- trans, trans_choice
- url_* (All the URL::* methods, snake_cased)
Filters:
- camel_case, snake_case, studly_case
- str_* (All the Str::* methods, snake_cased)
- trans, trans_choice
Global variables:
- app: the Illuminate\Foundation\Application object
- errors: The $errors MessageBag from the Validator (always available)
Artisan Commands
TwigBridge offers a command for CLI Interaction.
Empty the Twig cache:
$ php artisan twig:clean
Lint all Twig templates:
$ php artisan twig:lint
![Closes #388 [2]](https://avatars.githubusercontent.com/u/1788397?v=4)
![[0.7] Update for Laravel 5.x](https://avatars.githubusercontent.com/u/973269?v=4)
![[Question] Laravel8 + TwigBridge + GraphQL Twig extension -- example or available package?](https://avatars.githubusercontent.com/u/80013879?v=4)
118 Dec 21, 2022
48 Dec 29, 2022
1 Aug 23, 2022
18 Dec 4, 2022
866 Jan 30, 2022
77 Oct 27, 2022
1.6k Dec 30, 2022
509 Dec 30, 2022
220 Dec 25, 2022
87 Nov 26, 2022
59 Sep 25, 2022
27 Mar 2, 2022
9 Sep 17, 2022
3 Jul 27, 2022
152 Dec 15, 2022
25 Dec 22, 2022
10 Nov 20, 2022
15 Dec 29, 2022
7 Nov 15, 2022