34 |
35 | 
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 | Now pass the template to StampTE:
44 |
45 | $se = new StampTE($templateHTML);
46 |
47 | To obtain the diamond image:
48 |
49 | $diamond = $se->getDiamond();
50 | echo $diamond;
51 |
52 | Result:
53 |
54 |
55 |
36 |
37 |
56 |
57 | And.. to put some diamonds in the jewellery box:
58 |
59 |
60 | $se->jewellery->add($diamond);
61 |
62 |
63 | Easy!
64 |
65 | Notice November 2025:
66 | the Stampte.com domain no longer works.
67 | I am moving this project to a different site and rename it.
68 |
69 | Advantages
70 | ----------
71 |
72 | * Clean, code-free HTML templates, No PHP in your HTML
73 | * Compact presentation logic free of any HTML
74 | * No new syntax to learn, uses basic HTML markers already in use by many frontend developers to clarify document structure
75 | * Templates do not have to be converted to be used with PHP logic (toll free template upgrades)
76 | * Templates are presentable before integration because they may contain dummy data which is removed by StampTE
77 | * Easy to exchange templates, templates are ready to use
78 | * Very suitable for advanced UI development and complex templates for games
79 | * Templates become self-documenting, PHP code becomes more readable (less bugs)
80 | * Automatically strips HTML comments
81 | * Integrated caching system
82 | * Automatically escapes strings for Unicode (X)HTML documents
83 | * Just ONE little file
84 | * Unit tested, high quality code
85 | * Open Source, BSD license
86 |
87 |
88 |
89 |
--------------------------------------------------------------------------------
/examples.php:
--------------------------------------------------------------------------------
1 |
23 | ';
84 | $bt = '
85 |
86 |
87 | 
88 |
89 |
90 | ';
91 |
92 | $v = new StampTE( $vt );
93 | $b = new StampTE( $bt );
94 | $tavern = $b->getTavern();
95 | $v->village->add( $tavern );
96 |
97 | echo "\n\n\n".$v;
98 |
99 | exit;
100 |
--------------------------------------------------------------------------------
/Templates/dialog.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
88 |
89 |
176 | * $stpl = new StampTE( $tpl );
177 | * $stpl->getX(); //where X is cut point
178 | *
179 | *
180 | * @param string $tpl HTML Template
181 | * @param string $id identification string for this template
182 | */
183 | public function __construct( $tpl='', $id='root' )
184 | {
185 | if ( is_null( $tpl ) ) $tpl = '';
186 |
187 | if ( is_object( $tpl ) && !method_exists( $tpl, '__toString' ) ) $tpl = '['.get_class( $tpl ).' instance]';
188 |
189 | $tpl = (string) $tpl;
190 |
191 | $this->id = strval( $id );
192 | $this->template = $tpl;
193 | $this->matches = array();
194 | $pattern = '/\s*(.*)?/sU';
195 | $me = $this;
196 | $slots = &$this->slots;
197 |
198 | $this->template = preg_replace_callback( $pattern, function( $matches ) use ( $me, &$slots ) {
199 | list( , $type, $id, $snippet ) = $matches;
200 | if ( $type === 'cut' ) {
201 | $me->addToSketchBook( $id, $snippet );
202 | return '';
203 | } else {
204 | $slots[$id] = TRUE;
205 | return "#$id#";
206 | }
207 | }, $this->template );
208 |
209 | $this->template = preg_replace( '/#([^\?\s#]+)(\?)?#/sU', '#&$1$2#', $this->template );
210 | }
211 |
212 | /**
213 | * Internal method that needs to be public because PHP is too stupid to understand
214 | * $this in closures.
215 | *
216 | * @param string $id
217 | * @param string $snippet
218 | */
219 | public function addToSketchBook( $id, $snippet )
220 | {
221 | $this->catalogue[$id] = count( $this->sketchBook );
222 | $this->sketchBook[] = $snippet;
223 | }
224 |
225 | /**
226 | * Creates an instance of StampTE template using a file.
227 | *
228 | * @param string $filename file containing HTML input
229 | *
230 | * @return static
231 | */
232 | public static function load( $filename )
233 | {
234 | if ( !file_exists( $filename ) ) throw new StampTEException( '[S001] Could not find file: ' . $filename );
235 | $template = file_get_contents( $filename );
236 | return new static( $template );
237 | }
238 |
239 | /**
240 | * Checks whether a snippet with ID $id is in the catalogue.
241 | *
242 | * @param string $id identifier you are looking for
243 | *
244 | * @return boolean $yesNo whether the snippet with this ID is available or not.
245 | */
246 | public function inCatalogue( $id )
247 | {
248 | return ( boolean ) ( isset( $this->catalogue[$id] ) );
249 | }
250 |
251 | /**
252 | * Returns a new instance of StampTE configured with the template
253 | * that corresponds to the specified ID.
254 | *
255 | * @param string $id identifier
256 | *
257 | * @return StampTE $snippet
258 | */
259 | public function get( $id )
260 | {
261 | if ( strpos( $id, '.') !== FALSE) {
262 | $parts = ( explode( '.', $id ) );
263 | $id = reset( $parts );
264 | array_shift( $parts );
265 | $rest = implode( '.', $parts );
266 | }
267 |
268 | if ( $this->inCatalogue( $id ) ) {
269 | $snippet = $this->sketchBook[$this->catalogue[$id]];
270 | if ( $this->factory ) {
271 | $new = call_user_func_array( $this->factory, array( $snippet, $id ) );
272 | } else {
273 | $new = new static( $snippet, $id );
274 | }
275 | //Pass the translator and the factory.
276 | $new->translator = $this->translator;
277 | $new->factory = $this->factory;
278 |
279 | if ( isset( $parts ) ) {
280 | return $new->get( $rest );
281 | } else {
282 | return $new;
283 | }
284 | } else {
285 | throw new StampTEException( '[S101] Cannot find Stamp Snippet with ID '.preg_replace( '/\W/', '', $id ) );
286 | }
287 | }
288 |
289 | /**
290 | * Collects snippets from the template.
291 | * $list needs to be a | pipe separated list of snippet IDs. The snippets
292 | * will be returned as an array so you can obtain them using the list()
293 | * statement.
294 | *
295 | * @param string $list List of IDs you want to fetch from template
296 | *
297 | * @return array $snippets Snippets obtained from template
298 | */
299 | public function collect( $list )
300 | {
301 | if ( isset( $this->cache[$list] ) ) return $this->cache[$list];
302 |
303 | $listItems = explode( '|', $list );
304 |
305 | $collection = array();
306 | foreach( $listItems as $item ) {
307 | $collection[] = $this->get( $item );
308 | }
309 |
310 | return $collection;
311 | }
312 |
313 | /**
314 | * Returns a snippet/template as a string. Besides converting the instance
315 | * to a string this function removes all HTML comments and unnecessary space.
316 | * If you don't want this use a different toString method like ->getString()
317 | *
318 | * @return string $string string representation of HTML snippet/template
319 | */
320 | public function __toString()
321 | {
322 | $template = $this->template;
323 | $template = preg_replace( "/\s*/m", "", $template );
324 |
325 | if ( strpos($template, '#&' ) !== FALSE ) {
326 | $template = preg_replace( "/data\-stampte=\"#\&\w+\?#\"/m", "", $template );
327 | $template = preg_replace( "/#\&\w+\?#/m", "", $template );
328 | }
329 |
330 | if ( self::$clearws ) $template = preg_replace( '/\s*/m', '', $template );
331 | return $template;
332 | }
333 |
334 | /**
335 | * Returns the template as a string.
336 | *
337 | * @return string $raw raw template
338 | */
339 | public function getString() {
340 | return $this->template;
341 | }
342 |
343 | /**
344 | * Glues a snippet to a glue point in the current snippet/template.
345 | * The glue() method also accepts raw strings.
346 | *
347 | * The glue method will append the Stamp object or string specified in
348 | * $snippet to the template at the glue point marked by the glue point marker,
349 | * i.e. where X is the name of the glue point.
350 | * A glue point can have conditions, in this case you MUST provide a Stamp
351 | * object rather than a raw string because the ID of the object needs to be checked.
352 | * Conditional glue points have the format: where Y,Z are the
353 | * allowed IDS (from the cut markers).
354 | *
355 | * Note that conditional glue points are rather slow. Consider writing a small shell
356 | * script to remove the conditions before deploying your templates to a production
357 | * environment (assuming they're not needed there).
358 | *
359 | * If you pass a raw string for a conditional glue point you'll get a S003 exception.
360 | * If your Stamp object is rejected by the glue point you'll get a S102 exception.
361 | *
362 | * @throws StampTEException
363 | *
364 | * @param string $what ID of the Glue Point you want to append the contents of the snippet to.
365 | * @param StampTE|string $snippet a StampTE snippet/template to be glued at this point
366 | *
367 | * @return StampTE $snippet self, chainable
368 | */
369 | public function glue( $what, $snippet )
370 | {
371 | $matches = array();
372 |
373 | $pattern = "";
377 | $clear = (self::$clearws) ? '' : '';
378 | $replacement = $clear.$snippet.$pattern;
379 | $this->template = str_replace( $pattern, $replacement, $this->template );
380 | return $this;
381 | }
382 |
383 | $pattern = '/\s*/u';
384 |
385 | $this->template = preg_replace_callback( $pattern, function( $matches ) use ( $snippet, $what ) {
386 | $copyOrig = $matches[0];
387 |
388 | if ( isset($matches[2]) ) {
389 |
390 | if ( !is_object( $snippet ) ) throw new StampTEException( '[S003] Snippet is not an object or string. Conditional glue point requires object.' );
391 |
392 | $allowedSnippets = $matches[2];
393 | $allowedMap = array_flip( explode( ',', $allowedSnippets ) );
394 | if ( !isset( $allowedMap[$snippet->getID()] ) ) throw new StampTEException( '[S102] Snippet '.$snippet->getID().' not allowed in slot '.$what );
395 | }
396 |
397 | return $snippet.$copyOrig;
398 |
399 | }, $this->template );
400 |
401 | return $this;
402 | }
403 |
404 | /**
405 | * Glues all elements in the specified array.
406 | * This is a quick way to glue multiple elements as well.
407 | *
408 | * @param array $map list of key=>value pairs to glue
409 | *
410 | * @return StampTE $snippet self, chainable
411 | */
412 | public function glueAll( $map )
413 | {
414 | foreach( $map as $slot => $value ) {
415 | if ( is_array( $value ) ) {
416 | foreach( $value as $item ) {
417 | $this->glue( $slot, $item );
418 | }
419 | } else {
420 | $this->glue( $slot, $value );
421 | }
422 | }
423 | return $this;
424 | }
425 |
426 | /**
427 | * Injects a piece of data into the slot marker in the snippet/template.
428 | *
429 | * @param string $where ID of the slot where to inject the data
430 | * @param string $data the data to inject in the slot
431 | * @param boolean $raw if TRUE output will not be escaped
432 | *
433 | * @return StampTE $snippet self, chainable
434 | */
435 | public function inject( $slot, $data, $raw = FALSE )
436 | {
437 | if ( !$raw ) $data = $this->filter( $data );
438 |
439 | $where = "#&$slot#";
440 | $whereOpt = "#&$slot?#";
441 |
442 | $this->template = str_replace( $where, $data, $this->template );
443 | $this->template = str_replace( $whereOpt, $data, $this->template );
444 |
445 | return $this;
446 | }
447 |
448 | /**
449 | * Injects a piece of data into an attribute slot marker in the snippet/template.
450 | *
451 | * @param string $slot name of the slot where the data should be injected
452 | * @param string $data the data to be injected in the slot
453 | * @param boolean $raw if TRUE output will not be escaped
454 | *
455 | * @return StampTE
456 | */
457 | public function injectAttr( $slot, $data, $raw = FALSE )
458 | {
459 | if ( !$raw ) $data = $this->filter( $data );
460 |
461 | $where = "data-stampte=\"#&$slot#\"";
462 | $whereOpt = "data-stampte=\"#&$slot?#\"";
463 |
464 | $this->template = str_replace( $where, $data, $this->template );
465 | $this->template = str_replace( $whereOpt, $data, $this->template );
466 |
467 | return $this;
468 | }
469 |
470 | /**
471 | * Alias for inject($where,$data,TRUE)
472 | *
473 | * @param string $where ID of the slot where to inject the data
474 | * @param string $data the data to inject in the slot
475 | *
476 | * @return StampTE $snippet self, chainable
477 | */
478 | public function injectRaw( $where, $data )
479 | {
480 | return $this->inject( $where, $data, TRUE );
481 | }
482 |
483 | /**
484 | * Same as inject() but injects an entire array of slot->data pairs.
485 | *
486 | * @param array $array Array of slot->data pairs
487 | * @param boolean $raw if TRUE output will not be escaped
488 | *
489 | * @return StampTE self, chainable
490 | */
491 | public function injectAll( $array, $raw = FALSE )
492 | {
493 | foreach( $array as $key => $value ) {
494 | $this->inject( $key, $value, $raw );
495 | }
496 | return $this;
497 | }
498 |
499 | /**
500 | * Returns the identifier of the current snippet/template.
501 | *
502 | * @return string $id ID of this snippet/template
503 | */
504 | public function getID()
505 | {
506 | return $this->id;
507 | }
508 |
509 | /**
510 | * Copies the current snippet/template.
511 | *
512 | * @return StampTE $copy Copy of the current template/snippet
513 | */
514 | public function copy()
515 | {
516 | return clone( $this );
517 | }
518 |
519 | /**
520 | * Collects a list, just like collect() but stores result in cache array.
521 | *
522 | * @param string $list Pipe separated list of IDs.
523 | *
524 | * @return self
525 | */
526 | public function writeToCache( $list )
527 | {
528 | $this->cache[$list] = $this->collect( $list );
529 | return $this;
530 | }
531 |
532 | /**
533 | * Returns the cache object for storage to disk.
534 | *
535 | * @return string $cache serialized cache object.
536 | */
537 | public function getCache()
538 | {
539 | return serialize( $this->cache );
540 | }
541 |
542 | /**
543 | * Loads cache data.
544 | *
545 | * @param string $rawCacheData the serialized cached string as retrieved from getCache().
546 | *
547 | * @return self
548 | */
549 | public function loadIntoCache( $rawCacheData )
550 | {
551 | $this->cache = unserialize( $rawCacheData );
552 |
553 | if ( !is_array( $this->cache ) ) throw new StampTEException( '[S004] Failed to unserialize cache object.' );
554 |
555 | return $this;
556 | }
557 |
558 | /**
559 | * Filters data.
560 | *
561 | * @param string $string
562 | *
563 | * @return string $string
564 | */
565 | protected function filter( $data )
566 | {
567 | $data = iconv("UTF-8","UTF-8//IGNORE", $data);
568 | $filtered = htmlspecialchars( $data, ENT_QUOTES, 'UTF-8' );
569 | $filtered = str_replace( '`', '`', $filtered ); //Prevent MSIE backtick XSS hack
570 | return $filtered;
571 | }
572 |
573 | /**
574 | * Selects a Glue Point to attach a Stamp to.
575 | * Note that although this seems like a getter this method
576 | * actually returns the same StampTE. It's both evil and beautiful at the same time.
577 | *
578 | * @param string $gluePoint
579 | *
580 | * @return StampTE
581 | */
582 | public function &__get( $gluePoint )
583 | {
584 | $this->select = $gluePoint;
585 | return $this;
586 | }
587 |
588 | /**
589 | * Call interceptor.
590 | * Intercepts:
591 | * - getX(), routes to get('X')
592 | * - setX(Y), routes to inject('X',Y)
593 | */
594 | public function __call($method, $arguments)
595 | {
596 | if ( strpos( $method, 'get' ) === 0 ) {
597 | return $this->get( lcfirst( substr( $method, 3) ) );
598 | } elseif ( strpos( $method, 'set' ) === 0 ) {
599 | $this->inject( lcfirst( substr( $method, 3 ) ), $arguments[0] );
600 | return $this;
601 | } elseif ( strpos( $method, 'say' ) ===0 ) {
602 | $this->inject( lcfirst( substr( $method, 3) ), call_user_func_array( $this->translator, $arguments ) );
603 | return $this;
604 | }
605 | }
606 |
607 | /**
608 | * Glues the specified Stamp object to the currently selected
609 | * Glue Point.
610 | *
611 | * @param StampTE $stamp
612 | */
613 | public function add( StampTE $stamp )
614 | {
615 | if ( $this->select === NULL ) {
616 | $this->select = 'self'.$stamp->getID();
617 | }
618 | $this->glue( $this->select, $stamp );
619 | $this->select = NULL; //reset
620 | return $this;
621 | }
622 |
623 | /**
624 | * Sets the translator function to be used for translations.
625 | * The translator function will be called automatically as soon as you invoke the magic
626 | * method:
627 | *
628 | * sayX(Y) where X is the slot you want to inject the contents of Y into.
629 | *
630 | * Note that optional arguments are allowed and passed to the translator.
631 | *
632 | * @param closure $closure
633 | */
634 | public function setTranslator( $closure )
635 | {
636 | if ( !is_callable( $closure ) ) throw new StampTEException( '[S005] Invalid Translator. Translator must be callable.' );
637 |
638 | $this->translator = $closure;
639 | }
640 |
641 | /**
642 | * Sets the object factory. If get(X) gets called StampTE will call the
643 | * factory with template and ID for X to give you the opportunity to
644 | * wrap the template object in your own wrapper class.
645 | *
646 | * @param closure $factory
647 | */
648 | public function setFactory( $factory )
649 | {
650 | if ( !is_callable( $factory ) ) throw new StampTEException( '[S006] Invalid Factory. Factory must be callable.' );
651 |
652 | $this->factory = $factory;
653 | }
654 |
655 | /**
656 | * Attr is a shortcut to quickly set an attribute.
657 | *
658 | * @param string $slot slot
659 | * @param boolean $onOff whether to fill in the slot or not
660 | *
661 | * @return StampTE
662 | */
663 | public function attr( $slot, $onOff = TRUE )
664 | {
665 | return ( $onOff ) ? $this->injectAttr( $slot, $slot ) : $this;
666 | }
667 | }
668 | //Stamp Exception
669 | class StampTEException extends \Exception {}
670 |
--------------------------------------------------------------------------------
/phpdialog.php:
--------------------------------------------------------------------------------
1 |
141 | * $tpl = StampTE::createHtml5Utf8Document();
142 | * $tpl->setTitle('Welcome to StampTE'); //set the title.
143 | * $tpl->head->add( $linkTag ); //Add stylesheets and scripts!
144 | * $tpl->body->add( $myDocument ); //Add your body content!
145 | *
146 | *
147 | * @return StampTE template
148 | */
149 | public static function createHtml5Utf8Document()
150 | {
151 | return self::fromFile( __dir__ . '/html5document.html' );
152 | }
153 |
154 | /**
155 | * Returns a Stamp instance using the contents of the specified
156 | * file.
157 | *
158 | * @param string $fname path to file to read
159 | *
160 | * @return StampTE
161 | */
162 | public static function fromFile( $fname )
163 | {
164 | return new self( file_get_contents( $fname ) );
165 | }
166 |
167 | /**
168 | * Constructor. Pass nothing if you plan to use cache.
169 | * Creates a new Stamp object from a string.
170 | * Upon constructing a Stamp object the string will be parsed.
171 | * All cut points, i.e. Y will
172 | * be collected and stored in the internal 'sketchbook'.
173 | * They can now be used as HTML snippets like this:
174 | *
175 | *
176 | * $stpl = new StampTE( $tpl );
177 | * $stpl->getX(); //where X is cut point
178 | *
179 | *
180 | * @param string $tpl HTML Template
181 | * @param string $id identification string for this template
182 | */
183 | public function __construct( $tpl='', $id='root' )
184 | {
185 | if ( is_null( $tpl ) ) $tpl = '';
186 |
187 | if ( is_object( $tpl ) && !method_exists( $tpl, '__toString' ) ) $tpl = '['.get_class( $tpl ).' instance]';
188 |
189 | $tpl = (string) $tpl;
190 |
191 | $this->id = strval( $id );
192 | $this->template = $tpl;
193 | $this->matches = array();
194 | $pattern = '/\s*(.*)?/sU';
195 | $me = $this;
196 | $slots = &$this->slots;
197 |
198 | $this->template = preg_replace_callback( $pattern, function( $matches ) use ( $me, &$slots ) {
199 | list( , $type, $id, $snippet ) = $matches;
200 | if ( $type === 'cut' ) {
201 | $me->addToSketchBook( $id, $snippet );
202 | return '';
203 | } else {
204 | $slots[$id] = TRUE;
205 | return "#$id#";
206 | }
207 | }, $this->template );
208 |
209 | $this->template = preg_replace( '/#([^\?\s#]+)(\?)?#/sU', '#&$1$2#', $this->template );
210 | }
211 |
212 | /**
213 | * Internal method that needs to be public because PHP is too stupid to understand
214 | * $this in closures.
215 | *
216 | * @param string $id
217 | * @param string $snippet
218 | */
219 | public function addToSketchBook( $id, $snippet )
220 | {
221 | $this->catalogue[$id] = count( $this->sketchBook );
222 | $this->sketchBook[] = $snippet;
223 | }
224 |
225 | /**
226 | * Creates an instance of StampTE template using a file.
227 | *
228 | * @param string $filename file containing HTML input
229 | *
230 | * @return static
231 | */
232 | public static function load( $filename )
233 | {
234 | if ( !file_exists( $filename ) ) throw new StampTEException( '[S001] Could not find file: ' . $filename );
235 | $template = file_get_contents( $filename );
236 | return new static( $template );
237 | }
238 |
239 | /**
240 | * Checks whether a snippet with ID $id is in the catalogue.
241 | *
242 | * @param string $id identifier you are looking for
243 | *
244 | * @return boolean $yesNo whether the snippet with this ID is available or not.
245 | */
246 | public function inCatalogue( $id )
247 | {
248 | return ( boolean ) ( isset( $this->catalogue[$id] ) );
249 | }
250 |
251 | /**
252 | * Returns a new instance of StampTE configured with the template
253 | * that corresponds to the specified ID.
254 | *
255 | * @param string $id identifier
256 | *
257 | * @return StampTE $snippet
258 | */
259 | public function get( $id )
260 | {
261 | if ( strpos( $id, '.') !== FALSE) {
262 | $parts = ( explode( '.', $id ) );
263 | $id = reset( $parts );
264 | array_shift( $parts );
265 | $rest = implode( '.', $parts );
266 | }
267 |
268 | if ( $this->inCatalogue( $id ) ) {
269 | $snippet = $this->sketchBook[$this->catalogue[$id]];
270 | if ( $this->factory ) {
271 | $new = call_user_func_array( $this->factory, array( $snippet, $id ) );
272 | } else {
273 | $new = new static( $snippet, $id );
274 | }
275 | //Pass the translator and the factory.
276 | $new->translator = $this->translator;
277 | $new->factory = $this->factory;
278 |
279 | if ( isset( $parts ) ) {
280 | return $new->get( $rest );
281 | } else {
282 | return $new;
283 | }
284 | } else {
285 | throw new StampTEException( '[S101] Cannot find Stamp Snippet with ID '.preg_replace( '/\W/', '', $id ) );
286 | }
287 | }
288 |
289 | /**
290 | * Collects snippets from the template.
291 | * $list needs to be a | pipe separated list of snippet IDs. The snippets
292 | * will be returned as an array so you can obtain them using the list()
293 | * statement.
294 | *
295 | * @param string $list List of IDs you want to fetch from template
296 | *
297 | * @return array $snippets Snippets obtained from template
298 | */
299 | public function collect( $list )
300 | {
301 | if ( isset( $this->cache[$list] ) ) return $this->cache[$list];
302 |
303 | $listItems = explode( '|', $list );
304 |
305 | $collection = array();
306 | foreach( $listItems as $item ) {
307 | $collection[] = $this->get( $item );
308 | }
309 |
310 | return $collection;
311 | }
312 |
313 | /**
314 | * Returns a snippet/template as a string. Besides converting the instance
315 | * to a string this function removes all HTML comments and unnecessary space.
316 | * If you don't want this use a different toString method like ->getString()
317 | *
318 | * @return string $string string representation of HTML snippet/template
319 | */
320 | public function __toString()
321 | {
322 | $template = $this->template;
323 | $template = preg_replace( "/\s*/m", "", $template );
324 |
325 | if ( strpos($template, '#&' ) !== FALSE ) {
326 | $template = preg_replace( "/data\-stampte=\"#\&\w+\?#\"/m", "", $template );
327 | $template = preg_replace( "/#\&\w+\?#/m", "", $template );
328 | }
329 |
330 | if ( self::$clearws ) $template = preg_replace( '/\s*/m', '', $template );
331 | return $template;
332 | }
333 |
334 | /**
335 | * Returns the template as a string.
336 | *
337 | * @return string $raw raw template
338 | */
339 | public function getString() {
340 | return $this->template;
341 | }
342 |
343 | /**
344 | * Glues a snippet to a glue point in the current snippet/template.
345 | * The glue() method also accepts raw strings.
346 | *
347 | * The glue method will append the Stamp object or string specified in
348 | * $snippet to the template at the glue point marked by the glue point marker,
349 | * i.e. where X is the name of the glue point.
350 | * A glue point can have conditions, in this case you MUST provide a Stamp
351 | * object rather than a raw string because the ID of the object needs to be checked.
352 | * Conditional glue points have the format: where Y,Z are the
353 | * allowed IDS (from the cut markers).
354 | *
355 | * Note that conditional glue points are rather slow. Consider writing a small shell
356 | * script to remove the conditions before deploying your templates to a production
357 | * environment (assuming they're not needed there).
358 | *
359 | * If you pass a raw string for a conditional glue point you'll get a S003 exception.
360 | * If your Stamp object is rejected by the glue point you'll get a S102 exception.
361 | *
362 | * @throws StampTEException
363 | *
364 | * @param string $what ID of the Glue Point you want to append the contents of the snippet to.
365 | * @param StampTE|string $snippet a StampTE snippet/template to be glued at this point
366 | *
367 | * @return StampTE $snippet self, chainable
368 | */
369 | public function glue( $what, $snippet )
370 | {
371 | $matches = array();
372 |
373 | $pattern = "";
377 | $clear = (self::$clearws) ? '' : '';
378 | $replacement = $clear.$snippet.$pattern;
379 | $this->template = str_replace( $pattern, $replacement, $this->template );
380 | return $this;
381 | }
382 |
383 | $pattern = '/\s*/u';
384 |
385 | $this->template = preg_replace_callback( $pattern, function( $matches ) use ( $snippet, $what ) {
386 | $copyOrig = $matches[0];
387 |
388 | if ( isset($matches[2]) ) {
389 |
390 | if ( !is_object( $snippet ) ) throw new StampTEException( '[S003] Snippet is not an object or string. Conditional glue point requires object.' );
391 |
392 | $allowedSnippets = $matches[2];
393 | $allowedMap = array_flip( explode( ',', $allowedSnippets ) );
394 | if ( !isset( $allowedMap[$snippet->getID()] ) ) throw new StampTEException( '[S102] Snippet '.$snippet->getID().' not allowed in slot '.$what );
395 | }
396 |
397 | return $snippet.$copyOrig;
398 |
399 | }, $this->template );
400 |
401 | return $this;
402 | }
403 |
404 | /**
405 | * Glues all elements in the specified array.
406 | * This is a quick way to glue multiple elements as well.
407 | *
408 | * @param array $map list of key=>value pairs to glue
409 | *
410 | * @return StampTE $snippet self, chainable
411 | */
412 | public function glueAll( $map )
413 | {
414 | foreach( $map as $slot => $value ) {
415 | if ( is_array( $value ) ) {
416 | foreach( $value as $item ) {
417 | $this->glue( $slot, $item );
418 | }
419 | } else {
420 | $this->glue( $slot, $value );
421 | }
422 | }
423 | return $this;
424 | }
425 |
426 | /**
427 | * Injects a piece of data into the slot marker in the snippet/template.
428 | *
429 | * @param string $where ID of the slot where to inject the data
430 | * @param string $data the data to inject in the slot
431 | * @param boolean $raw if TRUE output will not be escaped
432 | *
433 | * @return StampTE $snippet self, chainable
434 | */
435 | public function inject( $slot, $data, $raw = FALSE )
436 | {
437 | if ( !$raw ) $data = $this->filter( $data );
438 |
439 | $where = "#&$slot#";
440 | $whereOpt = "#&$slot?#";
441 |
442 | $this->template = str_replace( $where, $data, $this->template );
443 | $this->template = str_replace( $whereOpt, $data, $this->template );
444 |
445 | return $this;
446 | }
447 |
448 | /**
449 | * Injects a piece of data into an attribute slot marker in the snippet/template.
450 | *
451 | * @param string $slot name of the slot where the data should be injected
452 | * @param string $data the data to be injected in the slot
453 | * @param boolean $raw if TRUE output will not be escaped
454 | *
455 | * @return StampTE
456 | */
457 | public function injectAttr( $slot, $data, $raw = FALSE )
458 | {
459 | if ( !$raw ) $data = $this->filter( $data );
460 |
461 | $where = "data-stampte=\"#&$slot#\"";
462 | $whereOpt = "data-stampte=\"#&$slot?#\"";
463 |
464 | $this->template = str_replace( $where, $data, $this->template );
465 | $this->template = str_replace( $whereOpt, $data, $this->template );
466 |
467 | return $this;
468 | }
469 |
470 | /**
471 | * Alias for inject($where,$data,TRUE)
472 | *
473 | * @param string $where ID of the slot where to inject the data
474 | * @param string $data the data to inject in the slot
475 | *
476 | * @return StampTE $snippet self, chainable
477 | */
478 | public function injectRaw( $where, $data )
479 | {
480 | return $this->inject( $where, $data, TRUE );
481 | }
482 |
483 | /**
484 | * Same as inject() but injects an entire array of slot->data pairs.
485 | *
486 | * @param array $array Array of slot->data pairs
487 | * @param boolean $raw if TRUE output will not be escaped
488 | *
489 | * @return StampTE self, chainable
490 | */
491 | public function injectAll( $array, $raw = FALSE )
492 | {
493 | foreach( $array as $key => $value ) {
494 | $this->inject( $key, $value, $raw );
495 | }
496 | return $this;
497 | }
498 |
499 | /**
500 | * Returns the identifier of the current snippet/template.
501 | *
502 | * @return string $id ID of this snippet/template
503 | */
504 | public function getID()
505 | {
506 | return $this->id;
507 | }
508 |
509 | /**
510 | * Copies the current snippet/template.
511 | *
512 | * @return StampTE $copy Copy of the current template/snippet
513 | */
514 | public function copy()
515 | {
516 | return clone( $this );
517 | }
518 |
519 | /**
520 | * Collects a list, just like collect() but stores result in cache array.
521 | *
522 | * @param string $list Pipe separated list of IDs.
523 | *
524 | * @return self
525 | */
526 | public function writeToCache( $list )
527 | {
528 | $this->cache[$list] = $this->collect( $list );
529 | return $this;
530 | }
531 |
532 | /**
533 | * Returns the cache object for storage to disk.
534 | *
535 | * @return string $cache serialized cache object.
536 | */
537 | public function getCache()
538 | {
539 | return serialize( $this->cache );
540 | }
541 |
542 | /**
543 | * Loads cache data.
544 | *
545 | * @param string $rawCacheData the serialized cached string as retrieved from getCache().
546 | *
547 | * @return self
548 | */
549 | public function loadIntoCache( $rawCacheData )
550 | {
551 | $this->cache = unserialize( $rawCacheData );
552 |
553 | if ( !is_array( $this->cache ) ) throw new StampTEException( '[S004] Failed to unserialize cache object.' );
554 |
555 | return $this;
556 | }
557 |
558 | /**
559 | * Filters data.
560 | *
561 | * @param string $string
562 | *
563 | * @return string $string
564 | */
565 | protected function filter( $data )
566 | {
567 | $data = iconv("UTF-8","UTF-8//IGNORE", $data);
568 | $filtered = htmlspecialchars( $data, ENT_QUOTES, 'UTF-8' );
569 | $filtered = str_replace( '`', '`', $filtered ); //Prevent MSIE backtick XSS hack
570 | return $filtered;
571 | }
572 |
573 | /**
574 | * Selects a Glue Point to attach a Stamp to.
575 | * Note that although this seems like a getter this method
576 | * actually returns the same StampTE. It's both evil and beautiful at the same time.
577 | *
578 | * @param string $gluePoint
579 | *
580 | * @return StampTE
581 | */
582 | public function &__get( $gluePoint )
583 | {
584 | $this->select = $gluePoint;
585 | return $this;
586 | }
587 |
588 | /**
589 | * Call interceptor.
590 | * Intercepts:
591 | * - getX(), routes to get('X')
592 | * - setX(Y), routes to inject('X',Y)
593 | */
594 | public function __call($method, $arguments)
595 | {
596 | if ( strpos( $method, 'get' ) === 0 ) {
597 | return $this->get( lcfirst( substr( $method, 3) ) );
598 | } elseif ( strpos( $method, 'set' ) === 0 ) {
599 | $this->inject( lcfirst( substr( $method, 3 ) ), $arguments[0] );
600 | return $this;
601 | } elseif ( strpos( $method, 'say' ) ===0 ) {
602 | $this->inject( lcfirst( substr( $method, 3) ), call_user_func_array( $this->translator, $arguments ) );
603 | return $this;
604 | }
605 | }
606 |
607 | /**
608 | * Glues the specified Stamp object to the currently selected
609 | * Glue Point.
610 | *
611 | * @param StampTE $stamp
612 | */
613 | public function add( StampTE $stamp )
614 | {
615 | if ( $this->select === NULL ) {
616 | $this->select = 'self'.$stamp->getID();
617 | }
618 | $this->glue( $this->select, $stamp );
619 | $this->select = NULL; //reset
620 | return $this;
621 | }
622 |
623 | /**
624 | * Sets the translator function to be used for translations.
625 | * The translator function will be called automatically as soon as you invoke the magic
626 | * method:
627 | *
628 | * sayX(Y) where X is the slot you want to inject the contents of Y into.
629 | *
630 | * Note that optional arguments are allowed and passed to the translator.
631 | *
632 | * @param closure $closure
633 | */
634 | public function setTranslator( $closure )
635 | {
636 | if ( !is_callable( $closure ) ) throw new StampTEException( '[S005] Invalid Translator. Translator must be callable.' );
637 |
638 | $this->translator = $closure;
639 | }
640 |
641 | /**
642 | * Sets the object factory. If get(X) gets called StampTE will call the
643 | * factory with template and ID for X to give you the opportunity to
644 | * wrap the template object in your own wrapper class.
645 | *
646 | * @param closure $factory
647 | */
648 | public function setFactory( $factory )
649 | {
650 | if ( !is_callable( $factory ) ) throw new StampTEException( '[S006] Invalid Factory. Factory must be callable.' );
651 |
652 | $this->factory = $factory;
653 | }
654 |
655 | /**
656 | * Attr is a shortcut to quickly set an attribute.
657 | *
658 | * @param string $slot slot
659 | * @param boolean $onOff whether to fill in the slot or not
660 | *
661 | * @return StampTE
662 | */
663 | public function attr( $slot, $onOff = TRUE )
664 | {
665 | return ( $onOff ) ? $this->injectAttr( $slot, $slot ) : $this;
666 | }
667 | }
668 | //Stamp Exception
669 | class StampTEException extends \Exception {}
670 | }
671 |
672 | namespace PHPDialog {
673 |
674 | use StampTemplateEngine\StampTE;
675 |
676 | /**
677 | * Dialog class.
678 | *
679 | * PHPDialog is a PHP library to display dialog-like HTML documents
680 | * with just one function call:
681 | *
682 | * Usage:
683 | * Dialog::show( 'Hello', 'World' );
684 | *
685 | */
686 | class Dialog {
687 |
688 | private static $template = <<
690 |
691 |
692 |
693 |
102 |
103 |
';
107 |
108 | $expect = 'region
104 |
105 |
106 |
109 |
';
110 |
111 | $stampTE = new StampTE( $template );
112 | asrt( (string) $stampTE, $expect );
113 |
114 | $template = '
115 |
116 |
';
120 |
121 | $expect = 'region
117 |
118 |
119 |
122 |
';
124 |
125 | $stampTE = new StampTE( $template );
126 | $stampTE->add( $stampTE->getRegion() );
127 | asrt( (string) $stampTE, $expect );
128 |
129 | $template = 'region
123 |
130 |
131 |
';
135 |
136 | $expect = 'region
132 |
133 |
134 |
137 |
';
139 |
140 | $stampTE = new StampTE( $template );
141 | $stampTE->regions->add( $stampTE->getRegion() );
142 | asrt( (string) $stampTE, $expect );
143 |
144 | $template = 'region
138 |
145 |
146 |
';
156 |
157 | $expect = 'region
147 |
148 |
149 |
150 |
151 |
152 | region
153 |
154 |
155 |
158 |
';
160 |
161 | $stampTE = new StampTE( $template );
162 | $stampTE->add( $stampTE->getRegion() );
163 | asrt( (string) $stampTE, $expect );
164 |
165 |
166 | $template = 'region
159 |
167 |
168 |
';
172 |
173 | $expect = '|#value#|
169 |
170 |
171 |
174 |
';
176 |
177 | $stampTE = new StampTE( $template );
178 | $stampTE->regions->add( $stampTE->getRegion()->setValue( 'lorem ipsum' ) );
179 | asrt( (string) $stampTE, $expect );
180 |
181 | $template = '|lorem ipsum|
175 |
182 |
183 |
';
188 |
189 | $expect = '|
184 | #value#|
185 |
186 |
187 |
190 |
';
193 |
194 | $stampTE = new StampTE( $template );
195 | $stampTE->regions->add( $stampTE->getRegion()->setValue( 'lorem ipsum' ) );
196 | asrt( (string) $stampTE, $expect );
197 |
198 |
199 | $template = '|
191 | lorem ipsum|
192 |
200 |
201 |
';
205 |
206 | $expect = '||
202 |
203 |
204 |
207 |
';
209 |
210 | $stampTE = new StampTE( $template );
211 | $stampTE->regions->add( $stampTE->getRegion()->setValue( 'lorem ipsum' ) );
212 | asrt( (string) $stampTE, $expect );
213 |
214 |
215 | $template = '|lorem ipsum|
208 |
216 |
217 |
';
221 |
222 | $expect = '|DEMO|
218 |
219 |
220 |
223 |
';
225 |
226 | $stampTE = new StampTE( $template );
227 | $stampTE->regions->add( $stampTE->getRegion()->setValue( 'lorem ipsum' ) );
228 | asrt( (string) $stampTE, $expect );
229 |
230 | $template = '|lorem ipsum|
224 |
231 |
232 |
';
236 |
237 | $expect = '|#value?#|
233 |
234 |
235 |
238 |
';
240 |
241 | $stampTE = new StampTE( $template );
242 | $stampTE->regions->add( $stampTE->getRegion()->setValue( 'lorem ipsum' ) );
243 | asrt( (string) $stampTE, $expect );
244 |
245 | $template = '|lorem ipsum|
239 |
246 |
247 |
';
252 |
253 | $expect = '|#value?#|
248 |
249 |
250 |
251 |
254 |
';
256 |
257 | $stampTE = new StampTE( $template );
258 | $stampTE->regions->add( $stampTE->getRegion() );
259 | asrt( (string) $stampTE, $expect );
260 |
261 | $template = '||
255 |
262 |
263 |
264 |
';
268 |
269 | $expect = 'region
265 |
266 |
267 |
270 |
271 |
';
273 |
274 | $stampTE = new StampTE( $template );
275 | $stampTE->regions->add( $stampTE->getRegion() );
276 | asrt( (string) $stampTE, $expect );
277 |
278 | testpack( 'Test UTF-8.' );
279 |
280 | $template = 'region
272 |
281 |
282 |
';
286 |
287 | $expect = '象形字
283 |
284 |
285 |
288 |
';
290 |
291 | $stampTE = new StampTE( $template );
292 | $stampTE->regions->add( $stampTE->getRegion() );
293 | asrt( (string) $stampTE, $expect );
294 |
295 | $template = '象形字
289 |
296 |
297 |
';
301 |
302 | $expect = '#value#
298 |
299 |
300 |
303 |
';
305 |
306 | $stampTE = new StampTE( $template );
307 | $stampTE->regions->add( $stampTE->getRegion()->setValue( '象形字' ) );
308 | asrt( (string) $stampTE, $expect );
309 |
310 | $template = '象形字
304 | 象形字
311 |
312 |
';
316 |
317 | $expect = '象形字#value#
313 |
314 |
315 | 象形字
318 |
';
320 |
321 | $stampTE = new StampTE( $template );
322 | $stampTE->regions->add( $stampTE->getRegion()->setValue( '象形字' ) );
323 | asrt( (string) $stampTE, $expect );
324 |
325 | //even the definitions of the cut/paste markers may be UTF-8
326 | $template = '象形字象形字
319 | 象形字
327 |
328 |
';
332 |
333 | $expect = '象形字#value#
329 |
330 |
331 | 象形字
334 |
';
336 |
337 | $stampTE = new StampTE( $template );
338 | $region = $stampTE->get( '測試' );
339 | $region->setValue( '象形字' );
340 | $stampTE->glue( '測試2', $region );
341 | asrt( (string) $stampTE, $expect );
342 |
343 | testpack('Test Cut and Paste Metaphor');
344 |
345 | $template = '
346 | 象形字象形字
335 | -
810 |
811 |
- #todo# 812 | 813 |
-
820 |
- Make Coffee 821 |
-
829 |
830 |
- #todo# 831 | 832 | 833 |
- #todo# 834 | 835 |
-
841 |
- Make Coffee 842 |
-
848 |
849 |
- #todo# 850 | 851 | 852 |
- #todo# 853 | 854 |
-
864 |
- Make Coffee 865 |
- Clean the house 866 |
#slot#
';
1076 | $s = new StampTE( $t );
1077 | $s->inject( 'slot', '' );
1078 | $s->hello->add( new StampTE( '<b><!-- paste:hello --></b>
' );
1080 |
1081 | $t = '#slot#
';
1082 | $s = new StampTE( $t );
1083 | $s->injectRaw( 'slot', '' );
1084 | $s->hello->add( new StampTE( '#slot?#
';
1090 | $s = new StampTE( $t );
1091 | asrt( trim( $s ),'' );
1092 |
1093 | $t = '#slot?#
#slot2?#
';
1094 | $s = new StampTE( $t );
1095 | asrt( trim( $s ), '' );
1096 |
1097 | $t = '#slot?#
';
1098 | $s = new StampTE( $t );
1099 | $s->setSlot( 'Boo!' );
1100 | asrt( trim( $s ), 'Boo!
' );
1101 |
1102 | $t = '#slot?#
#slot?#
';
1103 | $s = new StampTE( $t );
1104 | $s->setSlot( 'Boo!' );
1105 | asrt( trim( $s ), 'Boo!
Boo!
' );
1106 |
1107 | $t = '#slot?#
';
1108 | $s = new StampTE( $t );
1109 | $s->setSlot( '#Boo?#' );
1110 | $s->setBoo( 'Baa' );
1111 | asrt( trim( $s ), '#Boo?#
' );
1112 |
1113 | $t = '#slot?#
';
1114 | $s = new StampTE( $t );
1115 | $s->setSlot( '#&Boo?#' );
1116 | $s->setBoo( 'Baa' );
1117 | asrt( trim( $s ), '#&Boo?#
' );
1118 |
1119 | $t = '#slot?#
';
1120 | $s = new StampTE( $t );
1121 | $s->setSlot( '#&Boo#' );
1122 | $s->setBoo( 'Baa' );
1123 | asrt( trim( $s ), '#&Boo#
' );
1124 |
1125 | testpack( 'Test backtick XSS filter for MSIE.' );
1126 |
1127 | $t = '';
1128 | $s = new StampTE( $t );
1129 | $s->setSlot( '`' );
1130 | asrt( trim( $s ), '' );
1131 |
1132 | $t = '';
1133 | $s = new StampTE( $t );
1134 | $s->setSlot( '``' );
1135 | asrt( trim( $s ), '' );
1136 |
1137 | testpack( 'Test attribute injection' );
1138 |
1139 | $t = '';
1140 | $s = new StampTE( $t );
1141 | $s->injectAttr( 'state', 'checked' );
1142 | asrt( trim( $s ), '' );
1143 |
1144 | $t = '';
1145 | $s = new StampTE( $t );
1146 | $s->injectAttr( 'state', '<' );
1147 | asrt( trim( $s ), '' );
1148 |
1149 | $t = '';
1150 | $s = new StampTE( $t );
1151 | $x = $s->injectAttr( 'state', '<', TRUE );
1152 | asrt( ( $x instanceof StampTE ), TRUE );
1153 | asrt( trim( $s ), '' );
1154 |
1155 | $t = '';
1156 | $s = new StampTE( $t );
1157 | asrt( trim( $s ), '' );
1158 |
1159 | $t = '';
1160 | $s = new StampTE( $t );
1161 | asrt( trim( $s ), '' );
1162 |
1163 | testpack( 'Test Attr-toggler.' );
1164 |
1165 | $t = '';
1166 | $s = new StampTE( $t );
1167 | $x = $s->attr( 'checked', TRUE );
1168 | asrt( ( $x instanceof StampTE ), TRUE );
1169 | asrt( trim( $s ), '' );
1170 |
1171 | $t = '';
1172 | $s = new StampTE( $t );
1173 | $x = $s->attr( 'checked', FALSE );
1174 | asrt( ( $x instanceof StampTE ), TRUE );
1175 | asrt( trim( $s ), '' );
1176 |
1177 | $t = '';
1178 | $s = new StampTE( $t );
1179 | asrt( trim( $s ), '' );
1180 |
1181 | testpack('Test escaping issue.');
1182 |
1183 | $s = new StampTE( '#slot#' );
1184 | $s->add( $s->getItem()->setSlot( '/' ) );
1185 | asrt( trim( $s ), '/' );
1186 |
1187 | $s = new StampTE('#slot#');
1188 | $s->add($s->getItem()->setSlot('$1'));
1189 | asrt(trim($s),'$1');
1190 |
1191 | //Test cache & collect
1192 | testpack(' Test Cache and Collect' );
1193 |
1194 | $s = new StampTE('
1195 |
1196 |
1197 |
1198 |
1199 |
1202 | ');
1203 |
1204 | $cacheObject = $s->writeToCache( 'button|textfield' )->getCache();
1205 |
1206 | //make sure cache is used, remove elements from new template...
1207 | $s = new StampTE('
1208 |
1209 |
1210 |
1213 | ');
1214 |
1215 | $s->loadIntoCache( $cacheObject );
1216 | $items = $s->collect( 'button|textfield' );
1217 | asrt( count( $items ), 2 );
1218 |
1219 | try {
1220 | $s->collect( 'button|textfield|misc' );
1221 | fail();
1222 | } catch( Exception $e ) {
1223 | pass();
1224 | }
1225 |
1226 | $button = $items[0];
1227 | $textField = $items[1];
1228 |
1229 | $s->form->add( $button->copy() );
1230 | $s->form->add( $textField->copy() );
1231 |
1232 | asrt( trim( '
1233 |
1234 |
1236 | ' ), trim( strval( $s ) ) );
1237 |
1238 |
1239 | //Test template loader
1240 | testpack( 'Test Template Loader' );
1241 |
1242 | $path = '/tmp/dummy.tpl';
1243 | $template = '
1244 | Dummy Template for StampTE Unit Test
1245 |
';
1246 | file_put_contents( $path, $template );
1247 | $s = StampTE::load( $path );
1248 |
1249 | asrt( strval( $s->getMessage() ), 'Dummy Template for StampTE Unit Test' );
1250 | asrt( $s->getString(), '
1251 |
' );
1252 |
1253 | try {
1254 | StampTE::load( '/non/existant/file/nowhere.nothing' );
1255 | fail();
1256 | } catch ( Exception $e ) {
1257 | pass();
1258 | }
1259 |
1260 | //test exceptions
1261 | testpack(' Test exceptions.' );
1262 |
1263 | try {
1264 | StampTE::load( '/non/existant/file/nowhere.nothing' );
1265 | fail();
1266 | } catch( StampTEException $e ) {
1267 | asrt( strpos( $e->getMessage(), '[S001]' ) === 0, TRUE );
1268 | }
1269 |
1270 |
1271 | //Null is allowed, becomes empty string ''.
1272 | $s = new StampTE( NULL );
1273 | pass();
1274 |
1275 | //non-string values get converted to string
1276 | $s = new StampTE( 123 );
1277 | asrt( strval($s), '123' );
1278 |
1279 | $s = new StampTE( FALSE );
1280 | asrt( strval($s), '' );
1281 |
1282 | $s = new StampTE( TRUE );
1283 | asrt( strval($s), '1' );
1284 |
1285 | $s = new StampTE( new StampTE('hello') );
1286 | asrt( strval($s), 'hello' );
1287 |
1288 | $s = new StampTE( new StdClass );
1289 | asrt( strval($s), '[stdClass instance]' );
1290 |
1291 | try {
1292 | $s = new StampTE( '' );
1293 | $s->getGhost();
1294 | fail();
1295 | } catch( StampTEException $e ) {
1296 | asrt( strpos( $e->getMessage(), '[S101]' ) === 0, TRUE );
1297 | }
1298 |
1299 | try {
1300 | $s = new StampTE( '' );
1301 | $s->get('test');
1302 | fail();
1303 | } catch( StampTEException $e ) {
1304 | asrt( strpos( $e->getMessage(), '[S101]' ) === 0, TRUE );
1305 | }
1306 |
1307 | try {
1308 | $s = new StampTE( '' );
1309 | $s->get('test.test');
1310 | fail();
1311 | } catch( StampTEException $e ) {
1312 | asrt( strpos( $e->getMessage(), '[S101]' ) === 0, TRUE );
1313 | }
1314 |
1315 | try {
1316 | $s = new StampTE( '' );
1317 | $s->loadIntoCache( NULL );
1318 | fail();
1319 | } catch( StampTEException $e ) {
1320 | asrt( strpos( $e->getMessage(), '[S004]' ) === 0, TRUE );
1321 | }
1322 |
1323 | try {
1324 | $s = new StampTE( '' );
1325 | $s->setTranslator( NULL );
1326 | fail();
1327 | } catch( StampTEException $e ) {
1328 | asrt( strpos( $e->getMessage(), '[S005]' ) === 0, TRUE );
1329 | }
1330 |
1331 | try {
1332 | $s = new StampTE( '' );
1333 | $s->setTranslator( 'translator' );
1334 | fail();
1335 | } catch( StampTEException $e ) {
1336 | asrt( strpos( $e->getMessage(), '[S005]' ) === 0, TRUE );
1337 | }
1338 |
1339 |
1340 | try {
1341 | $s = new StampTE( '' );
1342 | $s->setFactory( NULL );
1343 | fail();
1344 | } catch( StampTEException $e ) {
1345 | asrt( strpos( $e->getMessage(), '[S006]' ) === 0, TRUE );
1346 | }
1347 |
1348 | try {
1349 | $s = new StampTE( '' );
1350 | $s->setFactory( 'factory' );
1351 | fail();
1352 | } catch( StampTEException $e ) {
1353 | asrt( strpos( $e->getMessage(), '[S006]' ) === 0, TRUE );
1354 | }
1355 |
1356 | try {
1357 | $s = new StampTE( '' );
1358 | $s->setFactory( 'factory' );
1359 | fail();
1360 | } catch( StampTEException $e ) {
1361 | asrt( strpos( $e->getMessage(), '[S006]' ) === 0, TRUE );
1362 | }
1363 |
1364 | try {
1365 | $s = new StampTE( '' );
1366 | $s->glue( 'here', new StampTE );
1367 | fail();
1368 | } catch( StampTEException $e ) {
1369 | asrt( strpos( $e->getMessage(), '[S102]' ) === 0, TRUE );
1370 | }
1371 |
1372 | try {
1373 | $s = new StampTE( '' );
1374 | $s->glue( 'here', 'x' );
1375 | fail();
1376 | } catch( StampTEException $e ) {
1377 | asrt( strpos( $e->getMessage(), '[S003]' ) === 0, TRUE );
1378 | }
1379 |
1380 | //fake possible.
1381 | $s = new StampTE( '' );
1382 | $s->here->add( new StampTE( '', 'c' ) );
1383 | pass();
1384 |
1385 | //test html5 document creator
1386 | testpack( 'Test HTML5 document creator.' );
1387 | $tpl = StampTE::createHtml5Utf8Document();
1388 |
1389 | $expectedHTML = '
1390 |
1391 |
1392 |
1393 | #name#
';
1482 | $se = new StampTE($html);
1483 | $se->setName('Melville');
1484 | asrt($se->__toString(), '
1490 | Melville
');
1491 |
1492 | testpack('Test high UTF-8 and invalid UTF-8');
1493 | $se = new StampTE('♥');
1494 | $heart = $se->get('爱');
1495 | $se->add( $heart );
1496 | $se->add( $heart );
1497 | asrt( $se->__toString(), '♥♥' );
1498 |
1499 | $se = new StampTE('#test#');
1500 | $se->setTest( '𐀀' );
1501 | asrt( $se->__toString(), '𐀀' );
1502 |
1503 | $se = new StampTE('#test#');
1504 | $invalid = chr('129') . chr('129');
1505 | $se->setTest( $invalid );
1506 | asrt( $se->__toString(), '' );
1507 |
1508 | if ( !$XDEBUG ) exit(0);
1509 |
1510 | $report = xdebug_get_code_coverage();
1511 | $misses = 0;
1512 | $hits = 0;
1513 |
1514 | $covLines = array();
1515 | foreach( $report as $file => $lines ) {
1516 | $pi = pathinfo( $file );
1517 |
1518 | if ( strpos( $file, 'Stamp' ) === false ) continue;
1519 | $covLines[] = '***** File:'.$file.' ******';
1520 |
1521 | $fileData = file_get_contents( $file );
1522 | $fileLines = explode( "\n", $fileData );
1523 | $i = 1;
1524 | foreach( $fileLines as $covLine ) {
1525 | if ( isset( $lines [$i] ) ) {
1526 | if ( $lines[$i] === 1 ) {
1527 | $covLines[] = '[ OK ] '.$covLine;
1528 | $hits ++;
1529 | } else if ( $lines[$i] === -1 ){
1530 | $covLines[] = '[ MISSED! ] '.$covLine;
1531 | $misses ++;
1532 | } else {
1533 | $covLines[] = '[ - ] '.$covLine;
1534 | }
1535 | } else {
1536 | $covLines[] = '[ - ] '.$covLine;
1537 | }
1538 | $i ++;
1539 | }
1540 | }
1541 | $covFile = implode( "\n", $covLines );
1542 | @file_put_contents( 'coverage_log.txt', $covFile );
1543 |
1544 | if ( $hits > 0 ) {
1545 | $perc = ( $hits / ( $hits + $misses ) ) * 100;
1546 | } else {
1547 | $perc = 0;
1548 | }
1549 |
1550 | echo PHP_EOL;
1551 | echo 'Code Coverage: '.PHP_EOL;
1552 | echo 'Hits: '.$hits.PHP_EOL;
1553 | echo 'Misses: '.$misses.PHP_EOL;
1554 | echo 'Percentage: '.$perc.' %'.PHP_EOL;
1555 | exit( 0 );
1556 |
--------------------------------------------------------------------------------