Mustache/README.markdown

Mustache.php

A Mustache implementation in PHP.

Usage

A quick example:

<?php
include('Mustache.php');
$m = new Mustache;
echo $m->render('Hello {{planet}}', array('planet' => 'World!'));
// "Hello World!"
?>

And a more in-depth example--this is the canonical Mustache template:

Hello {{name}}
You have just won ${{value}}!
{{#in_ca}}
Well, ${{taxed_value}}, after taxes.
{{/in_ca}}

Along with the associated Mustache class:

<?php
class Chris extends Mustache {
    public $name = "Chris";
    public $value = 10000;

    public function taxed_value() {
        return $this->value - ($this->value * 0.4);
    }

    public $in_ca = true;
}

Render it like so:

<?php
$c = new Chris;
echo $chris->render($template);
?>

Here's the same thing, a different way:

Create a view object--which could also be an associative array, but those don't do functions quite as well:

<?php
class Chris {
    public $name = "Chris";
    public $value = 10000;

    public function taxed_value() {
        return $this->value - ($this->value * 0.4);
    }

    public $in_ca = true;
}
?>

And render it:

<?php
$chris = new Chris;
$m = new Mustache;
echo $m->render($template, $chris);
?>

Known Issues

• Things get weird when you change delimiters inside a section -- delimiters example currently fails with an "unclosed section" exception.
• The current spec test exposes several whitespace bugs (which are mostly instances of the exact same whitespace bug) ... Despite these failing tests, this version is actually closer to correct than previous releases.

See Also

• Readme for the Ruby Mustache implementation.
• mustache(1) and mustache(5) man pages.