oscarpalmer/yogurt

A tiny templating engine.

Yogurt

, _(*1)

Yogurt is a template language for PHP (>=5.3) inspired by Beach's Hammer. Hammer's syntax was based on regular ol' HTML comment tags, so you won't have to install another syntax highlighter for your editor. Nice, huh?, _(*2)

Getting started

Installation

Yogurt is available via Composer., _(*3)

{
  "require": {
    "oscarpalmer/yogurt": "1.*"
  }
}

Basic usage

use oscarpalmer\Yogurt\Yogurt;

$yogurt = new Yogurt("./directory/for/templates", "template-extension");

$flavour = $yogurt->flavour("my-template");
# Or $flavour = new Flavour($yogurt, "my-template");

$flavour->data(array(
  "title" => "My Title"
));

$flavour->tagline = "My tagline.";

echo $flavour->taste();
# Or just echo $flavour;

Syntax

The syntax is based on regular HTML comments and the control structures (if and foreach) are based on Twig's syntax, so it shouldn't be too difficult to learn., _(*4)

Variables

<p><!-- variable --></p>
<p><!-- chaining.variables.works.too --></p>

variable is a direct child of the data object ($flavour->data();), and the chaining.variables.works.too is a nested child of multiple arrays or objects inside the data object., _(*5)

Variables should be of the scalar type, i.e. boolean, float, integer, or string. If not, PHP will scream., _(*6)

Variable modifiers

<p><!-- variable ~ escape --></p>

Variables can be modified, too., _(*7)

• dump: dumps the variable with var_dump.
• escape: escapes bad characters, e.g. tags.
• json: transforms anything into valid JSON markup.
• lowercase: converts the string to a lowercase version of it.
• trim: trims the string of leading and trailing whitespace.
• uppercase: converts the string to an uppercase version of it.

Including other files

<!-- include file.html -->
<!-- include file -->

Yogurt will then attempt to find the file in the directory supplied to Yogurt as shown in the "Getting started" example; the second one will automatically append the supplied file extension., _(*8)

Looping

<!-- for item in items -->
<p><!-- item --></p>
<!-- endfor -->

items should be an array or object, but item can be whatever; just remember to chain names to access the item's children if it isn't scalar, like this: item.title., _(*9)

Indexes

When looping, sometimes you need to know the index of the item – i.e. its place in the array or object. The item's index can be accessed by appending _index to the array or object's name, e.g. array_index for an array named array., _(*10)

Ifs and else-ifs

Title exists., (*11)







Page is "some-page"., (*12)





Number is "1234"., (*13)





This is pretty cool., (*14)

Supported comparison operators are ===, ==, !==, !=, >=, <=, <>, >, <, is, and isnt. is and isnt will be turned into == and != respectively., _(*15)

Values can be scalar, null, or variables. boolean, float, integer, and null values can be wrapped in quotation marks, but don't necessarily need them., _(*16)

Strings however, do need quotation marks; if they're not wrapped in quotation marks, they're assumed to be variables., _(*17)

Todo

• More string modifiers.
• Adding and removing custom modifier functions.
• Adding and removing custom parsers functions?
• Caching?

License

MIT Licensed; see the LICENSE file for more info., _(*18)