conarwelsh/mustache-l4

A Mustache.php wrapper for Laravel 4

Installs: 8 710

Dependents: 1

Stars: 37

Watchers: 5

Forks: 24

Open Issues: 4

Language: PHP

dev-master 2013-10-02 15:21 UTC

README

A Mustache.php wrapper for Laravel 4

Install

Add mustache-l4 as a dependency to your composer.json file

"require": {
    "laravel/framework": "4.0.*",
    "conarwelsh/mustache-l4": "dev-master"
}

run composer update, or composer install if this is a brand new project

Add the Service Provider

app/config/app.php

...

'Conarwelsh\MustacheL4\MustacheL4ServiceProvider',

...

You are all setup!

Usage

Mustache-L4 is merely a wrapper for the Mustache.php library that integrates it into Laravel 4.

Mustache-L4 registers itself with the Laravel View class, providing seemless integration with Laravel. You can use Mustache just as you would Blade! The Laravel View class will choose the right templating 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. Mustache-L4 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, thats 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:

$this->layout->nest('content', 'some.view');
$this->layout->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 availble 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.

{{#posts}}
    {{> posts._post}}
{{/posts}}

Other than that it is business as usual!

Examples:

  • Example using View::make()

    app/views/test.mustache

    <h1>{{ pageHeading }}</h1>
    <div>
        {{ pageContent }}
    </div>
    

    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

    <html>
    <head></head>
    <body>
        {{-- since Mustache does not use sections, the nested section will instead
        be rendered as a variable --}}
        {{ content }}
    </body>
    </html>
    

    app/views/test.mustache

    <h1>{{ pageHeading }}</h1>
    <div>
        {{ pageContent }}
    </div>
    

    app/controllers/TestController.php

    <?php
    
    class TestController extends BaseController {
    
        public $layout = 'layouts.master';
    
        public function index()
        {
        $this->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

    <article>
        <h2>{{ title }}</h2>
        <div>
            {{ content }}
        </div>
    </article>
    

    app/views/blog/index.mustache

    <html>
    <head></head>
    <body>
        <h1>My Blog</h1>
    
        {{#posts}}
            {{> posts._post}}
        {{/posts}}
    </body>
    </html>
    

    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));
    });
    

Configure

You can alter the configuration options that are passed to Mustache.php by publishing the config file.

php artisan config:publish conarwelsh/mustache-l4

All options in this config file are passed directly to the Mustache_Engine constructor, so you can use any of the options that you would use with Mustache.php