Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rcrowe/TwigBridge
Give the power of Twig to Laravel
https://github.com/rcrowe/TwigBridge
Last synced: 29 days ago
JSON representation
Give the power of Twig to Laravel
- Host: GitHub
- URL: https://github.com/rcrowe/TwigBridge
- Owner: rcrowe
- License: mit
- Created: 2012-11-23T22:56:25.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T09:04:15.000Z (8 months ago)
- Last Synced: 2024-05-22T03:03:19.141Z (7 months ago)
- Language: PHP
- Homepage:
- Size: 619 KB
- Stars: 891
- Watchers: 47
- Forks: 165
- Open Issues: 102
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-php-cn - rcrowe/TwigBridge - Twig 模板引擎支持. (目录 / 模板 Templating)
README
Allows you to use [Twig](http://twig.sensiolabs.org/) seamlessly in [Laravel](http://laravel.com/).
[](https://packagist.org/packages/rcrowe/twigbridge)
[](https://packagist.org/packages/rcrowe/twigbridge)
[](https://github.com/rcrowe/TwigBridge/actions/workflows/ci.yml)
[](https://packagist.org/packages/rcrowe/twigbridge)
# 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
```bash
composer require rcrowe/twigbridge
```
# Quick Start
Laravel automatically registers the Service Provider. Use Artisan to publish the twig config file:
```php
php artisan vendor:publish --provider="TwigBridge\ServiceProvider"
```
At this point you can now begin using twig like you would any other view
```php
//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.
```bash
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:
```php
'TwigBridge\ServiceProvider',
```
You can add the TwigBridge Facade, to have easier access to the TwigBridge (or Twig\Environment).
```php
'Twig' => 'TwigBridge\Facade\Twig',
```
```php
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:
```bash
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`:
```php
$app->configure('twigbridge');
$app->register('TwigBridge\ServiceProvider');
```
# Usage
You call the Twig template like you would any other view:
```php
// Without the file extension
View::make('i_am_twig', [...])
```
TwigBridge also supports views in other packages:
```php
View::make('pagination::simple')
```
The above rules continue when extending another Twig template:
```html
{% extends "parent" %}
{% extends "pagination::parent" %}
```
You can call functions with parameters:
```html
{{ 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.
```html
{{ 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.
```php
'enabled' => array(
'TwigBridge\Extensions\Example'
)
```
TwigBridge supports both a string or a closure as a callback, so for example you might implement the [Assetic](https://github.com/kriswallsmith/assetic) Twig extension as follows:
```php
'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](http://twig.sensiolabs.org/doc/extensions/debug.html)
- 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
```