Source for file Template.php

Documentation is available at Template.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Templates
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../Object.php';
24:
25: require_once dirname(__FILE__) . '/../Templates/IFileTemplate.php';
26:
27:
28:
29: /**
30: * Template.
31: *
32: * @author David Grudl
33: * @copyright Copyright (c) 2004, 2009 David Grudl
34: * @package Nette\Templates
35: */
36: class Template extends Object implements IFileTemplate
37: {
38: /** @var bool */
39: public $warnOnUndefined = TRUE;
40:
41: /** @var string */
42: private $file;
43:
44: /** @var array */
45: private $params = array();
46:
47: /** @var array */
48: private $filters = array();
49:
50: /** @var array */
51: private $helpers = array();
52:
53: /** @var array */
54: private $helperLoaders = array();
55:
56: /** @var int */
57: public static $cacheExpire = FALSE;
58:
59: /** @var ICacheStorage */
60: private static $cacheStorage;
61:
62:
63:
64: /**
65: * Sets the path to the template file.
66: * @param string template file path
67: * @return void
68: */
69: public function setFile($file)
70: {
71: $this->file = $file;
72: }
73:
74:
75:
76: /**
77: * Returns the path to the template file.
78: * @return string template file path
79: */
80: public function getFile()
81: {
82: return $this->file;
83: }
84:
85:
86:
87: /**
88: * Creates subtemplate.
89: * @param string file name
90: * @param array parameters (optional)
91: * @return Template
92: */
93: public function subTemplate($file, array $params = NULL)
94: {
95: if ($file instanceof self) {
96: $tpl = $file;
97:
98: } elseif ($file == NULL) { // intentionally ==
99: throw new InvalidArgumentException("Template file name was not specified.");
100:
101: } else {
102: $tpl = clone $this;
103: if ($file[0] !== '/' && $file[1] !== ':') {
104: $file = dirname($this->file) . '/' . $file;
105: }
106: $tpl->setFile($file);
107: }
108:
109: if ($params === NULL) {
110: $tpl->params = & $this->params;
111:
112: } else {
113: $tpl->params = & $params;
114: $tpl->params += $this->params;
115: }
116:
117: return $tpl;
118: }
119:
120:
121:
122: /**
123: * Registers callback as template filter.
124: * @param callback
125: * @return void
126: */
127: public function registerFilter($callback)
128: {
129: fixCallback($callback);
130: if (in_array($callback, $this->filters, TRUE)) {
131: is_callable($callback, TRUE, $textual);
132: throw new InvalidStateException("Filter '$textual' was registered twice.");
133: }
134: $this->filters[] = $callback;
135: }
136:
137:
138:
139: /********************* rendering ****************d*g**/
140:
141:
142:
143: /**
144: * Renders template to output.
145: * @return void
146: */
147: public function render()
148: {
149: if ($this->file == NULL) { // intentionally ==
150: throw new InvalidStateException("Template file name was not specified.");
151:
152: } elseif (!is_file($this->file) || !is_readable($this->file)) {
153: throw new FileNotFoundException("Missing template file '$this->file'.");
154: }
155:
156: $this->params['template'] = $this;
157:
158: if (!count($this->filters)) {
159: LimitedScope::load($this->file, $this->params);
160: return;
161: }
162:
163: $cache = new Cache($this->getCacheStorage(), 'Nette.Template');
164: $key = md5($this->file) . count($this->filters) . '.' . basename($this->file);
165: $cached = $content = $cache[$key];
166:
167: if ($content === NULL) {
168: $content = file_get_contents($this->file);
169:
170: foreach ($this->filters as $filter) {
171: if (!is_callable($filter)) {
172: $able = is_callable($filter, TRUE, $textual);
173: throw new InvalidStateException("Filter '$textual' is not " . ($able ? 'callable.' : 'valid PHP callback.'));
174: }
175:
176: // remove PHP code
177: $res = '';
178: $blocks = array();
179: unset($php);
180: foreach (token_get_all($content) as $token) {
181: if (is_array($token)) {
182: if ($token[0] === T_INLINE_HTML) {
183: $res .= $token[1];
184: unset($php);
185: } else {
186: if (!isset($php)) {
187: $res .= $php = "\x01@php:p" . count($blocks) . "@\x02";
188: $php = & $blocks[$php];
189: }
190: $php .= $token[1];
191: }
192: } else {
193: $php .= $token;
194: }
195: }
196:
197: try {
198: $content = call_user_func($filter, $res);
199: } catch (Exception $e) {
200: is_callable($filter, TRUE, $textual);
201: throw new InvalidStateException("Filter $textual: " . $e->getMessage() . " (in file $this->file)", 0, $e);
202: }
203:
204: $content = strtr($content, $blocks); // put PHP code back
205: }
206:
207: $content = "<?php\n// template $this->file\n?>$content";
208: $cache->save(
209: $key,
210: $content,
211: array(
212: Cache::FILES => $this->file,
213: Cache::EXPIRE => self::$cacheExpire,
214: )
215: );
216: $cached = $cache[$key];
217: }
218:
219: if ($cached !== NULL && self::$cacheStorage instanceof TemplateCacheStorage) {
220: LimitedScope::load($cached['file'], $this->params);
221: fclose($cached['handle']);
222:
223: } else {
224: LimitedScope::evaluate($content, $this->params);
225: }
226: }
227:
228:
229:
230: /**
231: * Renders template to string.
232: * @param bool can throw exceptions? (hidden parameter)
233: * @return string
234: */
235: public function __toString()
236: {
237: ob_start();
238: try {
239: $this->render();
240: return ob_get_clean();
241:
242: } catch (Exception $e) {
243: ob_end_clean();
244: if (func_num_args() && func_get_arg(0)) {
245: throw $e;
246: } else {
247: trigger_error($e->getMessage(), E_USER_WARNING);
248: return '';
249: }
250: }
251: }
252:
253:
254:
255: /**
256: * Converts to SimpleXML. (experimental)
257: * @return SimpleXMLElement
258: */
259: public function toXml()
260: {
261: $dom = new DOMDocument;
262: $dom->loadHTML('<html><meta http-equiv="Content-Type" content="text/html;charset=utf-8">' . str_replace("\r", '', $this->__toString()) . '</html>');
263: return simplexml_import_dom($dom)->body;
264: //return simplexml_load_string('<xml>' . $this->__toString() . '</xml>');
265: }
266:
267:
268:
269: /********************* template helpers ****************d*g**/
270:
271:
272:
273: /**
274: * Registers callback as template helper.
275: * @param string
276: * @param callback
277: * @return void
278: */
279: public function registerHelper($name, $callback)
280: {
281: fixCallback($callback);
282: if (!is_callable($callback)) {
283: $able = is_callable($callback, TRUE, $textual);
284: throw new InvalidArgumentException("Helper handler '$textual' is not " . ($able ? 'callable.' : 'valid PHP callback.'));
285: }
286: $this->helpers[strtolower($name)] = $callback;
287: }
288:
289:
290:
291: /**
292: * Registers callback as template helpers loader.
293: * @param callback
294: * @return void
295: */
296: public function registerHelperLoader($callback)
297: {
298: fixCallback($callback);
299: if (!is_callable($callback)) {
300: $able = is_callable($callback, TRUE, $textual);
301: throw new InvalidArgumentException("Helper loader '$textual' is not " . ($able ? 'callable.' : 'valid PHP callback.'));
302: }
303: $this->helperLoaders[] = $callback;
304: }
305:
306:
307:
308: /**
309: * Call a template helper. Do not call directly.
310: * @param string helper name
311: * @param array arguments
312: * @return mixed
313: */
314: public function __call($name, $args)
315: {
316: $name = strtolower($name);
317: if (!isset($this->helpers[$name])) {
318: foreach ($this->helperLoaders as $loader) {
319: $helper = call_user_func($loader, $name);
320: if ($helper) {
321: $this->registerHelper($name, $helper);
322: return call_user_func_array($helper, $args);
323: }
324: }
325: throw new InvalidStateException("The helper '$name' was not registered.");
326: }
327:
328: return call_user_func_array($this->helpers[$name], $args);
329: }
330:
331:
332:
333: /**
334: * Sets translate adapter.
335: * @param ITranslator
336: * @return void
337: */
338: public function setTranslator(ITranslator $translator = NULL)
339: {
340: $this->registerHelper('translate', $translator === NULL ? NULL : array($translator, 'translate'));
341: }
342:
343:
344:
345: /********************* template parameters ****************d*g**/
346:
347:
348:
349: /**
350: * Adds new template parameter.
351: * @param string name
352: * @param mixed value
353: * @return void
354: */
355: public function add($name, $value)
356: {
357: if (array_key_exists($name, $this->params)) {
358: throw new InvalidStateException("The variable '$name' exists yet.");
359: }
360:
361: $this->params[$name] = $value;
362: }
363:
364:
365:
366: /**
367: * Adds new template as parameter.
368: * @param string name
369: * @param string|Template file name or Template object
370: * @return Template
371: */
372: public function addTemplate($name, $file)
373: {
374: $tpl = $this->subTemplate($file);
375: $this->add($name, $tpl);
376: return $tpl;
377: }
378:
379:
380:
381: /**
382: * Returns array of all parameters.
383: * @return array
384: */
385: public function getParams()
386: {
387: return $this->params;
388: }
389:
390:
391:
392: /**
393: * Sets a template parameter. Do not call directly.
394: * @param string name
395: * @param mixed value
396: * @return void
397: */
398: public function __set($name, $value)
399: {
400: $this->params[$name] = $value;
401: }
402:
403:
404:
405: /**
406: * Returns a template parameter. Do not call directly.
407: * @param string name
408: * @return mixed value
409: */
410: public function &__get($name)
411: {
412: if ($this->warnOnUndefined && !array_key_exists($name, $this->params)) {
413: trigger_error("The variable '$name' does not exist in template '$this->file'", E_USER_WARNING);
414: }
415:
416: return $this->params[$name];
417: }
418:
419:
420:
421: /**
422: * Determines whether parameter is defined. Do not call directly.
423: * @param string name
424: * @return bool
425: */
426: public function __isset($name)
427: {
428: return isset($this->params[$name]);
429: }
430:
431:
432:
433: /**
434: * Removes a template parameter. Do not call directly.
435: * @param string name
436: * @return void
437: */
438: public function __unset($name)
439: {
440: unset($this->params[$name]);
441: }
442:
443:
444:
445: /********************* caching ****************d*g**/
446:
447:
448:
449: /**
450: * Set cache storage.
451: * @param Cache
452: * @return void
453: */
454: public static function setCacheStorage(ICacheStorage $storage)
455: {
456: self::$cacheStorage = $storage;
457: }
458:
459:
460:
461: /**
462: * @return ICacheStorage
463: */
464: public static function getCacheStorage()
465: {
466: if (self::$cacheStorage === NULL) {
467: self::$cacheStorage = new TemplateCacheStorage(Environment::getVariable('cacheBase'));
468: }
469: return self::$cacheStorage;
470: }
471:
472: }

Source for file Template.php

Namespaces