diff options
| author | Simon Rettberg | 2015-03-02 16:51:04 +0100 |
|---|---|---|
| committer | Simon Rettberg | 2015-03-02 16:51:04 +0100 |
| commit | ab23338fe9f1b3ed21455867f1c032d7b146ceb8 (patch) | |
| tree | 33d27fd848e25ae24a57b309348b5d73a811f223 /Mustache/Template.php | |
| download | bwlp-webadmin-ab23338fe9f1b3ed21455867f1c032d7b146ceb8.tar.gz bwlp-webadmin-ab23338fe9f1b3ed21455867f1c032d7b146ceb8.tar.xz bwlp-webadmin-ab23338fe9f1b3ed21455867f1c032d7b146ceb8.zip | |
Initial Commit
Diffstat (limited to 'Mustache/Template.php')
| -rw-r--r-- | Mustache/Template.php | 149 |
1 files changed, 149 insertions, 0 deletions
diff --git a/Mustache/Template.php b/Mustache/Template.php new file mode 100644 index 0000000..ebb9df8 --- /dev/null +++ b/Mustache/Template.php @@ -0,0 +1,149 @@ +<?php
+
+/*
+ * This file is part of Mustache.php.
+ *
+ * (c) 2012 Justin Hileman
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Abstract Mustache Template class.
+ *
+ * @abstract
+ */
+abstract class Mustache_Template
+{
+
+ /**
+ * @var Mustache_Engine
+ */
+ protected $mustache;
+
+ /**
+ * Mustache Template constructor.
+ *
+ * @param Mustache_Engine $mustache
+ */
+ public function __construct(Mustache_Engine $mustache)
+ {
+ $this->mustache = $mustache;
+ }
+
+ /**
+ * Mustache Template instances can be treated as a function and rendered by simply calling them:
+ *
+ * $m = new Mustache_Engine;
+ * $tpl = $m->loadTemplate('Hello, {{ name }}!');
+ * echo $tpl(array('name' => 'World')); // "Hello, World!"
+ *
+ * @see Mustache_Template::render
+ *
+ * @param mixed $context Array or object rendering context (default: array())
+ *
+ * @return string Rendered template
+ */
+ public function __invoke($context = array())
+ {
+ return $this->render($context);
+ }
+
+ /**
+ * Render this template given the rendering context.
+ *
+ * @param mixed $context Array or object rendering context (default: array())
+ *
+ * @return string Rendered template
+ */
+ public function render($context = array())
+ {
+ return $this->renderInternal($this->prepareContextStack($context));
+ }
+
+ /**
+ * Internal rendering method implemented by Mustache Template concrete subclasses.
+ *
+ * This is where the magic happens :)
+ *
+ * @param Mustache_Context $context
+ * @param string $indent (default: '')
+ * @param bool $escape (default: false)
+ *
+ * @return string Rendered template
+ */
+ abstract public function renderInternal(Mustache_Context $context, $indent = '', $escape = false);
+
+ /**
+ * Tests whether a value should be iterated over (e.g. in a section context).
+ *
+ * In most languages there are two distinct array types: list and hash (or whatever you want to call them). Lists
+ * should be iterated, hashes should be treated as objects. Mustache follows this paradigm for Ruby, Javascript,
+ * Java, Python, etc.
+ *
+ * PHP, however, treats lists and hashes as one primitive type: array. So Mustache.php needs a way to distinguish
+ * between between a list of things (numeric, normalized array) and a set of variables to be used as section context
+ * (associative array). In other words, this will be iterated over:
+ *
+ * $items = array(
+ * array('name' => 'foo'),
+ * array('name' => 'bar'),
+ * array('name' => 'baz'),
+ * );
+ *
+ * ... but this will be used as a section context block:
+ *
+ * $items = array(
+ * 1 => array('name' => 'foo'),
+ * 'banana' => array('name' => 'bar'),
+ * 42 => array('name' => 'baz'),
+ * );
+ *
+ * @param mixed $value
+ *
+ * @return boolean True if the value is 'iterable'
+ */
+ protected function isIterable($value)
+ {
+ if (is_object($value)) {
+ return $value instanceof Traversable;
+ } elseif (is_array($value)) {
+ $i = 0;
+ foreach ($value as $k => $v) {
+ if ($k !== $i++) {
+ return false;
+ }
+ }
+
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Helper method to prepare the Context stack.
+ *
+ * Adds the Mustache HelperCollection to the stack's top context frame if helpers are present.
+ *
+ * @param mixed $context Optional first context frame (default: null)
+ *
+ * @return Mustache_Context
+ */
+ protected function prepareContextStack($context = null)
+ {
+ $stack = new Mustache_Context;
+
+ $helpers = $this->mustache->getHelpers();
+ if (!$helpers->isEmpty()) {
+ $stack->push($helpers);
+ }
+
+ if (!empty($context)) {
+ $stack->push($context);
+ }
+
+ return $stack;
+ }
+}
|