Packages

  • Nette
    • Application
      • Diagnostics
      • Responses
      • Routers
      • UI
    • Caching
      • Storages
    • ComponentModel
    • Config
      • Adapters
      • Extensions
    • Database
      • Diagnostics
      • Drivers
      • Reflection
      • Table
    • DI
      • Diagnostics
    • Diagnostics
    • Forms
      • Controls
      • Rendering
    • Http
    • Iterators
    • Latte
      • Macros
    • Loaders
    • Localization
    • Mail
    • Reflection
    • Security
      • Diagnostics
    • Templating
    • Utils
      • PhpGenerator
  • NetteModule
  • None
  • PHP

Classes

  • FileTemplate
  • Template
  • TemplateHelpers

Interfaces

  • IFileTemplate
  • ITemplate

Exceptions

  • TemplateException
  • Overview
  • Package
  • Class
  • Tree
  1: <?php
  2: 
  3: /**
  4:  * This file is part of the Nette Framework (http://nette.org)
  5:  *
  6:  * Copyright (c) 2004 David Grudl (http://davidgrudl.com)
  7:  *
  8:  * For the full copyright and license information, please view
  9:  * the file license.txt that was distributed with this source code.
 10:  * @package Nette\Templating
 11:  */
 12: 
 13: 
 14: 
 15: /**
 16:  * Template.
 17:  *
 18:  * @author     David Grudl
 19:  * @package Nette\Templating
 20:  */
 21: class Template extends Object implements ITemplate
 22: {
 23:     /** @var array of function(Template $sender); Occurs before a template is compiled - implement to customize the filters */
 24:     public $onPrepareFilters = array();
 25: 
 26:     /** @var string */
 27:     private $source;
 28: 
 29:     /** @var array */
 30:     private $params = array();
 31: 
 32:     /** @var array compile-time filters */
 33:     private $filters = array();
 34: 
 35:     /** @var array run-time helpers */
 36:     private $helpers = array();
 37: 
 38:     /** @var array */
 39:     private $helperLoaders = array();
 40: 
 41:     /** @var ICacheStorage */
 42:     private $cacheStorage;
 43: 
 44: 
 45: 
 46:     /**
 47:      * Sets template source code.
 48:      * @param  string
 49:      * @return Template  provides a fluent interface
 50:      */
 51:     public function setSource($source)
 52:     {
 53:         $this->source = $source;
 54:         return $this;
 55:     }
 56: 
 57: 
 58: 
 59:     /**
 60:      * Returns template source code.
 61:      * @return source
 62:      */
 63:     public function getSource()
 64:     {
 65:         return $this->source;
 66:     }
 67: 
 68: 
 69: 
 70:     /********************* rendering ****************d*g**/
 71: 
 72: 
 73: 
 74:     /**
 75:      * Renders template to output.
 76:      * @return void
 77:      */
 78:     public function render()
 79:     {
 80:         $cache = new Cache($storage = $this->getCacheStorage(), 'Nette.Template');
 81:         $cached = $compiled = $cache->load($this->source);
 82: 
 83:         if ($compiled === NULL) {
 84:             $compiled = $this->compile();
 85:             $cache->save($this->source, $compiled, array(Cache::CONSTS => 'Framework::REVISION'));
 86:             $cached = $cache->load($this->source);
 87:         }
 88: 
 89:         if ($cached !== NULL && $storage instanceof PhpFileStorage) {
 90:             LimitedScope::load($cached['file'], $this->getParameters());
 91:         } else {
 92:             LimitedScope::evaluate($compiled, $this->getParameters());
 93:         }
 94:     }
 95: 
 96: 
 97: 
 98:     /**
 99:      * Renders template to file.
100:      * @param  string
101:      * @return void
102:      */
103:     public function save($file)
104:     {
105:         if (file_put_contents($file, $this->__toString(TRUE)) === FALSE) {
106:             throw new IOException("Unable to save file '$file'.");
107:         }
108:     }
109: 
110: 
111: 
112:     /**
113:      * Renders template to string.
114:      * @param  bool  can throw exceptions? (hidden parameter)
115:      * @return string
116:      */
117:     public function __toString()
118:     {
119:         $args = func_get_args();
120:         ob_start();
121:         try {
122:             $this->render();
123:             return ob_get_clean();
124: 
125:         } catch (Exception $e) {
126:             ob_end_clean();
127:             if ($args && $args[0]) {
128:                 throw $e;
129:             } else {
130:                 Debugger::toStringException($e);
131:             }
132:         }
133:     }
134: 
135: 
136: 
137:     /**
138:      * Applies filters on template content.
139:      * @return string
140:      */
141:     public function compile()
142:     {
143:         if (!$this->filters) {
144:             $this->onPrepareFilters($this);
145:         }
146: 
147:         $code = $this->getSource();
148:         foreach ($this->filters as $filter) {
149:             $code = self::extractPhp($code, $blocks);
150:             $code = $filter->invoke($code);
151:             $code = strtr($code, $blocks); // put PHP code back
152:         }
153: 
154:         return TemplateHelpers::optimizePhp($code);
155:     }
156: 
157: 
158: 
159:     /********************* template filters & helpers ****************d*g**/
160: 
161: 
162: 
163:     /**
164:      * Registers callback as template compile-time filter.
165:      * @param  callback
166:      * @return Template  provides a fluent interface
167:      */
168:     public function registerFilter($callback)
169:     {
170:         $callback = callback($callback);
171:         if (in_array($callback, $this->filters)) {
172:             throw new InvalidStateException("Filter '$callback' was registered twice.");
173:         }
174:         $this->filters[] = $callback;
175:         return $this;
176:     }
177: 
178: 
179: 
180:     /**
181:      * Returns all registered compile-time filters.
182:      * @return array
183:      */
184:     final public function getFilters()
185:     {
186:         return $this->filters;
187:     }
188: 
189: 
190: 
191:     /**
192:      * Registers callback as template run-time helper.
193:      * @param  string
194:      * @param  callback
195:      * @return Template  provides a fluent interface
196:      */
197:     public function registerHelper($name, $callback)
198:     {
199:         $this->helpers[strtolower($name)] = callback($callback);
200:         return $this;
201:     }
202: 
203: 
204: 
205:     /**
206:      * Registers callback as template run-time helpers loader.
207:      * @param  callback
208:      * @return Template  provides a fluent interface
209:      */
210:     public function registerHelperLoader($callback)
211:     {
212:         $this->helperLoaders[] = callback($callback);
213:         return $this;
214:     }
215: 
216: 
217: 
218:     /**
219:      * Returns all registered run-time helpers.
220:      * @return array
221:      */
222:     final public function getHelpers()
223:     {
224:         return $this->helpers;
225:     }
226: 
227: 
228: 
229:     /**
230:      * Call a template run-time helper. Do not call directly.
231:      * @param  string  helper name
232:      * @param  array   arguments
233:      * @return mixed
234:      */
235:     public function __call($name, $args)
236:     {
237:         $lname = strtolower($name);
238:         if (!isset($this->helpers[$lname])) {
239:             foreach ($this->helperLoaders as $loader) {
240:                 $helper = $loader->invoke($lname);
241:                 if ($helper) {
242:                     $this->registerHelper($lname, $helper);
243:                     return $this->helpers[$lname]->invokeArgs($args);
244:                 }
245:             }
246:             return parent::__call($name, $args);
247:         }
248: 
249:         return $this->helpers[$lname]->invokeArgs($args);
250:     }
251: 
252: 
253: 
254:     /**
255:      * Sets translate adapter.
256:      * @param  ITranslator
257:      * @return Template  provides a fluent interface
258:      */
259:     public function setTranslator(ITranslator $translator = NULL)
260:     {
261:         $this->registerHelper('translate', $translator === NULL ? NULL : array($translator, 'translate'));
262:         return $this;
263:     }
264: 
265: 
266: 
267:     /********************* template parameters ****************d*g**/
268: 
269: 
270: 
271:     /**
272:      * Adds new template parameter.
273:      * @param  string  name
274:      * @param  mixed   value
275:      * @return Template  provides a fluent interface
276:      */
277:     public function add($name, $value)
278:     {
279:         if (array_key_exists($name, $this->params)) {
280:             throw new InvalidStateException("The variable '$name' already exists.");
281:         }
282: 
283:         $this->params[$name] = $value;
284:         return $this;
285:     }
286: 
287: 
288: 
289:     /**
290:      * Sets all parameters.
291:      * @param  array
292:      * @return Template  provides a fluent interface
293:      */
294:     public function setParameters(array $params)
295:     {
296:         $this->params = $params + $this->params;
297:         return $this;
298:     }
299: 
300: 
301: 
302:     /**
303:      * Returns array of all parameters.
304:      * @return array
305:      */
306:     public function getParameters()
307:     {
308:         $this->params['template'] = $this;
309:         return $this->params;
310:     }
311: 
312: 
313: 
314:     /** @deprecated */
315:     function setParams(array $params)
316:     {
317:         trigger_error(__METHOD__ . '() is deprecated; use setParameters() instead.', E_USER_WARNING);
318:         return $this->setParameters($params);
319:     }
320: 
321: 
322: 
323:     /** @deprecated */
324:     function getParams()
325:     {
326:         trigger_error(__METHOD__ . '() is deprecated; use getParameters() instead.', E_USER_WARNING);
327:         return $this->getParameters();
328:     }
329: 
330: 
331: 
332:     /**
333:      * Sets a template parameter. Do not call directly.
334:      * @param  string  name
335:      * @param  mixed   value
336:      * @return void
337:      */
338:     public function __set($name, $value)
339:     {
340:         $this->params[$name] = $value;
341:     }
342: 
343: 
344: 
345:     /**
346:      * Returns a template parameter. Do not call directly.
347:      * @param  string  name
348:      * @return mixed  value
349:      */
350:     public function &__get($name)
351:     {
352:         if (!array_key_exists($name, $this->params)) {
353:             trigger_error("The variable '$name' does not exist in template.", E_USER_NOTICE);
354:         }
355: 
356:         return $this->params[$name];
357:     }
358: 
359: 
360: 
361:     /**
362:      * Determines whether parameter is defined. Do not call directly.
363:      * @param  string    name
364:      * @return bool
365:      */
366:     public function __isset($name)
367:     {
368:         return isset($this->params[$name]);
369:     }
370: 
371: 
372: 
373:     /**
374:      * Removes a template parameter. Do not call directly.
375:      * @param  string    name
376:      * @return void
377:      */
378:     public function __unset($name)
379:     {
380:         unset($this->params[$name]);
381:     }
382: 
383: 
384: 
385:     /********************* caching ****************d*g**/
386: 
387: 
388: 
389:     /**
390:      * Set cache storage.
391:      * @param  Cache
392:      * @return Template  provides a fluent interface
393:      */
394:     public function setCacheStorage(ICacheStorage $storage)
395:     {
396:         $this->cacheStorage = $storage;
397:         return $this;
398:     }
399: 
400: 
401: 
402:     /**
403:      * @return ICacheStorage
404:      */
405:     public function getCacheStorage()
406:     {
407:         if ($this->cacheStorage === NULL) {
408:             return new DevNullStorage;
409:         }
410:         return $this->cacheStorage;
411:     }
412: 
413: 
414: 
415:     /********************* tools ****************d*g**/
416: 
417: 
418: 
419:     /**
420:      * Extracts all blocks of PHP code.
421:      * @param  string
422:      * @param  array
423:      * @return string
424:      */
425:     private static function extractPhp($source, & $blocks)
426:     {
427:         $res = '';
428:         $blocks = array();
429:         $tokens = token_get_all($source);
430:         foreach ($tokens as $n => $token) {
431:             if (is_array($token)) {
432:                 if ($token[0] === T_INLINE_HTML || $token[0] === T_CLOSE_TAG) {
433:                     $res .= $token[1];
434:                     continue;
435: 
436:                 } elseif ($token[0] === T_OPEN_TAG && $token[1] === '<?' && isset($tokens[$n+1][1]) && $tokens[$n+1][1] === 'xml') {
437:                     $php = & $res;
438:                     $token[1] = '<<?php ?>?';
439: 
440:                 } elseif ($token[0] === T_OPEN_TAG || $token[0] === T_OPEN_TAG_WITH_ECHO) {
441:                     $res .= $id = "<?php \x01@php:p" . count($blocks) . "@\x02";
442:                     $php = & $blocks[$id];
443:                 }
444:                 $php .= $token[1];
445: 
446:             } else {
447:                 $php .= $token;
448:             }
449:         }
450:         return $res;
451:     }
452: 
453: }
454: 
Nette Framework 2.0.1 (for PHP 5.2, un-prefixed) API API documentation generated by ApiGen 2.7.0