rcrowe / twigbridge
Adds the power of Twig to Laravel
Installs: 4 833 478
Dependents: 60
Suggesters: 7
Security: 0
Stars: 895
Watchers: 46
Forks: 166
Open Issues: 103
Requires
- php: ^8.1
- illuminate/support: ^9|^10|^11
- illuminate/view: ^9|^10|^11
- twig/twig: ~3.9
Requires (Dev)
- ext-json: *
- laravel/framework: ^9|^10|^11
- mockery/mockery: ^1.3.1
- phpunit/phpunit: ^8.5.8 || ^9.3.7
- squizlabs/php_codesniffer: ^3.6
- dev-master / 0.14.x-dev
- v0.14.3
- v0.14.2
- v0.14.1
- v0.14.0
- v0.13.1
- v0.13.0
- 0.12.x-dev
- v0.12.4
- v0.12.3
- v0.12.2
- v0.12.1
- v0.12.0
- 0.11.x-dev
- v0.11.4
- v0.11.3
- v0.11.2
- v0.11.1
- v0.11.0
- 0.10.x-dev
- 0.9.x-dev
- v0.9.12
- v0.9.11
- v0.9.10
- v0.9.9
- v0.9.8
- v0.9.7
- v0.9.6
- v0.9.5
- v0.9.4
- v0.9.3
- v0.9.2
- v0.9.1
- v0.9.0
- v0.8.2
- v0.8.1
- v0.8.0
- v0.7.2
- v0.7.1
- v0.7.0
- 0.6.x-dev
- v0.6.2
- v0.6.1
- 0.6.0
- 0.6.0-beta3
- 0.6.0-beta2
- 0.6.0-beta1
- v0.5.5
- 0.5.4
- 0.5.3
- 0.5.2
- 0.5.1
- 0.5.0
- 0.4.1
- 0.4.0
- 0.3.1
- 0.3.0
- 0.2.6
- 0.2.5
- 0.2.4
- 0.2.3
- 0.2.2
- 0.2.1
- 0.2.0
- v0.1.12
- v0.1.11
- 0.1.10
- v0.1.9
- v0.1.8
- v0.1.7
- v0.1.6
- v0.1.5
- v0.1.4
- v0.1.3
- v0.1.2
- v0.1.1
- 0.1.0
- v0.0.7
- v0.0.6
- v0.0.5
- v0.0.4
- v0.0.3
- v0.0.2
- v0.0.1
- dev-feat-yield
- dev-feat-core-extension
- dev-laravel11
- dev-revert-294-twig_127
This package is auto-updated.
Last update: 2024-12-15 14:17:17 UTC
README
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
Laravel automatically registers the Service Provider. Use Artisan to publish the 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