Mustache.php 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887
  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. if ($view) {
  161. $this->_context = array($view);
  162. } else if (empty($this->_context)) {
  163. $this->_context = array($this);
  164. }
  165. $template = $this->_renderPragmas($template);
  166. return $this->_renderTemplate($template, $this->_context);
  167. }
  168. /**
  169. * Wrap the render() function for string conversion.
  170. *
  171. * @access public
  172. * @return string
  173. */
  174. public function __toString() {
  175. // PHP doesn't like exceptions in __toString.
  176. // catch any exceptions and convert them to strings.
  177. try {
  178. $result = $this->render();
  179. return $result;
  180. } catch (Exception $e) {
  181. return "Error rendering mustache: " . $e->getMessage();
  182. }
  183. }
  184. /**
  185. * Internal render function, used for recursive calls.
  186. *
  187. * @access protected
  188. * @param string $template
  189. * @return string Rendered Mustache template.
  190. */
  191. protected function _renderTemplate($template) {
  192. $template = $this->_renderSections($template);
  193. return $this->_renderTags($template);
  194. }
  195. /**
  196. * Render boolean, enumerable and inverted sections.
  197. *
  198. * @access protected
  199. * @param string $template
  200. * @return string
  201. */
  202. protected function _renderSections($template) {
  203. while ($section_data = $this->_findSection($template)) {
  204. list($section, $offset, $type, $tag_name, $content) = $section_data;
  205. $replace = '';
  206. $val = $this->_getVariable($tag_name);
  207. switch($type) {
  208. // inverted section
  209. case '^':
  210. if (empty($val)) {
  211. $replace .= $content;
  212. }
  213. break;
  214. // regular section
  215. case '#':
  216. // higher order sections
  217. if ($this->_varIsCallable($val)) {
  218. $content = call_user_func($val, $content);
  219. $replace .= $this->_renderTemplate($content);
  220. } else if ($this->_varIsIterable($val)) {
  221. foreach ($val as $local_context) {
  222. $this->_pushContext($local_context);
  223. $replace .= $this->_renderTemplate($content);
  224. $this->_popContext();
  225. }
  226. } else if ($val) {
  227. if (is_array($val) || is_object($val)) {
  228. $this->_pushContext($val);
  229. $replace .= $this->_renderTemplate($content);
  230. $this->_popContext();
  231. } else {
  232. $replace .= $content;
  233. }
  234. }
  235. break;
  236. }
  237. $template = substr_replace($template, $replace, $offset, strlen($section));
  238. }
  239. return $template;
  240. }
  241. /**
  242. * Prepare a section RegEx string for the given opening/closing tags.
  243. *
  244. * @access protected
  245. * @param string $otag
  246. * @param string $ctag
  247. * @return string
  248. */
  249. protected function _prepareSectionRegEx($otag, $ctag) {
  250. return sprintf(
  251. '/(?:(?<=\\n)[ \\t]*)?%s(?P<type>[%s])(?P<tag_name>.+?)%s\\n?/s',
  252. preg_quote($otag, '/'),
  253. self::SECTION_TYPES,
  254. preg_quote($ctag, '/')
  255. );
  256. }
  257. /**
  258. * Extract a section from $template.
  259. *
  260. * This is a helper function to find sections needed by _renderSections.
  261. *
  262. * @access protected
  263. * @param string $template
  264. * @return array $section, $offset, $type, $tag_name and $content
  265. */
  266. protected function _findSection($template) {
  267. $regEx = $this->_prepareSectionRegEx($this->_otag, $this->_ctag);
  268. $section_start = null;
  269. $section_type = null;
  270. $content_start = null;
  271. $search_offset = 0;
  272. $section_stack = array();
  273. $matches = array();
  274. while (preg_match($regEx, $template, $matches, PREG_OFFSET_CAPTURE, $search_offset)) {
  275. $match = $matches[0][0];
  276. $offset = $matches[0][1];
  277. $type = $matches['type'][0];
  278. $tag_name = trim($matches['tag_name'][0]);
  279. $search_offset = $offset + strlen($match);
  280. switch ($type) {
  281. case '^':
  282. case '#':
  283. if (empty($section_stack)) {
  284. $section_start = $offset;
  285. $section_type = $type;
  286. $content_start = $search_offset;
  287. }
  288. array_push($section_stack, $tag_name);
  289. break;
  290. case '/':
  291. if (empty($section_stack) || ($tag_name !== array_pop($section_stack))) {
  292. if ($this->_throwsException(MustacheException::UNEXPECTED_CLOSE_SECTION)) {
  293. throw new MustacheException('Unexpected close section: ' . $tag_name, MustacheException::UNEXPECTED_CLOSE_SECTION);
  294. }
  295. }
  296. if (empty($section_stack)) {
  297. $section = substr($template, $section_start, $search_offset - $section_start);
  298. $content = substr($template, $content_start, $offset - $content_start);
  299. return array($section, $section_start, $section_type, $tag_name, $content);
  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. $otag_orig = $this->_otag;
  439. $ctag_orig = $this->_ctag;
  440. $first = true;
  441. $this->_tagRegEx = $this->_prepareTagRegEx($this->_otag, $this->_ctag, true);
  442. $html = '';
  443. $matches = array();
  444. while (preg_match($this->_tagRegEx, $template, $matches, PREG_OFFSET_CAPTURE)) {
  445. $tag = $matches[0][0];
  446. $offset = $matches[0][1];
  447. $modifier = $matches['type'][0];
  448. $tag_name = trim($matches['tag_name'][0]);
  449. if (isset($matches['leading']) && $matches['leading'][1] > -1) {
  450. $leading = $matches['leading'][0];
  451. } else {
  452. $leading = null;
  453. }
  454. if (isset($matches['trailing']) && $matches['trailing'][1] > -1) {
  455. $trailing = $matches['trailing'][0];
  456. } else {
  457. $trailing = null;
  458. }
  459. $html .= substr($template, 0, $offset);
  460. $next_offset = $offset + strlen($tag);
  461. if ((substr($html, -1) == "\n") && (substr($template, $next_offset, 1) == "\n")) {
  462. $next_offset++;
  463. }
  464. $template = substr($template, $next_offset);
  465. $html .= $this->_renderTag($modifier, $tag_name, $leading, $trailing);
  466. if ($first == true) {
  467. $first = false;
  468. $this->_tagRegEx = $this->_prepareTagRegEx($this->_otag, $this->_ctag);
  469. }
  470. }
  471. $this->_otag = $otag_orig;
  472. $this->_ctag = $ctag_orig;
  473. return $html . $template;
  474. }
  475. /**
  476. * Render the named tag, given the specified modifier.
  477. *
  478. * Accepted modifiers are `=` (change delimiter), `!` (comment), `>` (partial)
  479. * `{` or `&` (don't escape output), or none (render escaped output).
  480. *
  481. * @access protected
  482. * @param string $modifier
  483. * @param string $tag_name
  484. * @param string $leading Whitespace
  485. * @param string $trailing Whitespace
  486. * @throws MustacheException Unmatched section tag encountered.
  487. * @return string
  488. */
  489. protected function _renderTag($modifier, $tag_name, $leading, $trailing) {
  490. switch ($modifier) {
  491. case '=':
  492. return $this->_changeDelimiter($tag_name, $leading, $trailing);
  493. break;
  494. case '!':
  495. return $this->_renderComment($tag_name, $leading, $trailing);
  496. break;
  497. case '>':
  498. case '<':
  499. return $this->_renderPartial($tag_name, $leading, $trailing);
  500. break;
  501. case '{':
  502. // strip the trailing } ...
  503. if ($tag_name[(strlen($tag_name) - 1)] == '}') {
  504. $tag_name = substr($tag_name, 0, -1);
  505. }
  506. case '&':
  507. if ($this->_hasPragma(self::PRAGMA_UNESCAPED)) {
  508. return $this->_renderEscaped($tag_name, $leading, $trailing);
  509. } else {
  510. return $this->_renderUnescaped($tag_name, $leading, $trailing);
  511. }
  512. break;
  513. case '#':
  514. case '^':
  515. case '/':
  516. // remove any leftovers from _renderSections
  517. return $leading . $trailing;
  518. break;
  519. default:
  520. if ($this->_hasPragma(self::PRAGMA_UNESCAPED)) {
  521. return $this->_renderUnescaped($modifier . $tag_name, $leading, $trailing);
  522. } else {
  523. return $this->_renderEscaped($modifier . $tag_name, $leading, $trailing);
  524. }
  525. break;
  526. }
  527. }
  528. /**
  529. * Returns true if any of its args contains the "\r" character.
  530. *
  531. * @access protected
  532. * @param string $str
  533. * @return boolean
  534. */
  535. protected function _stringHasR($str) {
  536. foreach (func_get_args() as $arg) {
  537. if (strpos($arg, "\r") !== false) {
  538. return true;
  539. }
  540. }
  541. return false;
  542. }
  543. /**
  544. * Escape and return the requested tag.
  545. *
  546. * @access protected
  547. * @param string $tag_name
  548. * @param string $leading Whitespace
  549. * @param string $trailing Whitespace
  550. * @return string
  551. */
  552. protected function _renderEscaped($tag_name, $leading, $trailing) {
  553. return htmlentities($this->_renderUnescaped($tag_name, $leading, $trailing), ENT_COMPAT, $this->_charset);
  554. }
  555. /**
  556. * Render a comment (i.e. return an empty string).
  557. *
  558. * @access protected
  559. * @param string $tag_name
  560. * @param string $leading Whitespace
  561. * @param string $trailing Whitespace
  562. * @return string
  563. */
  564. protected function _renderComment($tag_name, $leading, $trailing) {
  565. if ($leading !== null && $trailing !== null) {
  566. if (strpos($leading, "\n") === false) {
  567. return '';
  568. }
  569. return $this->_stringHasR($leading, $trailing) ? "\r\n" : "\n";
  570. }
  571. return $leading . $trailing;
  572. }
  573. /**
  574. * Return the requested tag unescaped.
  575. *
  576. * @access protected
  577. * @param string $tag_name
  578. * @param string $leading Whitespace
  579. * @param string $trailing Whitespace
  580. * @return string
  581. */
  582. protected function _renderUnescaped($tag_name, $leading, $trailing) {
  583. $val = $this->_getVariable($tag_name);
  584. if ($this->_varIsCallable($val)) {
  585. $key = is_object($val) ? spl_object_hash($val) : serialize($val);
  586. $val = $this->_renderTemplate(call_user_func($val));
  587. }
  588. return $leading . $val . $trailing;
  589. }
  590. /**
  591. * Render the requested partial.
  592. *
  593. * @access protected
  594. * @param string $tag_name
  595. * @param string $leading Whitespace
  596. * @param string $trailing Whitespace
  597. * @return string
  598. */
  599. protected function _renderPartial($tag_name, $leading, $trailing) {
  600. $partial = $this->_getPartial($tag_name);
  601. if ($leading !== null && $trailing !== null) {
  602. $whitespace = trim($leading, "\r\n");
  603. $partial = preg_replace('/(\\r?\\n)(?!$)/s', "\\1" . $whitespace, $partial);
  604. }
  605. $view = clone($this);
  606. if ($leading !== null && $trailing !== null) {
  607. return $leading . $view->render($partial);
  608. } else {
  609. return $leading . $view->render($partial) . $trailing;
  610. }
  611. }
  612. /**
  613. * Change the Mustache tag delimiter. This method also replaces this object's current
  614. * tag RegEx with one using the new delimiters.
  615. *
  616. * @access protected
  617. * @param string $tag_name
  618. * @param string $leading Whitespace
  619. * @param string $trailing Whitespace
  620. * @return string
  621. */
  622. protected function _changeDelimiter($tag_name, $leading, $trailing) {
  623. list($otag, $ctag) = explode(' ', $tag_name);
  624. $this->_otag = $otag;
  625. $this->_ctag = $ctag;
  626. $this->_tagRegEx = $this->_prepareTagRegEx($this->_otag, $this->_ctag);
  627. if ($leading !== null && $trailing !== null) {
  628. if (strpos($leading, "\n") === false) {
  629. return '';
  630. }
  631. return $this->_stringHasR($leading, $trailing) ? "\r\n" : "\n";
  632. }
  633. return $leading . $trailing;
  634. }
  635. /**
  636. * Push a local context onto the stack.
  637. *
  638. * @access protected
  639. * @param array &$local_context
  640. * @return void
  641. */
  642. protected function _pushContext(&$local_context) {
  643. $new = array();
  644. $new[] =& $local_context;
  645. foreach (array_keys($this->_context) as $key) {
  646. $new[] =& $this->_context[$key];
  647. }
  648. $this->_context = $new;
  649. }
  650. /**
  651. * Remove the latest context from the stack.
  652. *
  653. * @access protected
  654. * @return void
  655. */
  656. protected function _popContext() {
  657. $new = array();
  658. $keys = array_keys($this->_context);
  659. array_shift($keys);
  660. foreach ($keys as $key) {
  661. $new[] =& $this->_context[$key];
  662. }
  663. $this->_context = $new;
  664. }
  665. /**
  666. * Get a variable from the context array.
  667. *
  668. * If the view is an array, returns the value with array key $tag_name.
  669. * If the view is an object, this will check for a public member variable
  670. * named $tag_name. If none is available, this method will execute and return
  671. * any class method named $tag_name. Failing all of the above, this method will
  672. * return an empty string.
  673. *
  674. * @access protected
  675. * @param string $tag_name
  676. * @throws MustacheException Unknown variable name.
  677. * @return string
  678. */
  679. protected function _getVariable($tag_name) {
  680. if ($tag_name === '.') {
  681. return $this->_context[0];
  682. } else if (strpos($tag_name, '.') !== false) {
  683. $chunks = explode('.', $tag_name);
  684. $first = array_shift($chunks);
  685. $ret = $this->_findVariableInContext($first, $this->_context);
  686. while ($next = array_shift($chunks)) {
  687. // Slice off a chunk of context for dot notation traversal.
  688. $c = array($ret);
  689. $ret = $this->_findVariableInContext($next, $c);
  690. }
  691. return $ret;
  692. } else {
  693. return $this->_findVariableInContext($tag_name, $this->_context);
  694. }
  695. }
  696. /**
  697. * Get a variable from the context array. Internal helper used by getVariable() to abstract
  698. * variable traversal for dot notation.
  699. *
  700. * @access protected
  701. * @param string $tag_name
  702. * @param array $context
  703. * @throws MustacheException Unknown variable name.
  704. * @return string
  705. */
  706. protected function _findVariableInContext($tag_name, $context) {
  707. foreach ($context as $view) {
  708. if (is_object($view)) {
  709. if (method_exists($view, $tag_name)) {
  710. return $view->$tag_name();
  711. } else if (isset($view->$tag_name)) {
  712. return $view->$tag_name;
  713. }
  714. } else if (is_array($view) && array_key_exists($tag_name, $view)) {
  715. return $view[$tag_name];
  716. }
  717. }
  718. if ($this->_throwsException(MustacheException::UNKNOWN_VARIABLE)) {
  719. throw new MustacheException("Unknown variable: " . $tag_name, MustacheException::UNKNOWN_VARIABLE);
  720. } else {
  721. return '';
  722. }
  723. }
  724. /**
  725. * Retrieve the partial corresponding to the requested tag name.
  726. *
  727. * Silently fails (i.e. returns '') when the requested partial is not found.
  728. *
  729. * @access protected
  730. * @param string $tag_name
  731. * @throws MustacheException Unknown partial name.
  732. * @return string
  733. */
  734. protected function _getPartial($tag_name) {
  735. if (is_array($this->_partials) && isset($this->_partials[$tag_name])) {
  736. return $this->_partials[$tag_name];
  737. }
  738. if ($this->_throwsException(MustacheException::UNKNOWN_PARTIAL)) {
  739. throw new MustacheException('Unknown partial: ' . $tag_name, MustacheException::UNKNOWN_PARTIAL);
  740. } else {
  741. return '';
  742. }
  743. }
  744. /**
  745. * Check whether the given $var should be iterated (i.e. in a section context).
  746. *
  747. * @access protected
  748. * @param mixed $var
  749. * @return bool
  750. */
  751. protected function _varIsIterable($var) {
  752. return $var instanceof Traversable || (is_array($var) && !array_diff_key($var, array_keys(array_keys($var))));
  753. }
  754. /**
  755. * Higher order sections helper: tests whether the section $var is a valid callback.
  756. *
  757. * In Mustache.php, a variable is considered 'callable' if the variable is:
  758. *
  759. * 1. an anonymous function.
  760. * 2. an object and the name of a public function, i.e. `array($SomeObject, 'methodName')`
  761. * 3. a class name and the name of a public static function, i.e. `array('SomeClass', 'methodName')`
  762. *
  763. * @access protected
  764. * @param mixed $var
  765. * @return bool
  766. */
  767. protected function _varIsCallable($var) {
  768. return !is_string($var) && is_callable($var);
  769. }
  770. }
  771. /**
  772. * MustacheException class.
  773. *
  774. * @extends Exception
  775. */
  776. class MustacheException extends Exception {
  777. // An UNKNOWN_VARIABLE exception is thrown when a {{variable}} is not found
  778. // in the current context.
  779. const UNKNOWN_VARIABLE = 0;
  780. // An UNCLOSED_SECTION exception is thrown when a {{#section}} is not closed.
  781. const UNCLOSED_SECTION = 1;
  782. // An UNEXPECTED_CLOSE_SECTION exception is thrown when {{/section}} appears
  783. // without a corresponding {{#section}} or {{^section}}.
  784. const UNEXPECTED_CLOSE_SECTION = 2;
  785. // An UNKNOWN_PARTIAL exception is thrown whenever a {{>partial}} tag appears
  786. // with no associated partial.
  787. const UNKNOWN_PARTIAL = 3;
  788. // An UNKNOWN_PRAGMA exception is thrown whenever a {{%PRAGMA}} tag appears
  789. // which can't be handled by this Mustache instance.
  790. const UNKNOWN_PRAGMA = 4;
  791. }