Mustache.php 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860
  1. <?php
  2. /**
  3. * A Mustache implementation in PHP.
  4. *
  5. * {@link http://defunkt.github.com/mustache}
  6. *
  7. * Mustache is a framework-agnostic logic-less templating language. It enforces separation of view
  8. * logic from template files. In fact, it is not even possible to embed logic in the template.
  9. *
  10. * This is very, very rad.
  11. *
  12. * @author Justin Hileman {@link http://justinhileman.com}
  13. */
  14. class Mustache {
  15. /**
  16. * Should this Mustache throw exceptions when it finds unexpected tags?
  17. *
  18. * @see self::_throwsException()
  19. */
  20. protected $_throwsExceptions = array(
  21. MustacheException::UNKNOWN_VARIABLE => false,
  22. MustacheException::UNCLOSED_SECTION => true,
  23. MustacheException::UNEXPECTED_CLOSE_SECTION => true,
  24. MustacheException::UNKNOWN_PARTIAL => false,
  25. MustacheException::UNKNOWN_PRAGMA => true,
  26. );
  27. // Override charset passed to htmlentities() and htmlspecialchars(). Defaults to UTF-8.
  28. protected $_charset = 'UTF-8';
  29. /**
  30. * Pragmas are macro-like directives that, when invoked, change the behavior or
  31. * syntax of Mustache.
  32. *
  33. * They should be considered extremely experimental. Most likely their implementation
  34. * will change in the future.
  35. */
  36. /**
  37. * The {{%UNESCAPED}} pragma swaps the meaning of the {{normal}} and {{{unescaped}}}
  38. * Mustache tags. That is, once this pragma is activated the {{normal}} tag will not be
  39. * escaped while the {{{unescaped}}} tag will be escaped.
  40. *
  41. * Pragmas apply only to the current template. Partials, even those included after the
  42. * {{%UNESCAPED}} call, will need their own pragma declaration.
  43. *
  44. * This may be useful in non-HTML Mustache situations.
  45. */
  46. const PRAGMA_UNESCAPED = 'UNESCAPED';
  47. /**
  48. * Constants used for section and tag RegEx
  49. */
  50. const SECTION_TYPES = '\^#\/';
  51. const TAG_TYPES = '#\^\/=!<>\\{&';
  52. protected $_otag = '{{';
  53. protected $_ctag = '}}';
  54. protected $_tagRegEx;
  55. protected $_template = '';
  56. protected $_context = array();
  57. protected $_partials = array();
  58. protected $_pragmas = array();
  59. protected $_pragmasImplemented = array(
  60. self::PRAGMA_UNESCAPED
  61. );
  62. protected $_localPragmas = array();
  63. /**
  64. * Mustache class constructor.
  65. *
  66. * This method accepts a $template string and a $view object. Optionally, pass an associative
  67. * array of partials as well.
  68. *
  69. * Passing an $options array allows overriding certain Mustache options during instantiation:
  70. *
  71. * $options = array(
  72. * // `charset` -- must be supported by `htmlspecialentities()`. defaults to 'UTF-8'
  73. * 'charset' => 'ISO-8859-1',
  74. *
  75. * // opening and closing delimiters, as an array or a space-separated string
  76. * 'delimiters' => '<% %>',
  77. *
  78. * // an array of pragmas to enable
  79. * 'pragmas' => array(
  80. * Mustache::PRAGMA_UNESCAPED
  81. * ),
  82. * );
  83. *
  84. * @access public
  85. * @param string $template (default: null)
  86. * @param mixed $view (default: null)
  87. * @param array $partials (default: null)
  88. * @param array $options (default: array())
  89. * @return void
  90. */
  91. public function __construct($template = null, $view = null, $partials = null, array $options = null) {
  92. if ($template !== null) $this->_template = $template;
  93. if ($partials !== null) $this->_partials = $partials;
  94. if ($view !== null) $this->_context = array($view);
  95. if ($options !== null) $this->_setOptions($options);
  96. }
  97. /**
  98. * Helper function for setting options from constructor args.
  99. *
  100. * @access protected
  101. * @param array $options
  102. * @return void
  103. */
  104. protected function _setOptions(array $options) {
  105. if (isset($options['charset'])) {
  106. $this->_charset = $options['charset'];
  107. }
  108. if (isset($options['delimiters'])) {
  109. $delims = $options['delimiters'];
  110. if (!is_array($delims)) {
  111. $delims = array_map('trim', explode(' ', $delims, 2));
  112. }
  113. $this->_otag = $delims[0];
  114. $this->_ctag = $delims[1];
  115. }
  116. if (isset($options['pragmas'])) {
  117. foreach ($options['pragmas'] as $pragma_name) {
  118. if (!in_array($pragma_name, $this->_pragmasImplemented)) {
  119. throw new MustacheException('Unknown pragma: ' . $pragma_name, MustacheException::UNKNOWN_PRAGMA);
  120. }
  121. }
  122. $this->_pragmas = $options['pragmas'];
  123. }
  124. }
  125. /**
  126. * Mustache class clone method.
  127. *
  128. * A cloned Mustache instance should have pragmas, delimeters and root context
  129. * reset to default values.
  130. *
  131. * @access public
  132. * @return void
  133. */
  134. public function __clone() {
  135. $this->_otag = '{{';
  136. $this->_ctag = '}}';
  137. $this->_localPragmas = array();
  138. if ($keys = array_keys($this->_context)) {
  139. $last = array_pop($keys);
  140. if ($this->_context[$last] instanceof Mustache) {
  141. $this->_context[$last] =& $this;
  142. }
  143. }
  144. }
  145. /**
  146. * Render the given template and view object.
  147. *
  148. * Defaults to the template and view passed to the class constructor unless a new one is provided.
  149. * Optionally, pass an associative array of partials as well.
  150. *
  151. * @access public
  152. * @param string $template (default: null)
  153. * @param mixed $view (default: null)
  154. * @param array $partials (default: null)
  155. * @return string Rendered Mustache template.
  156. */
  157. public function render($template = null, $view = null, $partials = null) {
  158. if ($template === null) $template = $this->_template;
  159. if ($partials !== null) $this->_partials = $partials;
  160. $otag_orig = $this->_otag;
  161. $ctag_orig = $this->_ctag;
  162. if ($view) {
  163. $this->_context = array($view);
  164. } else if (empty($this->_context)) {
  165. $this->_context = array($this);
  166. }
  167. $template = $this->_renderPragmas($template);
  168. $template = $this->_renderTemplate($template, $this->_context);
  169. $this->_otag = $otag_orig;
  170. $this->_ctag = $ctag_orig;
  171. return $template;
  172. }
  173. /**
  174. * Wrap the render() function for string conversion.
  175. *
  176. * @access public
  177. * @return string
  178. */
  179. public function __toString() {
  180. // PHP doesn't like exceptions in __toString.
  181. // catch any exceptions and convert them to strings.
  182. try {
  183. $result = $this->render();
  184. return $result;
  185. } catch (Exception $e) {
  186. return "Error rendering mustache: " . $e->getMessage();
  187. }
  188. }
  189. /**
  190. * Internal render function, used for recursive calls.
  191. *
  192. * @access protected
  193. * @param string $template
  194. * @return string Rendered Mustache template.
  195. */
  196. protected function _renderTemplate($template) {
  197. if ($section = $this->_findSection($template)) {
  198. list($before, $type, $tag_name, $content, $after) = $section;
  199. $rendered_before = $this->_renderTags($before);
  200. $rendered_content = '';
  201. $val = $this->_getVariable($tag_name);
  202. switch($type) {
  203. // inverted section
  204. case '^':
  205. if (empty($val)) {
  206. $rendered_content = $this->_renderTemplate($content);
  207. }
  208. break;
  209. // regular section
  210. case '#':
  211. if ($this->_varIsIterable($val)) {
  212. foreach ($val as $local_context) {
  213. $this->_pushContext($local_context);
  214. $rendered_content .= $this->_renderTemplate($content);
  215. $this->_popContext();
  216. }
  217. } else if ($val) {
  218. if (is_array($val) || is_object($val)) {
  219. $this->_pushContext($val);
  220. $rendered_content = $this->_renderTemplate($content);
  221. $this->_popContext();
  222. } else {
  223. $rendered_content = $this->_renderTemplate($content);
  224. }
  225. }
  226. break;
  227. }
  228. return $rendered_before . $rendered_content . $this->_renderTemplate($after);
  229. }
  230. return $this->_renderTags($template);
  231. }
  232. /**
  233. * Prepare a section RegEx string for the given opening/closing tags.
  234. *
  235. * @access protected
  236. * @param string $otag
  237. * @param string $ctag
  238. * @return string
  239. */
  240. protected function _prepareSectionRegEx($otag, $ctag) {
  241. return sprintf(
  242. '/(?:(?<=\\n)[ \\t]*)?%s(?:(?P<type>[%s])(?P<tag_name>.+?)|=(?P<delims>.*?)=)%s\\n?/s',
  243. preg_quote($otag, '/'),
  244. self::SECTION_TYPES,
  245. preg_quote($ctag, '/')
  246. );
  247. }
  248. /**
  249. * Extract the first section from $template.
  250. *
  251. * @access protected
  252. * @param string $template
  253. * @return array $before, $type, $tag_name, $content and $after
  254. */
  255. protected function _findSection($template) {
  256. $regEx = $this->_prepareSectionRegEx($this->_otag, $this->_ctag);
  257. $section_start = null;
  258. $section_type = null;
  259. $content_start = null;
  260. $search_offset = 0;
  261. $section_stack = array();
  262. $matches = array();
  263. while (preg_match($regEx, $template, $matches, PREG_OFFSET_CAPTURE, $search_offset)) {
  264. if (isset($matches['delims'][0])) {
  265. list($otag, $ctag) = explode(' ', $matches['delims'][0]);
  266. $regEx = $this->_prepareSectionRegEx($otag, $ctag);
  267. $search_offset = $matches[0][1] + strlen($matches[0][0]);
  268. continue;
  269. }
  270. $match = $matches[0][0];
  271. $offset = $matches[0][1];
  272. $type = $matches['type'][0];
  273. $tag_name = trim($matches['tag_name'][0]);
  274. $search_offset = $offset + strlen($match);
  275. switch ($type) {
  276. case '^':
  277. case '#':
  278. if (empty($section_stack)) {
  279. $section_start = $offset;
  280. $section_type = $type;
  281. $content_start = $search_offset;
  282. }
  283. array_push($section_stack, $tag_name);
  284. break;
  285. case '/':
  286. if (empty($section_stack) || ($tag_name !== array_pop($section_stack))) {
  287. if ($this->_throwsException(MustacheException::UNEXPECTED_CLOSE_SECTION)) {
  288. throw new MustacheException('Unexpected close section: ' . $tag_name, MustacheException::UNEXPECTED_CLOSE_SECTION);
  289. }
  290. }
  291. if (empty($section_stack)) {
  292. // $before, $type, $tag_name, $content, $after
  293. return array(
  294. substr($template, 0, $section_start),
  295. $section_type,
  296. $tag_name,
  297. substr($template, $content_start, $offset - $content_start),
  298. substr($template, $search_offset),
  299. );
  300. }
  301. break;
  302. }
  303. }
  304. if (!empty($section_stack)) {
  305. if ($this->_throwsException(MustacheException::UNCLOSED_SECTION)) {
  306. throw new MustacheException('Unclosed section: ' . $section_stack[0], MustacheException::UNCLOSED_SECTION);
  307. }
  308. }
  309. }
  310. /**
  311. * Prepare a pragma RegEx for the given opening/closing tags.
  312. *
  313. * @access protected
  314. * @param string $otag
  315. * @param string $ctag
  316. * @return string
  317. */
  318. protected function _preparePragmaRegEx($otag, $ctag) {
  319. return sprintf(
  320. '/%s%%\\s*(?P<pragma_name>[\\w_-]+)(?P<options_string>(?: [\\w]+=[\\w]+)*)\\s*%s\\n?/s',
  321. preg_quote($otag, '/'),
  322. preg_quote($ctag, '/')
  323. );
  324. }
  325. /**
  326. * Initialize pragmas and remove all pragma tags.
  327. *
  328. * @access protected
  329. * @param string $template
  330. * @return string
  331. */
  332. protected function _renderPragmas($template) {
  333. $this->_localPragmas = $this->_pragmas;
  334. // no pragmas
  335. if (strpos($template, $this->_otag . '%') === false) {
  336. return $template;
  337. }
  338. $regEx = $this->_preparePragmaRegEx($this->_otag, $this->_ctag);
  339. return preg_replace_callback($regEx, array($this, '_renderPragma'), $template);
  340. }
  341. /**
  342. * A preg_replace helper to remove {{%PRAGMA}} tags and enable requested pragma.
  343. *
  344. * @access protected
  345. * @param mixed $matches
  346. * @return void
  347. * @throws MustacheException unknown pragma
  348. */
  349. protected function _renderPragma($matches) {
  350. $pragma = $matches[0];
  351. $pragma_name = $matches['pragma_name'];
  352. $options_string = $matches['options_string'];
  353. if (!in_array($pragma_name, $this->_pragmasImplemented)) {
  354. throw new MustacheException('Unknown pragma: ' . $pragma_name, MustacheException::UNKNOWN_PRAGMA);
  355. }
  356. $options = array();
  357. foreach (explode(' ', trim($options_string)) as $o) {
  358. if ($p = trim($o)) {
  359. $p = explode('=', $p);
  360. $options[$p[0]] = $p[1];
  361. }
  362. }
  363. if (empty($options)) {
  364. $this->_localPragmas[$pragma_name] = true;
  365. } else {
  366. $this->_localPragmas[$pragma_name] = $options;
  367. }
  368. return '';
  369. }
  370. /**
  371. * Check whether this Mustache has a specific pragma.
  372. *
  373. * @access protected
  374. * @param string $pragma_name
  375. * @return bool
  376. */
  377. protected function _hasPragma($pragma_name) {
  378. if (array_key_exists($pragma_name, $this->_localPragmas) && $this->_localPragmas[$pragma_name]) {
  379. return true;
  380. } else {
  381. return false;
  382. }
  383. }
  384. /**
  385. * Return pragma options, if any.
  386. *
  387. * @access protected
  388. * @param string $pragma_name
  389. * @return mixed
  390. * @throws MustacheException Unknown pragma
  391. */
  392. protected function _getPragmaOptions($pragma_name) {
  393. if (!$this->_hasPragma($pragma_name)) {
  394. throw new MustacheException('Unknown pragma: ' . $pragma_name, MustacheException::UNKNOWN_PRAGMA);
  395. }
  396. return (is_array($this->_localPragmas[$pragma_name])) ? $this->_localPragmas[$pragma_name] : array();
  397. }
  398. /**
  399. * Check whether this Mustache instance throws a given exception.
  400. *
  401. * Expects exceptions to be MustacheException error codes (i.e. class constants).
  402. *
  403. * @access protected
  404. * @param mixed $exception
  405. * @return void
  406. */
  407. protected function _throwsException($exception) {
  408. return (isset($this->_throwsExceptions[$exception]) && $this->_throwsExceptions[$exception]);
  409. }
  410. /**
  411. * Prepare a tag RegEx for the given opening/closing tags.
  412. *
  413. * @access protected
  414. * @param string $otag
  415. * @param string $ctag
  416. * @return string
  417. */
  418. protected function _prepareTagRegEx($otag, $ctag, $first = false) {
  419. return sprintf(
  420. '/(?P<leading>(?:%s\\r?\\n)[ \\t]*)?%s(?P<type>[%s]?)(?P<tag_name>.+?)(?:\\2|})?%s(?P<trailing>\\s*(?:\\r?\\n|\\Z))?/s',
  421. ($first ? '\\A|' : ''),
  422. preg_quote($otag, '/'),
  423. self::TAG_TYPES,
  424. preg_quote($ctag, '/')
  425. );
  426. }
  427. /**
  428. * Loop through and render individual Mustache tags.
  429. *
  430. * @access protected
  431. * @param string $template
  432. * @return void
  433. */
  434. protected function _renderTags($template) {
  435. if (strpos($template, $this->_otag) === false) {
  436. return $template;
  437. }
  438. $first = true;
  439. $this->_tagRegEx = $this->_prepareTagRegEx($this->_otag, $this->_ctag, true);
  440. $html = '';
  441. $matches = array();
  442. while (preg_match($this->_tagRegEx, $template, $matches, PREG_OFFSET_CAPTURE)) {
  443. $tag = $matches[0][0];
  444. $offset = $matches[0][1];
  445. $modifier = $matches['type'][0];
  446. $tag_name = trim($matches['tag_name'][0]);
  447. if (isset($matches['leading']) && $matches['leading'][1] > -1) {
  448. $leading = $matches['leading'][0];
  449. } else {
  450. $leading = null;
  451. }
  452. if (isset($matches['trailing']) && $matches['trailing'][1] > -1) {
  453. $trailing = $matches['trailing'][0];
  454. } else {
  455. $trailing = null;
  456. }
  457. $html .= substr($template, 0, $offset);
  458. $next_offset = $offset + strlen($tag);
  459. if ((substr($html, -1) == "\n") && (substr($template, $next_offset, 1) == "\n")) {
  460. $next_offset++;
  461. }
  462. $template = substr($template, $next_offset);
  463. $html .= $this->_renderTag($modifier, $tag_name, $leading, $trailing);
  464. if ($first == true) {
  465. $first = false;
  466. $this->_tagRegEx = $this->_prepareTagRegEx($this->_otag, $this->_ctag);
  467. }
  468. }
  469. return $html . $template;
  470. }
  471. /**
  472. * Render the named tag, given the specified modifier.
  473. *
  474. * Accepted modifiers are `=` (change delimiter), `!` (comment), `>` (partial)
  475. * `{` or `&` (don't escape output), or none (render escaped output).
  476. *
  477. * @access protected
  478. * @param string $modifier
  479. * @param string $tag_name
  480. * @param string $leading Whitespace
  481. * @param string $trailing Whitespace
  482. * @throws MustacheException Unmatched section tag encountered.
  483. * @return string
  484. */
  485. protected function _renderTag($modifier, $tag_name, $leading, $trailing) {
  486. switch ($modifier) {
  487. case '=':
  488. return $this->_changeDelimiter($tag_name, $leading, $trailing);
  489. break;
  490. case '!':
  491. return $this->_renderComment($tag_name, $leading, $trailing);
  492. break;
  493. case '>':
  494. case '<':
  495. return $this->_renderPartial($tag_name, $leading, $trailing);
  496. break;
  497. case '{':
  498. // strip the trailing } ...
  499. if ($tag_name[(strlen($tag_name) - 1)] == '}') {
  500. $tag_name = substr($tag_name, 0, -1);
  501. }
  502. case '&':
  503. if ($this->_hasPragma(self::PRAGMA_UNESCAPED)) {
  504. return $this->_renderEscaped($tag_name, $leading, $trailing);
  505. } else {
  506. return $this->_renderUnescaped($tag_name, $leading, $trailing);
  507. }
  508. break;
  509. case '#':
  510. case '^':
  511. case '/':
  512. // remove any leftover section tags
  513. return $leading . $trailing;
  514. break;
  515. default:
  516. if ($this->_hasPragma(self::PRAGMA_UNESCAPED)) {
  517. return $this->_renderUnescaped($modifier . $tag_name, $leading, $trailing);
  518. } else {
  519. return $this->_renderEscaped($modifier . $tag_name, $leading, $trailing);
  520. }
  521. break;
  522. }
  523. }
  524. /**
  525. * Returns true if any of its args contains the "\r" character.
  526. *
  527. * @access protected
  528. * @param string $str
  529. * @return boolean
  530. */
  531. protected function _stringHasR($str) {
  532. foreach (func_get_args() as $arg) {
  533. if (strpos($arg, "\r") !== false) {
  534. return true;
  535. }
  536. }
  537. return false;
  538. }
  539. /**
  540. * Escape and return the requested tag.
  541. *
  542. * @access protected
  543. * @param string $tag_name
  544. * @param string $leading Whitespace
  545. * @param string $trailing Whitespace
  546. * @return string
  547. */
  548. protected function _renderEscaped($tag_name, $leading, $trailing) {
  549. return $leading . htmlentities($this->_getVariable($tag_name), ENT_COMPAT, $this->_charset) . $trailing;
  550. }
  551. /**
  552. * Render a comment (i.e. return an empty string).
  553. *
  554. * @access protected
  555. * @param string $tag_name
  556. * @param string $leading Whitespace
  557. * @param string $trailing Whitespace
  558. * @return string
  559. */
  560. protected function _renderComment($tag_name, $leading, $trailing) {
  561. if ($leading !== null && $trailing !== null) {
  562. if (strpos($leading, "\n") === false) {
  563. return '';
  564. }
  565. return $this->_stringHasR($leading, $trailing) ? "\r\n" : "\n";
  566. }
  567. return $leading . $trailing;
  568. }
  569. /**
  570. * Return the requested tag unescaped.
  571. *
  572. * @access protected
  573. * @param string $tag_name
  574. * @param string $leading Whitespace
  575. * @param string $trailing Whitespace
  576. * @return string
  577. */
  578. protected function _renderUnescaped($tag_name, $leading, $trailing) {
  579. return $leading . $this->_getVariable($tag_name) . $trailing;
  580. }
  581. /**
  582. * Render the requested partial.
  583. *
  584. * @access protected
  585. * @param string $tag_name
  586. * @param string $leading Whitespace
  587. * @param string $trailing Whitespace
  588. * @return string
  589. */
  590. protected function _renderPartial($tag_name, $leading, $trailing) {
  591. $partial = $this->_getPartial($tag_name);
  592. if ($leading !== null && $trailing !== null) {
  593. $whitespace = trim($leading, "\r\n");
  594. $partial = preg_replace('/(\\r?\\n)(?!$)/s', "\\1" . $whitespace, $partial);
  595. }
  596. $view = clone($this);
  597. if ($leading !== null && $trailing !== null) {
  598. return $leading . $view->render($partial);
  599. } else {
  600. return $leading . $view->render($partial) . $trailing;
  601. }
  602. }
  603. /**
  604. * Change the Mustache tag delimiter. This method also replaces this object's current
  605. * tag RegEx with one using the new delimiters.
  606. *
  607. * @access protected
  608. * @param string $tag_name
  609. * @param string $leading Whitespace
  610. * @param string $trailing Whitespace
  611. * @return string
  612. */
  613. protected function _changeDelimiter($tag_name, $leading, $trailing) {
  614. list($otag, $ctag) = explode(' ', $tag_name);
  615. $this->_otag = $otag;
  616. $this->_ctag = $ctag;
  617. $this->_tagRegEx = $this->_prepareTagRegEx($this->_otag, $this->_ctag);
  618. if ($leading !== null && $trailing !== null) {
  619. if (strpos($leading, "\n") === false) {
  620. return '';
  621. }
  622. return $this->_stringHasR($leading, $trailing) ? "\r\n" : "\n";
  623. }
  624. return $leading . $trailing;
  625. }
  626. /**
  627. * Push a local context onto the stack.
  628. *
  629. * @access protected
  630. * @param array &$local_context
  631. * @return void
  632. */
  633. protected function _pushContext(&$local_context) {
  634. $new = array();
  635. $new[] =& $local_context;
  636. foreach (array_keys($this->_context) as $key) {
  637. $new[] =& $this->_context[$key];
  638. }
  639. $this->_context = $new;
  640. }
  641. /**
  642. * Remove the latest context from the stack.
  643. *
  644. * @access protected
  645. * @return void
  646. */
  647. protected function _popContext() {
  648. $new = array();
  649. $keys = array_keys($this->_context);
  650. array_shift($keys);
  651. foreach ($keys as $key) {
  652. $new[] =& $this->_context[$key];
  653. }
  654. $this->_context = $new;
  655. }
  656. /**
  657. * Get a variable from the context array.
  658. *
  659. * If the view is an array, returns the value with array key $tag_name.
  660. * If the view is an object, this will check for a public member variable
  661. * named $tag_name. If none is available, this method will execute and return
  662. * any class method named $tag_name. Failing all of the above, this method will
  663. * return an empty string.
  664. *
  665. * @access protected
  666. * @param string $tag_name
  667. * @throws MustacheException Unknown variable name.
  668. * @return string
  669. */
  670. protected function _getVariable($tag_name) {
  671. if ($tag_name === '.') {
  672. return $this->_context[0];
  673. } else if (strpos($tag_name, '.') !== false) {
  674. $chunks = explode('.', $tag_name);
  675. $first = array_shift($chunks);
  676. $ret = $this->_findVariableInContext($first, $this->_context);
  677. while ($next = array_shift($chunks)) {
  678. // Slice off a chunk of context for dot notation traversal.
  679. $c = array($ret);
  680. $ret = $this->_findVariableInContext($next, $c);
  681. }
  682. return $ret;
  683. } else {
  684. return $this->_findVariableInContext($tag_name, $this->_context);
  685. }
  686. }
  687. /**
  688. * Get a variable from the context array. Internal helper used by getVariable() to abstract
  689. * variable traversal for dot notation.
  690. *
  691. * @access protected
  692. * @param string $tag_name
  693. * @param array $context
  694. * @throws MustacheException Unknown variable name.
  695. * @return string
  696. */
  697. protected function _findVariableInContext($tag_name, $context) {
  698. foreach ($context as $view) {
  699. if (is_object($view)) {
  700. if (method_exists($view, $tag_name)) {
  701. return $view->$tag_name();
  702. } else if (isset($view->$tag_name)) {
  703. return $view->$tag_name;
  704. }
  705. } else if (is_array($view) && array_key_exists($tag_name, $view)) {
  706. return $view[$tag_name];
  707. }
  708. }
  709. if ($this->_throwsException(MustacheException::UNKNOWN_VARIABLE)) {
  710. throw new MustacheException("Unknown variable: " . $tag_name, MustacheException::UNKNOWN_VARIABLE);
  711. } else {
  712. return '';
  713. }
  714. }
  715. /**
  716. * Retrieve the partial corresponding to the requested tag name.
  717. *
  718. * Silently fails (i.e. returns '') when the requested partial is not found.
  719. *
  720. * @access protected
  721. * @param string $tag_name
  722. * @throws MustacheException Unknown partial name.
  723. * @return string
  724. */
  725. protected function _getPartial($tag_name) {
  726. if (is_array($this->_partials) && isset($this->_partials[$tag_name])) {
  727. return $this->_partials[$tag_name];
  728. }
  729. if ($this->_throwsException(MustacheException::UNKNOWN_PARTIAL)) {
  730. throw new MustacheException('Unknown partial: ' . $tag_name, MustacheException::UNKNOWN_PARTIAL);
  731. } else {
  732. return '';
  733. }
  734. }
  735. /**
  736. * Check whether the given $var should be iterated (i.e. in a section context).
  737. *
  738. * @access protected
  739. * @param mixed $var
  740. * @return bool
  741. */
  742. protected function _varIsIterable($var) {
  743. return $var instanceof Traversable || (is_array($var) && !array_diff_key($var, array_keys(array_keys($var))));
  744. }
  745. }
  746. /**
  747. * MustacheException class.
  748. *
  749. * @extends Exception
  750. */
  751. class MustacheException extends Exception {
  752. // An UNKNOWN_VARIABLE exception is thrown when a {{variable}} is not found
  753. // in the current context.
  754. const UNKNOWN_VARIABLE = 0;
  755. // An UNCLOSED_SECTION exception is thrown when a {{#section}} is not closed.
  756. const UNCLOSED_SECTION = 1;
  757. // An UNEXPECTED_CLOSE_SECTION exception is thrown when {{/section}} appears
  758. // without a corresponding {{#section}} or {{^section}}.
  759. const UNEXPECTED_CLOSE_SECTION = 2;
  760. // An UNKNOWN_PARTIAL exception is thrown whenever a {{>partial}} tag appears
  761. // with no associated partial.
  762. const UNKNOWN_PARTIAL = 3;
  763. // An UNKNOWN_PRAGMA exception is thrown whenever a {{%PRAGMA}} tag appears
  764. // which can't be handled by this Mustache instance.
  765. const UNKNOWN_PRAGMA = 4;
  766. }