https://github.com/brightmachine/laratash
A Laravel wrapper for mustache.php, a PHP implementation of http://mustache.github.io/
https://github.com/brightmachine/laratash
Last synced: 8 months ago
JSON representation
A Laravel wrapper for mustache.php, a PHP implementation of http://mustache.github.io/
- Host: GitHub
- URL: https://github.com/brightmachine/laratash
- Owner: brightmachine
- License: mit
- Created: 2014-09-20T10:32:09.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-12-12T11:23:42.000Z (over 8 years ago)
- Last Synced: 2025-08-16T12:44:37.920Z (10 months ago)
- Language: PHP
- Size: 16.6 KB
- Stars: 12
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
laratash
========
A Laravel wrapper for mustache.php, a PHP implementation of http://mustache.github.io/
# Acknowledgements
This project is based entirely on the the [mustache-l4](https://github.com/conarwelsh/mustache-l4) package
by Conar Welsh and contributors.
## Supports
- `Laravel 5`
- `mustache/mustache 2.7+`
# Installation
Add laratash as a dependency to your `composer.json` file:
```json
"require": {
"laravel/framework": "~5.0",
"brightmachine/laratash": "~5.0"
}
```
run `composer update`, or `composer install` if this is a brand new project
## Add the Service Provider
Open: `config/app.php`
```php
...
'Laratash\LaratashServiceProvider',
...
```
You are all setup!
# Usage
Laratash is merely a wrapper for the [Mustache.php](https://github.com/bobthecow/mustache.php) library that integrates it into Laravel 5+.
Laratash registers itself with the Laravel View class, providing seamless integration with Laravel. You can use Mustache just as you would Blade!
The Laravel View class will choose the right template engine to use based on the file extension of the view. So all you have to do to render Mustache files, is ensure that your view has a `.mustache` file extension. Laratash will take care of the rest.
You can even mix and match template engines. For instance maybe you have a Blade layout file, and you want to nest a Mustache view, that's fine! However just be aware of the fact that Mustache does not understand Block Sections like Blade does.
The Mustache view will be rendered into a variable named whatever section you passed the view to. So for example if you were to do:
```php
$view->nest('content', 'some.view');
$view->nest('sidebar', 'some.sidebar');
```
The contents of the parsed `some.view` file will be available in the template file under a variable called `$content`.
The contents of the parsed `some.sidebar` would be available in the template file, under a variable called `$sidebar`.
By default, Mustache partials are also loaded using Laravel's ViewFinder, so you can feel free to use dot-notation to specify a view.
```html
{{#posts}}
{{> posts._post}}
{{/posts}}
```
Other than that it is business as usual!
# Examples:
- Example using View::make()
app/views/test.mustache
{{ pageHeading }}
{{ pageContent }}
app/router.php
Route::get('/', function()
{
return View::make('test', array(
'pageHeading' => 'Rendered with Mustache.php',
'pageContent' => 'But still looks like Laravel!'
));
});
- Example using a Blade controller layout
app/views/layouts/master.blade.php
{{-- since Mustache does not use sections, the nested section will instead
be rendered as a variable --}}
{{ content }}
app/views/test.mustache
{{ pageHeading }}
{{ pageContent }}
app/controllers/TestController.php
layout->nest('content', 'test', array(
'pageHeading' => 'Rendered with Mustache.php',
'pageContent' => 'But still looks like Laravel!'
));
}
}
- Example using a Mustache layout
app/views/posts/_post.mustache
{{ title }}
{{ content }}
app/views/blog/index.mustache
My Blog
{{#posts}}
{{> posts._post}}
{{/posts}}
app/routes.php
Route::get('/', function()
{
$posts = array(
array(
'title' => 'This is a Title',
'content' => 'lorem ipsum...'
),
array(
'title' => 'This is a another title',
'content' => 'lorem ipsum...'
),
array(
'title' => 'This is yet another Title',
'content' => 'lorem ipsum...'
),
);
return View::make('blog.index', compact('posts));
});
## A note on template data
Laravel expects [view data](http://laravel.com/docs/5.0/views#basic-usage) to be be passed as an `array`.
Mustache PHP, however, also allows a Context object to be used.
If you wish to use a Context object, pass through an array with a `__context` key and this will be used. E.g.
`return view('my.view', ['__context' => new Context]);`
# Configure
You can alter the configuration options that are passed to Mustache.php in your `ConfigServiceProvider`. E.g.
config([
'laratash.cache' => storage_path() . '/framework/views/mustache',
]);
All `laratash.` options are passed directly to the Mustache_Engine constructor, so you can use any of the options that you would use with [Mustache.php](https://github.com/bobthecow/mustache.php)