Merge branch 'dev'

Author: dmolsen

README.md

@@ -0,0 +1,49 @@
+# Twig PatternEngine for Pattern Lab PHP
+
+The Twig PatternEngine allows you to use [Twig](http://twig.sensiolabs.org) as the template language for Pattern Lab PHP. Once the PatternEngine is installed you can use Twig-based StarterKits and StyleguideKits.
+
+## Installation
+
+Pattern Lab PHP uses [Composer](https://getcomposer.org/) to manage project dependencies. To install the Twig PatternEngine:
+
+    composer require pattern-lab/patternengine-twig
+
+## Available Loaders
+
+If you're building a plugin that will be parsing Twig files you have access to three loaders. It's recommended that you use these instead of accessing Twig directly as these loaders will work with other PatternEngines.
+
+### The String Loader
+
+The string loader takes a simple string and compiles it. To use:
+
+```php
+$data         = array("hello" => "world");
+$string       = "If I say hello you say {{ hello }}.";
+$stringLoader = \PatternLab\Template::getStringLoader();
+$output       = $stringLoader->render(array("string" => $string, "data" => $data));
+print $output; // outputs "If I say hello you say world."
+```
+
+### The Filesystem Loader
+
+The filesystem loader will look for templates in the configured StyleguideKit directory and compile them. The template location for the filesystem loader can't be modified. To use:
+
+```php
+$data             = array(...);
+$filesystemLoader = \PatternLab\Template::getFilesystemLoader();
+$output           = $filesystemLoader->render(array("template" => "viewall", "data" => $data));
+print $output; // outputs the viewall view from the configured styleguidekit
+```
+
+### The Pattern Loader
+
+The pattern loader looks for patterns and allows the use of the Pattern Lab-specific partial syntax. To use:
+
+```php
+$data                  = array(...);
+$patternPath           = "path/to/pattern";
+$patternEngineBasePath = \PatternLab\PatternEngine::getInstance()->getBasePath();
+$patternLoaderClass    = $patternEngineBasePath."\Loaders\PatternLoader";
+$patternLoader         = new $patternLoaderClass($options);
+$code                  = $patternLoader->render(array("pattern" => $patternPath, "data" => $data));
+print $output; // outputs the given pattern

src/PatternLab/PatternEngine/Twig/Loaders/FilesystemLoader.php

@@ -34,7 +34,7 @@ public function __construct($options = array()) {
 	*/
 	public function render($options = array()) {
 
-		return $this->instance->render($options["template"], $options["data"]);
+		return $this->instance->render($options["template"].".twig", $options["data"]);
 
 	}
 

src/PatternLab/PatternEngine/Twig/Loaders/Twig/PatternLoader.php

@@ -11,7 +11,7 @@
  *
  */
 
-namespace PatternLab\TwigPatternEngine;
+namespace PatternLab\PatternEngine\Twig\Loaders\Twig;
 
 use \PatternLab\PatternEngine\Util;