increment year in copyright notices
[squirrelmail.git] / class / template / Template.class.php
CommitLineData
de4d58cb 1<?php
de4d58cb 2/**
3 * Template.class.php
4 *
6806cbe5 5 * This file contains an abstract (PHP 4, so "abstract" is relative)
6 * class meant to define the basic template interface for the
de4d58cb 7 * SquirrelMail core application. Subclasses should extend this
8 * class with any custom functionality needed to interface a target
9 * templating engine with SquirrelMail.
6806cbe5 10 *
4b5049de 11 * @copyright &copy; 2003-2007 The SquirrelMail Project Team
de4d58cb 12 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
13 * @version $Id$
14 * @package squirrelmail
15 * @subpackage Template
16 * @since 1.5.2
17 *
18 */
19
948be6d4 20/** load template functions */
d281e128 21require(SM_PATH . 'functions/template/general_util.php');
948be6d4 22
de4d58cb 23/**
24 * The SquirrelMail Template class.
25 *
26 * Basic template class for capturing values and pluging them into a template.
27 * This class uses a similar API to Smarty.
28 *
29 * Methods that must be implemented by subclasses are as follows (see method
30 * stubs below for further information about expected behavior):
31 *
32 * assign()
33 * assign_by_ref()
d4c2aa24 34 * clear_all_assign()
35 * get_template_vars()
de4d58cb 36 * append()
37 * append_by_ref()
38 * apply_template()
39 *
01520835 40 * @author Paul Lesniewski <paul at squirrelmail.org>
de4d58cb 41 * @package squirrelmail
42 *
43 */
44class Template
45{
46
47 /**
48 * The template ID
49 *
50 * @var string
51 *
52 */
d4c2aa24 53 var $template_set_id = '';
de4d58cb 54
55 /**
6806cbe5 56 * The template set base directory (relative path from
d4c2aa24 57 * the main SquirrelMail directory (SM_PATH))
de4d58cb 58 *
59 * @var string
60 *
61 */
62 var $template_dir = '';
63
64 /**
65 * The template engine (please use constants defined in constants.php)
66 *
67 * @var string
68 *
69 */
70 var $template_engine = '';
71
72 /**
d4c2aa24 73 * The fall-back template ID
de4d58cb 74 *
75 * @var string
76 *
77 */
d4c2aa24 78 var $fallback_template_set_id = '';
de4d58cb 79
80 /**
6806cbe5 81 * The fall-back template directory (relative
d4c2aa24 82 * path from the main SquirrelMail directory (SM_PATH))
de4d58cb 83 *
84 * @var string
85 *
86 */
d4c2aa24 87 var $fallback_template_dir = '';
de4d58cb 88
89 /**
6806cbe5 90 * The fall-back template engine (please use
d4c2aa24 91 * constants defined in constants.php)
de4d58cb 92 *
93 * @var string
94 *
95 */
d4c2aa24 96 var $fallback_template_engine = '';
de4d58cb 97
98 /**
d4c2aa24 99 * Template file cache. Structured as an array, whose keys
100 * are all the template file names (with path information relative
6806cbe5 101 * to the template set's base directory, e.g., "css/style.css")
102 * found in all parent template sets including the ultimate fall-back
103 * template set. Array values are sub-arrays with the
d4c2aa24 104 * following key-value pairs:
de4d58cb 105 *
d4c2aa24 106 * PATH -- file path, relative to SM_PATH
107 * SET_ID -- the ID of the template set that this file belongs to
108 * ENGINE -- the engine needed to render this template file
de4d58cb 109 *
110 */
d4c2aa24 111 var $template_file_cache = array();
de4d58cb 112
113 /**
d4c2aa24 114 * Extra template engine class objects for rendering templates
115 * that require a different engine than the one for the current
116 * template set. Keys should be the name of the template engine,
117 * values are the corresponding class objects.
118 *
119 * @var array
120 *
121 */
122 var $other_template_engine_objects = array();
123
740c26f7 124 /**
de4d58cb 125 * Constructor
126 *
127 * Please do not call directly. Use Template::construct_template().
128 *
d4c2aa24 129 * @param string $template_set_id the template ID
de4d58cb 130 *
131 */
d4c2aa24 132 function Template($template_set_id) {
6806cbe5 133//FIXME: find a way to test that this is ONLY ever called
de4d58cb 134// from the construct_template() method (I doubt it
135// is worth the trouble to parse the current stack trace)
136// if (???)
137// trigger_error('Please do not use default Template() constructor. Instead, use Template::construct_template().', E_USER_ERROR);
138
d4c2aa24 139 $this->set_up_template($template_set_id);
de4d58cb 140
141 }
142
143 /**
144 * Construct Template
145 *
146 * This method should always be called instead of trying
147 * to get a Template object from the normal/default constructor,
148 * and is necessary in order to control the return value.
149 *
d4c2aa24 150 * @param string $template_set_id the template ID
de4d58cb 151 *
152 * @return object The correct Template object for the given template set
153 *
d4c2aa24 154 * @static
155 *
de4d58cb 156 */
d4c2aa24 157 function construct_template($template_set_id) {
de4d58cb 158
d4c2aa24 159 $template = new Template($template_set_id);
34904996 160 $template->override_plugins();
de4d58cb 161 return $template->get_template_engine_subclass();
162
163 }
164
165 /**
6806cbe5 166 * Set up internal attributes
de4d58cb 167 *
6806cbe5 168 * This method does most of the work for setting up
de4d58cb 169 * newly constructed objects.
170 *
d4c2aa24 171 * @param string $template_set_id the template ID
de4d58cb 172 *
173 */
d4c2aa24 174 function set_up_template($template_set_id) {
de4d58cb 175
176 // FIXME: do we want to place any restrictions on the ID like
177 // making sure no slashes included?
178 // get template ID
179 //
d4c2aa24 180 $this->template_set_id = $template_set_id;
de4d58cb 181
182
d4c2aa24 183 $this->fallback_template_set_id = Template::get_fallback_template_set();
de4d58cb 184
185
186 // set up template directories
187 //
6806cbe5 188 $this->template_dir
d4c2aa24 189 = Template::calculate_template_file_directory($this->template_set_id);
6806cbe5 190 $this->fallback_template_dir
d4c2aa24 191 = Template::calculate_template_file_directory($this->fallback_template_set_id);
de4d58cb 192
193
6806cbe5 194 // determine template engine
d4c2aa24 195 // FIXME: assuming PHP template engine may not necessarily be a good thing
de4d58cb 196 //
6806cbe5 197 $this->template_engine = Template::get_template_config($this->template_set_id,
d4c2aa24 198 'template_engine',
199 SQ_PHP_TEMPLATE);
de4d58cb 200
de4d58cb 201
d4c2aa24 202 // get template file cache
203 //
204 $this->template_file_cache = Template::cache_template_file_hierarchy();
de4d58cb 205
d4c2aa24 206 }
de4d58cb 207
d4c2aa24 208 /**
209 * Determine what the ultimate fallback template set is.
210 *
211 * NOTE that if the fallback setting cannot be found in the
212 * main SquirrelMail configuration settings that the value
213 * of $default is returned.
214 *
215 * @param string $default The template set ID to use if
216 * the fallback setting cannot be
217 * found in SM config (optional;
218 * defaults to "default").
219 *
220 * @return string The ID of the fallback template set.
221 *
222 * @static
223 *
224 */
225 function get_fallback_template_set($default='default') {
de4d58cb 226
d4c2aa24 227// FIXME: do we want to place any restrictions on the ID such as
228// making sure no slashes included?
de4d58cb 229
d4c2aa24 230 // values are in main SM config file
de4d58cb 231 //
d4c2aa24 232 global $templateset_fallback, $aTemplateSet;
6806cbe5 233 $aTemplateSet = (!isset($aTemplateSet) || !is_array($aTemplateSet)
d4c2aa24 234 ? array() : $aTemplateSet);
6806cbe5 235 $templateset_fallback = (!isset($templateset_fallback)
293906dd 236 ? $default : $templateset_fallback);
d4c2aa24 237
293906dd 238 // iterate through all template sets, is this a valid skin ID?
239 //
240 $found_it = FALSE;
241 foreach ($aTemplateSet as $aTemplate) {
f4138e60 242 if ($aTemplate['ID'] === $templateset_fallback) {
293906dd 243 $found_it = TRUE;
244 break;
245 }
246 }
247
248 if ($found_it)
249 return $templateset_fallback;
250
251 // FIXME: note that it is possible for $default to
252 // point to an invalid (nonexistent) template set
253 // and that error will not be caught here
254 //
255 return $default;
d4c2aa24 256
257 }
258
259 /**
260 * Determine what the default template set is.
261 *
262 * NOTE that if the default setting cannot be found in the
263 * main SquirrelMail configuration settings that the value
264 * of $default is returned.
265 *
266 * @param string $default The template set ID to use if
267 * the default setting cannot be
268 * found in SM config (optional;
269 * defaults to "default").
270 *
271 * @return string The ID of the default template set.
272 *
273 * @static
274 *
275 */
276 function get_default_template_set($default='default') {
277
278// FIXME: do we want to place any restrictions on the ID such as
279// making sure no slashes included?
280
281 // values are in main SM config file
282 //
283 global $templateset_default, $aTemplateSet;
284 $aTemplateSet = (!isset($aTemplateSet) || !is_array($aTemplateSet)
285 ? array() : $aTemplateSet);
6806cbe5 286 $templateset_default = (!isset($templateset_default)
293906dd 287 ? $default : $templateset_default);
d4c2aa24 288
293906dd 289 // iterate through all template sets, is this a valid skin ID?
290 //
291 $found_it = FALSE;
292 foreach ($aTemplateSet as $aTemplate) {
f4138e60 293 if ($aTemplate['ID'] === $templateset_default) {
293906dd 294 $found_it = TRUE;
295 break;
296 }
297 }
298
299 if ($found_it)
300 return $templateset_default;
301
302 // FIXME: note that it is possible for $default to
303 // point to an invalid (nonexistent) template set
304 // and that error will not be caught here
305 //
306 return $default;
de4d58cb 307
308 }
309
310 /**
34904996 311 * Allow template set to override plugin configuration by either
312 * adding or removing plugins.
313 *
e4dd471d 314 * NOTE: due to when this code executes, plugins activated here
315 * do not have access to the config_override and loading_prefs
316 * hooks; instead, such plugins can use the
317 * "template_plugins_override_after" hook defined below.
318 *
34904996 319 */
320 function override_plugins() {
321
e4dd471d 322 global $disable_plugins, $plugins, $squirrelmail_plugin_hooks, $null;
34904996 323 if ($disable_plugins) return;
324
6806cbe5 325 $add_plugins = Template::get_template_config($this->template_set_id,
34904996 326 'add_plugins', array());
6806cbe5 327 $remove_plugins = Template::get_template_config($this->template_set_id,
34904996 328 'remove_plugins', array());
329
330//FIXME (?) we assume $add_plugins and $remove_plugins are arrays -- we could
6806cbe5 331// error check here, or just assume that template authors or admins
34904996 332// won't screw up their config files
333
334
335 // disable all plugins? (can still add some by using $add_plugins)
336 //
337 if (in_array('*', $remove_plugins)) {
338 $plugins = array();
339 $squirrelmail_plugin_hooks = array();
340 $remove_plugins = array();
341 }
342
343
344 foreach ($add_plugins as $plugin_name) {
345 // add plugin to global plugin array
346 //
347 $plugins[] = $plugin_name;
348
349
350 // enable plugin -- emulate code from use_plugin() function
351 // in SquirrelMail core, but also need to call the
352 // "squirrelmail_plugin_init_<plugin_name>" function, which
353 // in static configuration is not called (this inconsistency
354 // could be a source of anomalous-seeming bugs in poorly
355 // coded plugins)
356 //
357 if (file_exists(SM_PATH . "plugins/$plugin_name/setup.php")) {
358 include_once(SM_PATH . "plugins/$plugin_name/setup.php");
359
360 $function = "squirrelmail_plugin_init_$plugin_name";
361 if (function_exists($function))
362 $function();
363 }
364 }
365
366 foreach ($remove_plugins as $plugin_name) {
367 // remove plugin from both global plugin & plugin hook arrays
368 //
369 $plugin_key = array_search($plugin_name, $plugins);
370 if (!is_null($plugin_key) && $plugin_key !== FALSE) {
371 unset($plugins[$plugin_key]);
372 if (is_array($squirrelmail_plugin_hooks))
373 foreach (array_keys($squirrelmail_plugin_hooks) as $hookName) {
374 unset($squirrelmail_plugin_hooks[$hookName][$plugin_name]);
375 }
376 }
377 }
378
e4dd471d 379 do_hook('template_plugins_override_after', $null);
380
34904996 381 }
382
383 /**
de4d58cb 384 * Instantiate and return correct subclass for this template
385 * set's templating engine.
386 *
d4c2aa24 387 * @param string $template_set_id The template set whose engine
6806cbe5 388 * is to be used as an override
389 * (if not given, this template
d4c2aa24 390 * set's engine is used) (optional).
391 *
de4d58cb 392 * @return object The Template subclass object for the template engine.
393 *
394 */
d4c2aa24 395 function get_template_engine_subclass($template_set_id='') {
396
397 if (empty($template_set_id)) $template_set_id = $this->template_set_id;
398 // FIXME: assuming PHP template engine may not necessarily be a good thing
6806cbe5 399 $engine = Template::get_template_config($template_set_id,
d4c2aa24 400 'template_engine', SQ_PHP_TEMPLATE);
de4d58cb 401
6806cbe5 402
403 $engine_class_file = SM_PATH . 'class/template/'
d4c2aa24 404 . $engine . 'Template.class.php';
de4d58cb 405
406 if (!file_exists($engine_class_file)) {
6806cbe5 407 trigger_error('Unknown template engine (' . $engine
de4d58cb 408 . ') was specified in template configuration file',
409 E_USER_ERROR);
410 }
411
d4c2aa24 412 $engine_class = $engine . 'Template';
413 require_once($engine_class_file);
414 return new $engine_class($template_set_id);
de4d58cb 415
416 }
417
418 /**
6806cbe5 419 * Determine the relative template directory path for
de4d58cb 420 * the given template ID.
421 *
6806cbe5 422 * @param string $template_set_id The template ID from which to build
d4c2aa24 423 * the directory path
de4d58cb 424 *
425 * @return string The relative template path (based off of SM_PATH)
426 *
d4c2aa24 427 * @static
428 *
de4d58cb 429 */
d4c2aa24 430 function calculate_template_file_directory($template_set_id) {
de4d58cb 431
d4c2aa24 432 return 'templates/' . $template_set_id . '/';
de4d58cb 433
434 }
435
436 /**
6806cbe5 437 * Determine the relative images directory path for
de4d58cb 438 * the given template ID.
439 *
6806cbe5 440 * @param string $template_set_id The template ID from which to build
d4c2aa24 441 * the directory path
de4d58cb 442 *
443 * @return string The relative images path (based off of SM_PATH)
444 *
d4c2aa24 445 * @static
446 *
de4d58cb 447 */
d4c2aa24 448 function calculate_template_images_directory($template_set_id) {
de4d58cb 449
d4c2aa24 450 return 'templates/' . $template_set_id . '/images/';
de4d58cb 451
452 }
453
454 /**
455 * Return the relative template directory path for this template set.
456 *
457 * @return string The relative path to the template directory based
458 * from the main SquirrelMail directory (SM_PATH).
459 *
460 */
461 function get_template_file_directory() {
462
463 return $this->template_dir;
464
465 }
466
d4c2aa24 467 /**
468 * Return the template ID for the fallback template set.
469 *
470 * @return string The ID of the fallback template set.
471 *
472 */
473 function get_fallback_template_set_id() {
474
475 return $this->fallback_template_set_id;
476
477 }
de4d58cb 478
479 /**
6806cbe5 480 * Return the relative template directory path for the
d4c2aa24 481 * fallback template set.
de4d58cb 482 *
6806cbe5 483 * @return string The relative path to the fallback template
484 * directory based from the main SquirrelMail
d4c2aa24 485 * directory (SM_PATH).
486 *
487 */
488 function get_fallback_template_file_directory() {
489
490 return $this->fallback_template_dir;
491
492 }
493
494 /**
495 * Get template set config setting
496 *
6806cbe5 497 * Given a template set ID and setting name, returns the
498 * setting's value. Note that settings are cached in
d4c2aa24 499 * session, so "live" changes to template configuration
500 * won't be reflected until the user logs out and back
501 * in again.
502 *
503 * @param string $template_set_id The template set for which
504 * to look up the setting.
505 * @param string $setting The name of the setting to
6806cbe5 506 * retrieve.
d4c2aa24 507 * @param mixed $default When the requested setting
508 * is not found, the contents
509 * of this value are returned
6806cbe5 510 * instead (optional; default
d4c2aa24 511 * is NULL).
512 * NOTE that unlike sqGetGlobalVar(),
513 * this function will also return
6806cbe5 514 * the default value if the
515 * requested setting is found
d4c2aa24 516 * but is empty.
517 * @param boolean $live_config When TRUE, the target template
518 * set's configuration file is
6806cbe5 519 * reloaded every time this
d4c2aa24 520 * method is called. Default
521 * behavior is to only load the
522 * configuration file if it had
523 * never been loaded before, but
524 * not again after that (optional;
525 * default FALSE). Use with care!
526 * Should mostly be used for
527 * debugging.
528 *
6806cbe5 529 * @return mixed The desired setting's value or if not found,
d4c2aa24 530 * the contents of $default are returned.
531 *
532 * @static
533 *
534 */
6806cbe5 535 function get_template_config($template_set_id, $setting,
d4c2aa24 536 $default=NULL, $live_config=FALSE) {
537
6806cbe5 538 sqGetGlobalVar('template_configuration_settings',
539 $template_configuration_settings,
540 SQ_SESSION,
d4c2aa24 541 array());
542
543 if ($live_config) unset($template_configuration_settings[$template_set_id]);
544
545
546 // NOTE: could use isset() instead of empty() below, but
547 // this function is designed to replace empty values
548 // as well as non-existing values with $default
549 //
550 if (!empty($template_configuration_settings[$template_set_id][$setting]))
551 return $template_configuration_settings[$template_set_id][$setting];
552
553
6806cbe5 554 // if template set configuration has been loaded, but this
d4c2aa24 555 // setting is not known, return $default
556 //
557 if (!empty($template_configuration_settings[$template_set_id]))
558 return $default;
559
560
6806cbe5 561 // otherwise (template set configuration has not been loaded before),
d4c2aa24 562 // load it into session and return the desired setting after that
563 //
6806cbe5 564 $template_config_file = SM_PATH
d4c2aa24 565 . Template::calculate_template_file_directory($template_set_id)
566 . 'config.php';
567
568 if (!file_exists($template_config_file)) {
569
6806cbe5 570 trigger_error('No template configuration file was found where expected: ("'
d4c2aa24 571 . $template_config_file . '")', E_USER_ERROR);
572
573 } else {
574
575 // we require() the file to let PHP do the variable value
576 // parsing for us, and read the file in manually so we can
6806cbe5 577 // know what variable names are used in the config file
d4c2aa24 578 // (settings can be different depending on specific requirements
579 // of different template engines)... the other way this may
6806cbe5 580 // be accomplished is to somehow diff the symbol table
d4c2aa24 581 // before/after the require(), but anyway, this code should
582 // only run once for this template set...
583 //
584 require($template_config_file);
585 $file_contents = implode("\n", file($template_config_file));
586
587
588 // note that this assumes no template settings have
589 // a string in them that looks like a variable name like $x
590 // also note that this will attempt to grab things like
591 // $Id found in CVS headers, so we try to adjust for that
592 // by checking that the variable is actually set
593 //
594 preg_match_all('/\$(\w+)/', $file_contents, $variables, PREG_PATTERN_ORDER);
595 foreach ($variables[1] as $variable) {
596 if (isset($$variable))
6806cbe5 597 $template_configuration_settings[$template_set_id][$variable]
d4c2aa24 598 = $$variable;
599 }
600
6806cbe5 601 sqsession_register($template_configuration_settings,
d4c2aa24 602 'template_configuration_settings');
603
604 // NOTE: could use isset() instead of empty() below, but
605 // this function is designed to replace empty values
606 // as well as non-existing values with $default
607 //
608 if (!empty($template_configuration_settings[$template_set_id][$setting]))
609 return $template_configuration_settings[$template_set_id][$setting];
610 else
611 return $default;
612
613 }
614
615 }
616
6806cbe5 617 /**
d4c2aa24 618 * Obtain template file hierarchy from cache.
619 *
620 * If the file hierarchy does not exist in session, it is
621 * constructed and stored in session before being returned
622 * to the caller.
623 *
624 * @param boolean $regenerate_cache When TRUE, the file hierarchy
625 * is reloaded and stored fresh
626 * (optional; default FALSE).
627 * @param array $additional_files Must be in same form as the
628 * files in the file hierarchy
629 * cache. These are then added
630 * to the cache (optional; default
631 * empty - no additional files).
632 *
633 * @return array Template file hierarchy array, whose keys
6806cbe5 634 * are all the template file names (with path
635 * information relative to the template set's
636 * base directory, e.g., "css/style.css")
637 * found in all parent template sets including
638 * the ultimate fall-back template set.
639 * Array values are sub-arrays with the
d4c2aa24 640 * following key-value pairs:
641 *
642 * PATH -- file path, relative to SM_PATH
643 * SET_ID -- the ID of the template set that this file belongs to
644 * ENGINE -- the engine needed to render this template file
645 *
646 * @static
de4d58cb 647 *
648 */
d4c2aa24 649 function cache_template_file_hierarchy($regenerate_cache=FALSE,
650 $additional_files=array()) {
651
6806cbe5 652 sqGetGlobalVar('template_file_hierarchy', $template_file_hierarchy,
d4c2aa24 653 SQ_SESSION, array());
654
655
656 if ($regenerate_cache) unset($template_file_hierarchy);
657
d4c2aa24 658 if (!empty($template_file_hierarchy)) {
659
660 // have to add additional files if given before returning
661 //
662 if (!empty($additional_files)) {
6806cbe5 663 $template_file_hierarchy = array_merge($template_file_hierarchy,
d4c2aa24 664 $additional_files);
665 sqsession_register($template_file_hierarchy,
666 'template_file_hierarchy');
667 }
668
669 return $template_file_hierarchy;
670 }
671
672
673 // nothing in cache apparently, so go build it now
674 //
6806cbe5 675 // FIXME: not sure if there is any possibility that
d4c2aa24 676 // this could be called when $sTemplateID has
677 // yet to be defined... throw error for now,
678 // but if the error occurs, it's a coding error
679 // rather than a configuration error
680 //
681 global $sTemplateID;
682 if (empty($sTemplateID)) {
683
684 trigger_error('Template set ID unknown', E_USER_ERROR);
685
686 } else {
687
688 $template_file_hierarchy = Template::catalog_template_files($sTemplateID);
689
690 // additional files, if any
691 //
692 if (!empty($additional_files)) {
6806cbe5 693 $template_file_hierarchy = array_merge($template_file_hierarchy,
d4c2aa24 694 $additional_files);
695 }
696
6806cbe5 697 sqsession_register($template_file_hierarchy,
d4c2aa24 698 'template_file_hierarchy');
699
700 return $template_file_hierarchy;
701
702 }
703
704 }
705
706 /**
6806cbe5 707 * Traverse template hierarchy and catalogue all template
d4c2aa24 708 * files (for storing in cache).
6806cbe5 709 *
710 * Paths to all files in all parent, grand-parent, great grand
711 * parent, etc. template sets (including the fallback template)
712 * are catalogued; for identically named files, the file earlier
d4c2aa24 713 * in the hierarchy (closest to this template set) is used.
6806cbe5 714 *
d4c2aa24 715 * @param string $template_set_id The template set in which to
716 * search for files
717 * @param array $file_list The file list so far to be added
718 * to (allows recursive behavior)
719 * (optional; default empty array).
6806cbe5 720 * @param string $directory The directory in which to search for
d4c2aa24 721 * files (must be given as full path).
722 * If empty, starts at top-level template
723 * set directory (optional; default empty).
724 * NOTE! Use with care, as behavior is
725 * unpredictable if directory given is not
726 * part of correct template set.
6806cbe5 727 *
d4c2aa24 728 * @return mixed The top-level caller will have an array of template
729 * files returned to it; recursive calls to this function
730 * do not receive any return value at all. The format
731 * of the template file array is as described for the
732 * Template class attribute $template_file_cache
733 *
734 * @static
735 *
736 */
737 function catalog_template_files($template_set_id, $file_list=array(), $directory='') {
738
6806cbe5 739 $template_base_dir = SM_PATH
d4c2aa24 740 . Template::calculate_template_file_directory($template_set_id);
741
742 if (empty($directory)) {
743 $directory = $template_base_dir;
744 }
745
746 $files_and_dirs = list_files($directory, '', FALSE, TRUE, FALSE, TRUE);
de4d58cb 747
d4c2aa24 748 // recurse for all the subdirectories in the template set
749 //
750 foreach ($files_and_dirs['DIRECTORIES'] as $dir) {
751 $file_list = Template::catalog_template_files($template_set_id, $file_list, $dir);
752 }
753
754 // place all found files in the cache
755 // FIXME: assuming PHP template engine may not necessarily be a good thing
756 //
6806cbe5 757 $engine = Template::get_template_config($template_set_id,
d4c2aa24 758 'template_engine', SQ_PHP_TEMPLATE);
759 foreach ($files_and_dirs['FILES'] as $file) {
760
761 // remove the part of the file path corresponding to the
762 // template set's base directory
763 //
764 $relative_file = substr($file, strlen($template_base_dir));
765
948be6d4 766 /**
767 * only put file in cache if not already found in earlier template
768 * PATH should be relative to SquirrelMail top directory
769 */
d4c2aa24 770 if (!isset($file_list[$relative_file])) {
771 $file_list[$relative_file] = array(
948be6d4 772 'PATH' => substr($file,strlen(SM_PATH)),
d4c2aa24 773 'SET_ID' => $template_set_id,
774 'ENGINE' => $engine,
775 );
776 }
777
778 }
779
780
781 // now if we are currently at the top-level of the template
6806cbe5 782 // set base directory, we need to move on to the parent
d4c2aa24 783 // template set, if any
784 //
785 if ($directory == $template_base_dir) {
786
787 // use fallback when we run out of parents
788 //
789 $fallback_id = Template::get_fallback_template_set();
6806cbe5 790 $parent_id = Template::get_template_config($template_set_id,
791 'parent_template_set',
d4c2aa24 792 $fallback_id);
793
794 // were we already all the way to the last level? just exit
795 //
796 // note that this code allows the fallback set to have
797 // a parent, too, but can result in endless loops
798 // if ($parent_id == $template_set_id) {
799 //
800 if ($fallback_id == $template_set_id) {
801 return $file_list;
802 }
803
804 $file_list = Template::catalog_template_files($parent_id, $file_list);
805
806 }
807
808 return $file_list;
de4d58cb 809
810 }
811
d4c2aa24 812 /**
813 * Look for a template file in a plugin; add to template
814 * file cache if found.
815 *
816 * The file is searched for in the following order:
817 *
818 * - A directory for the current template set within the plugin:
819 * SM_PATH/plugins/<plugin name>/templates/<template name>/
820 * - In a directory for one of the current template set's ancestor
821 * (inherited) template sets within the plugin:
822 * SM_PATH/plugins/<plugin name>/templates/<parent template name>/
823 * - In a directory for the fallback template set within the plugin:
824 * SM_PATH/plugins/<plugin name>/templates/<fallback template name>/
825 *
826 * @param string $plugin The name of the plugin
827 * @param string $file The name of the template file
828 * @param string $template_set_id The ID of the template for which
6806cbe5 829 * to start looking for the file
830 * (optional; default is current
d4c2aa24 831 * template set ID).
832 *
833 * @return boolean TRUE if the template file was found, FALSE otherwise.
834 *
835 */
836 function find_and_cache_plugin_template_file($plugin, $file, $template_set_id='') {
837
838 if (empty($template_set_id))
839 $template_set_id = $this->template_set_id;
840
841 $file_path = SM_PATH . 'plugins/' . $plugin . '/'
6806cbe5 842 . $this->calculate_template_file_directory($template_set_id)
d4c2aa24 843 . $file;
844
845 if (file_exists($file_path)) {
846 // FIXME: assuming PHP template engine may not necessarily be a good thing
6806cbe5 847 $engine = $this->get_template_config($template_set_id,
d4c2aa24 848 'template_engine', SQ_PHP_TEMPLATE);
849 $file_list = array('plugins/' . $plugin . '/' . $file => array(
eb2425ec 850 'PATH' => substr($file_path, strlen(SM_PATH)),
851 'SET_ID' => $template_set_id,
852 'ENGINE' => $engine,
d4c2aa24 853 )
854 );
6806cbe5 855 $this->template_file_cache
d4c2aa24 856 = $this->cache_template_file_hierarchy(FALSE, $file_list);
857 return TRUE;
858 }
859
860
861 // not found yet, try parent template set
862 // (use fallback when we run out of parents)
863 //
864 $fallback_id = $this->get_fallback_template_set();
6806cbe5 865 $parent_id = $this->get_template_config($template_set_id,
866 'parent_template_set',
d4c2aa24 867 $fallback_id);
868
869 // were we already all the way to the last level? just exit
870 //
871 // note that this code allows the fallback set to have
872 // a parent, too, but can result in endless loops
873 // if ($parent_id == $template_set_id) {
874 //
875 if ($fallback_id == $template_set_id) {
876 return FALSE;
877 }
878
879 return $this->find_and_cache_plugin_template_file($plugin, $file, $parent_id);
880
881 }
de4d58cb 882
883 /**
884 * Find the right template file.
885 *
d4c2aa24 886 * The template file is taken from the template file cache, thus
6806cbe5 887 * the file is taken from the current template, one of its
d4c2aa24 888 * ancestors or the fallback template.
889 *
890 * Note that it is perfectly acceptable to load template files from
6806cbe5 891 * template subdirectories. For example, JavaScript templates found
892 * in the js/ subdirectory would be loaded by passing
d4c2aa24 893 * "js/<javascript file name>" as the $filename.
894 *
895 * Note that the caller can also ask for ALL files in a directory
896 * (and those in the same directory for all ancestor template sets)
897 * by giving a $filename that is a directory name (ending with a
898 * slash).
899 *
900 * If not found and the file is a plugin template file (indicated
901 * by the presence of "plugins/" on the beginning of $filename),
902 * the target plugin is searched for a substitue template file
903 * before just returning nothing.
de4d58cb 904 *
905 * Plugin authors must note that the $filename MUST be prefaced
6806cbe5 906 * with "plugins/<plugin name>/" in order to correctly resolve the
de4d58cb 907 * template file.
908 *
de4d58cb 909 * @param string $filename The name of the template file,
6806cbe5 910 * possibly prefaced with
de4d58cb 911 * "plugins/<plugin name>/"
912 * indicating that it is a plugin
6806cbe5 913 * template, or ending with a
d4c2aa24 914 * slash, indicating that all files
915 * for that directory name should
916 * be returned.
e5d57179 917 * @param boolean $directories_ok When TRUE, directory names
918 * are acceptable search values,
919 * and when returning a list of
920 * directory contents, sub-directory
921 * names will also be included
922 * (optional; default FALSE).
6806cbe5 923 * NOTE that empty directories
e5d57179 924 * are NOT included in the cache!
925 * @param boolean $directories_only When TRUE, only directory names
926 * are included in the returned
6806cbe5 927 * results. (optional; default
e5d57179 928 * FALSE). Setting this argument
6806cbe5 929 * to TRUE forces $directories_ok
e5d57179 930 * to TRUE as well.
6806cbe5 931 * NOTE that empty directories
e5d57179 932 * are NOT included in the cache!
d4c2aa24 933 *
934 * @return mixed The full path to the template file or a list
935 * of all files in the given directory if $filename
936 * ends with a slash; if not found, an empty string
6806cbe5 937 * is returned. The caller is responsible for
938 * throwing errors or other actions if template
d4c2aa24 939 * file is not found.
de4d58cb 940 *
941 */
6806cbe5 942 function get_template_file_path($filename,
943 $directories_ok=FALSE,
e5d57179 944 $directories_only=FALSE) {
de4d58cb 945
e5d57179 946 if ($directories_only) $directories_ok = TRUE;
947
948
949 // only looking for directory listing first...
950 //
d4c2aa24 951 // return list of all files in a directory (and that
952 // of any ancestors)
de4d58cb 953 //
d4c2aa24 954 if ($filename{strlen($filename) - 1} == '/') {
955
956 $return_array = array();
957 foreach ($this->template_file_cache as $file => $file_info) {
958
959 // only want files in the requested directory
960 // (AND not in a subdirectory!)
961 //
6806cbe5 962 if (!$directories_only && strpos($file, $filename) === 0
d4c2aa24 963 && strpos($file, '/', strlen($filename)) === FALSE)
948be6d4 964 $return_array[] = SM_PATH . $file_info['PATH'];
de4d58cb 965
e5d57179 966 // directories too? detect by finding any
967 // array key that matches a file in a sub-directory
968 // of the directory being processed
969 //
970 if ($directories_ok && strpos($file, $filename) === 0
971 && ($pos = strpos($file, '/', strlen($filename))) !== FALSE
972 && strpos($file, '/', $pos + 1) === FALSE) {
6806cbe5 973 $directory_name = SM_PATH
974 . substr($file_info['PATH'],
975 0,
e5d57179 976 strrpos($file_info['PATH'], '/'));
977 if (!in_array($directory_name, $return_array))
978 $return_array[] = $directory_name;
979 }
980
d4c2aa24 981 }
982 return $return_array;
983
984 }
985
e5d57179 986
987 // just looking for singular file or directory below...
988 //
d4c2aa24 989 // figure out what to do with files not found
990 //
e5d57179 991 if ($directories_only || empty($this->template_file_cache[$filename]['PATH'])) {
992
993 // if looking for directories...
994 // have to iterate through cache and detect
995 // directory by matching any file inside of it
996 //
997 if ($directories_ok) {
998 foreach ($this->template_file_cache as $file => $file_info) {
999 if (strpos($file, $filename) === 0
1000 && ($pos = strpos($file, '/', strlen($filename))) !== FALSE
1001 && strpos($file, '/', $pos + 1) === FALSE) {
6806cbe5 1002 return SM_PATH . substr($file_info['PATH'],
1003 0,
e5d57179 1004 strrpos($file_info['PATH'], '/'));
1005 }
1006 }
1007
1008 if ($directories_only) return '';
1009 }
d4c2aa24 1010
6806cbe5 1011 // plugins get one more chance
de4d58cb 1012 //
e5d57179 1013 if (strpos($filename, 'plugins/') === 0) {
1014
1015 $plugin_name = substr($filename, 8, strpos($filename, '/', 8) - 8);
1016 $file = substr($filename, strlen($plugin_name) + 9);
1017
1018 if (!$this->find_and_cache_plugin_template_file($plugin_name, $file))
1019 return '';
1020 //FIXME: technically I guess we should check for directories
1021 // here too, but that's overkill (no need) presently
1022 // (plugin-provided alternate stylesheet dirs?!? bah.)
de4d58cb 1023
e5d57179 1024 }
de4d58cb 1025
e5d57179 1026 // nothing... return empty string (yes, the else is intentional!)
1027 //
1028 else return '';
de4d58cb 1029
d4c2aa24 1030 }
de4d58cb 1031
948be6d4 1032 return SM_PATH . $this->template_file_cache[$filename]['PATH'];
de4d58cb 1033
d4c2aa24 1034 }
de4d58cb 1035
d4c2aa24 1036 /**
1037 * Get template engine needed to render given template file.
1038 *
1039 * If at all possible, just returns a reference to $this, but
1040 * some template files may require a different engine, thus
1041 * an object for that engine (which will subsequently be kept
1042 * in this object for future use) is returned.
1043 *
1044 * @param string $filename The name of the template file,
1045 *
1046 * @return object The needed template object to render the template.
6806cbe5 1047 *
d4c2aa24 1048 */
1049 function get_rendering_template_engine_object($filename) {
6806cbe5 1050
d4c2aa24 1051 // for files that we cannot find engine info for,
1052 // just return $this
6806cbe5 1053 //
d4c2aa24 1054 if (empty($this->template_file_cache[$filename]['ENGINE']))
1055 return $this;
1056
6806cbe5 1057
d4c2aa24 1058 // otherwise, compare $this' engine to the file's engine
1059 //
1060 $engine = $this->template_file_cache[$filename]['ENGINE'];
1061 if ($this->template_engine == $engine)
1062 return $this;
1063
1064
1065 // need to load another engine... if already instantiated,
1066 // and stored herein, return that
6806cbe5 1067 // FIXME: this assumes same engine setup in all template
d4c2aa24 1068 // set config files that have same engine in common
1069 // (but keeping a separate class object for every
6806cbe5 1070 // template set seems like overkill... for now we
d4c2aa24 1071 // won't do that unless it becomes a problem)
1072 //
1073 if (!empty($this->other_template_engine_objects[$engine])) {
1074 $rendering_engine = $this->other_template_engine_objects[$engine];
de4d58cb 1075
de4d58cb 1076
d4c2aa24 1077 // otherwise, instantiate new engine object, add to cache
1078 // and return it
1079 //
1080 } else {
1081 $template_set_id = $this->template_file_cache[$filename]['SET_ID'];
1082 $this->other_template_engine_objects[$engine]
1083 = $this->get_template_engine_subclass($template_set_id);
1084 $rendering_engine = $this->other_template_engine_objects[$engine];
1085 }
de4d58cb 1086
de4d58cb 1087
d4c2aa24 1088 // now, need to copy over all the assigned variables
1089 // from $this to the rendering engine (YUCK! -- we need
1090 // to discourage template authors from creating
1091 // situations where engine changes occur)
1092 //
1093 $rendering_engine->clear_all_assign();
1094 $rendering_engine->assign($this->get_template_vars());
de4d58cb 1095
de4d58cb 1096
d4c2aa24 1097 // finally ready to go
1098 //
1099 return $rendering_engine;
de4d58cb 1100
d4c2aa24 1101 }
de4d58cb 1102
6806cbe5 1103 /**
d4c2aa24 1104 * Return all JavaScript files provided by the template.
6806cbe5 1105 *
1106 * All files found in the template set's "js" directory (and
d4c2aa24 1107 * that of its ancestors) with the extension ".js" are returned.
1108 *
1109 * @param boolean $full_path When FALSE, only the file names
1110 * are included in the return array;
1111 * otherwise, path information is
1112 * included (relative to SM_PATH)
1113 * (OPTIONAL; default only file names)
6806cbe5 1114 *
d4c2aa24 1115 * @return array The required file names/paths.
6806cbe5 1116 *
d4c2aa24 1117 */
1118 function get_javascript_includes($full_path=FALSE) {
de4d58cb 1119
6806cbe5 1120 // since any page from a parent template set
d4c2aa24 1121 // could end up being loaded, we have to load
1122 // all js files from ancestor template sets,
1123 // not just this set
1124 //
1125 //$directory = SM_PATH . $this->get_template_file_directory() . 'js';
1126 //$js_files = list_files($directory, '.js', !$full_path);
1127 //
1128 $js_files = $this->get_template_file_path('js/');
6806cbe5 1129
1130
d4c2aa24 1131 // parse out .js files only
1132 //
1133 $return_array = array();
1134 foreach ($js_files as $file) {
6806cbe5 1135
d4c2aa24 1136 if (substr($file, strlen($file) - 3) != '.js') continue;
de4d58cb 1137
d4c2aa24 1138 if ($full_path) {
1139 $return_array[] = $file;
1140 } else {
1141 $return_array[] = basename($file);
de4d58cb 1142 }
1143
1144 }
1145
d4c2aa24 1146 return $return_array;
de4d58cb 1147
1148 }
1149
1150 /**
6806cbe5 1151 * Return all alternate stylesheets provided by template.
d4c2aa24 1152 *
6806cbe5 1153 * All (non-empty) directories found in the template set's
1154 * "css/alternates" directory (and that of its ancestors)
e5d57179 1155 * are returned.
d4c2aa24 1156 *
1157 * Note that prettified names are constructed herein by
e5d57179 1158 * taking the directory name, changing underscores to spaces
1159 * and capitalizing each word in the resultant name.
de4d58cb 1160 *
1161 * @param boolean $full_path When FALSE, only the file names
1162 * are included in the return array;
1163 * otherwise, path information is
1164 * included (relative to SM_PATH)
1165 * (OPTIONAL; default only file names)
1166 *
d4c2aa24 1167 * @return array A list of the available alternate stylesheets,
6806cbe5 1168 * where the keys are the file names (formatted
1169 * according to $full_path) for the stylesheets,
1170 * and the values are the prettified version of
d4c2aa24 1171 * the file names for display to the user.
6806cbe5 1172 *
de4d58cb 1173 */
d4c2aa24 1174 function get_alternative_stylesheets($full_path=FALSE) {
de4d58cb 1175
d4c2aa24 1176 // since any page from a parent template set
1177 // could end up being loaded, we will load
6806cbe5 1178 // all alternate css files from ancestor
d4c2aa24 1179 // template sets, not just this set
1180 //
e5d57179 1181 $css_directories = $this->get_template_file_path('css/alternates/', TRUE, TRUE);
d4c2aa24 1182
1183
e5d57179 1184 // prettify names
d4c2aa24 1185 //
1186 $return_array = array();
e5d57179 1187 foreach ($css_directories as $directory) {
d4c2aa24 1188
e5d57179 1189 // CVS directories are not wanted
1190 //
1191 if (strpos($directory, '/CVS') === strlen($directory) - 4) continue;
d4c2aa24 1192
e5d57179 1193 $pretty_name = ucwords(str_replace('_', ' ', basename($directory)));
d4c2aa24 1194
1195 if ($full_path) {
e5d57179 1196 $return_array[$directory] = $pretty_name;
d4c2aa24 1197 } else {
e5d57179 1198 $return_array[basename($directory)] = $pretty_name;
de4d58cb 1199 }
d4c2aa24 1200
de4d58cb 1201 }
1202
d4c2aa24 1203 return $return_array;
de4d58cb 1204
1205 }
1206
1207 /**
6806cbe5 1208 * Return all standard stylsheets provided by the template.
de4d58cb 1209 *
d4c2aa24 1210 * All files found in the template set's "css" directory (and
6806cbe5 1211 * that of its ancestors) with the extension ".css" except
d4c2aa24 1212 * "rtl.css" (which is dealt with separately) are returned.
de4d58cb 1213 *
1214 * @param boolean $full_path When FALSE, only the file names
1215 * are included in the return array;
1216 * otherwise, path information is
1217 * included (relative to SM_PATH)
1218 * (OPTIONAL; default only file names)
1219 *
1220 * @return array The required file names/paths.
1221 *
1222 */
1223 function get_stylesheets($full_path=FALSE) {
1224
6806cbe5 1225 // since any page from a parent template set
d4c2aa24 1226 // could end up being loaded, we have to load
1227 // all css files from ancestor template sets,
1228 // not just this set
1229 //
1230 //$directory = SM_PATH . $this->get_template_file_directory() . 'css';
1231 //$css_files = list_files($directory, '.css', !$full_path);
1232 //
1233 $css_files = $this->get_template_file_path('css/');
1234
de4d58cb 1235
6806cbe5 1236 // need to leave out "rtl.css"
d4c2aa24 1237 //
de4d58cb 1238 $return_array = array();
d4c2aa24 1239 foreach ($css_files as $file) {
de4d58cb 1240
d4c2aa24 1241 if (substr($file, strlen($file) - 4) != '.css') continue;
1242 if (strtolower(basename($file)) == 'rtl.css') continue;
de4d58cb 1243
d4c2aa24 1244 if ($full_path) {
1245 $return_array[] = $file;
1246 } else {
1247 $return_array[] = basename($file);
1248 }
de4d58cb 1249
1250 }
1251
c404d448 1252
1253 // return sheets for the current template set
6806cbe5 1254 // last so we can enable any custom overrides
1255 // of styles in ancestor sheets
c404d448 1256 //
1257 return array_reverse($return_array);
de4d58cb 1258
1259 }
1260
1261 /**
1262 * Generate links to all this template set's standard stylesheets
1263 *
6806cbe5 1264 * Subclasses can override this function if stylesheets are
de4d58cb 1265 * created differently for the template set's target output
1266 * interface.
1267 *
1268 * @return string The stylesheet links as they should be sent
1269 * to the browser.
1270 *
1271 */
1272 function fetch_standard_stylesheet_links()
1273 {
1274
1275 $sheets = $this->get_stylesheets(TRUE);
1276 return $this->fetch_external_stylesheet_links($sheets);
1277
1278 }
1279
1280 /**
6806cbe5 1281 * Push out any other stylesheet links as provided (for
de4d58cb 1282 * stylesheets not included with the current template set)
1283 *
6806cbe5 1284 * Subclasses can override this function if stylesheets are
de4d58cb 1285 * created differently for the template set's target output
1286 * interface.
1287 *
6806cbe5 1288 * @param mixed $sheets List of the desired stylesheets
de4d58cb 1289 * (file path to be used in stylesheet
6806cbe5 1290 * href attribute) to output (or single
de4d58cb 1291 * stylesheet file path).
6806cbe5 1292FIXME: We could make the incoming array more complex so it can
de4d58cb 1293 also contain the other parameters for create_css_link()
1294 such as $name, $alt, $mtype, and $xhtml_end
1295 But do we need to?
1296 *
1297 * @return string The stylesheet links as they should be sent
1298 * to the browser.
1299 *
1300 */
1301 function fetch_external_stylesheet_links($sheets)
1302 {
1303
1304 if (!is_array($sheets)) $sheets = array($sheets);
1305 $output = '';
1306
1307 foreach ($sheets as $sheet) {
1308 $output .= create_css_link($sheet);
1309 }
1310
1311 return $output;
1312
1313 }
1314
1315 /**
1316 * Send HTTP header(s) to browser.
1317 *
1318 * Subclasses can override this function if headers are
7ca9685a 1319 * managed differently in the engine's target output
de4d58cb 1320 * interface.
1321 *
6806cbe5 1322 * @param mixed $headers A list of (or a single) header
de4d58cb 1323 * text to be sent.
1324 *
1325 */
1326 function header($headers)
1327 {
1328
1329 if (!is_array($headers)) $headers = array($headers);
1330
1331 foreach ($headers as $header) {
7ca9685a 1332 $this->assign('header', $header);
1333 header($this->fetch('header.tpl'));
de4d58cb 1334 }
1335
1336 }
1337
1338 /**
6806cbe5 1339 * Generate a link to the right-to-left stylesheet for
d4c2aa24 1340 * this template set by getting the "rtl.css" file from
1341 * this template set, its parent (or grandparent, etc.)
6806cbe5 1342 * template set, the fall-back template set, or finally,
d4c2aa24 1343 * fall back to SquirrelMail's own "rtl.css" if need be.
de4d58cb 1344 *
6806cbe5 1345 * Subclasses can override this function if stylesheets are
de4d58cb 1346 * created differently for the template set's target output
1347 * interface.
1348 *
1349 * @return string The stylesheet link as it should be sent
1350 * to the browser.
1351 *
1352 */
1353 function fetch_right_to_left_stylesheet_link()
1354 {
1355
1356 // get right template file
1357 //
1358 $sheet = $this->get_template_file_path('css/rtl.css');
1359
1360 // fall back to SquirrelMail's own default stylesheet
1361 //
1362 if (empty($sheet)) {
1363 $sheet = SM_PATH . 'css/rtl.css';
1364 }
1365
1366 return create_css_link($sheet);
1367
1368 }
1369
1370 /**
1371 * Display the template
1372 *
1373 * @param string $file The template file to use
1374 *
1375 */
1376 function display($file)
1377 {
1378
1379 echo $this->fetch($file);
1380
1381 }
1382
1383 /**
1384 * Applies the template and returns the resultant content string.
1385 *
1386 * @param string $file The template file to use
1387 *
1388 * @return string The template contents after applying the given template
1389 *
1390 */
1391 function fetch($file) {
1392
1393 // get right template file
1394 //
1395 $template = $this->get_template_file_path($file);
1396
d4c2aa24 1397
6806cbe5 1398 // special case stylesheet.tpl falls back to SquirrelMail's
de4d58cb 1399 // own default stylesheet
1400 //
1401 if (empty($template) && $file == 'css/stylesheet.tpl') {
1402 $template = SM_PATH . 'css/default.css';
1403 }
1404
d4c2aa24 1405
de4d58cb 1406 if (empty($template)) {
1407
1408 trigger_error('The template "' . htmlspecialchars($file)
1409 . '" could not be fetched!', E_USER_ERROR);
1410
1411 } else {
1412
1413 $aPluginOutput = array();
0db60ced 1414 $aPluginOutput = concat_hook_function('template_construct_' . $file,
1415 $temp=array(&$aPluginOutput, &$this),
1416 TRUE);
de4d58cb 1417 $this->assign('plugin_output', $aPluginOutput);
1418
d4c2aa24 1419 //$output = $this->apply_template($template);
1420 $rendering_engine = $this->get_rendering_template_engine_object($file);
1421 $output = $rendering_engine->apply_template($template);
de4d58cb 1422
1423 // CAUTION: USE OF THIS HOOK IS HIGHLY DISCOURAGED AND CAN
1424 // RESULT IN NOTICABLE PERFORMANCE DEGREDATION. Plugins
1425 // using this hook will probably be rejected by the
1426 // SquirrelMail team.
1427 //
d849b570 1428 do_hook('template_output', $output);
de4d58cb 1429
1430 return $output;
1431
1432 }
1433
1434 }
1435
1436 /**
1437 * Assigns values to template variables
1438 *
1439 * Note: this is an abstract method that must be implemented by subclass.
1440 *
1441 * @param array|string $tpl_var the template variable name(s)
1442 * @param mixed $value the value to assign
1443 *
1444 */
1445 function assign($tpl_var, $value = NULL) {
1446
1447 trigger_error('Template subclass (' . $this->template_engine . 'Template.class.php) needs to implement the assign() method.', E_USER_ERROR);
1448
1449 }
1450
1451 /**
1452 * Assigns values to template variables by reference
1453 *
1454 * Note: this is an abstract method that must be implemented by subclass.
1455 *
1456 * @param string $tpl_var the template variable name
1457 * @param mixed $value the referenced value to assign
1458 *
1459 */
1460 function assign_by_ref($tpl_var, &$value) {
1461
1462 trigger_error('Template subclass (' . $this->template_engine . 'Template.class.php) needs to implement the assign_by_ref() method.', E_USER_ERROR);
1463
1464 }
1465
1466 /**
d4c2aa24 1467 * Clears the values of all assigned varaiables.
1468 *
1469 */
1470 function clear_all_assign() {
1471
1472 trigger_error('Template subclass (' . $this->template_engine . 'Template.class.php) needs to implement the clear_all_assign() method.', E_USER_ERROR);
1473
1474 }
1475
1476 /**
1477 * Returns assigned variable value(s).
1478 *
1479 * @param string $varname If given, the value of that variable
1480 * is returned, assuming it has been
1481 * previously assigned. If not specified
1482 * an array of all assigned variables is
1483 * returned. (optional)
1484 *
1485 * @return mixed Desired single variable value or list of all
1486 * assigned variable values.
1487 *
1488 */
1489 function get_template_vars($varname=NULL) {
1490
1491 trigger_error('Template subclass (' . $this->template_engine . 'Template.class.php) needs to implement the get_template_vars() method.', E_USER_ERROR);
1492
1493 }
1494
1495 /**
de4d58cb 1496 * Appends values to template variables
1497 *
1498 * Note: this is an abstract method that must be implemented by subclass.
1499 *
1500 * @param array|string $tpl_var the template variable name(s)
1501 * @param mixed $value the value to append
1502 * @param boolean $merge when $value is given as an array,
1503 * this indicates whether or not that
1504 * array itself should be appended as
1505 * a new template variable value or if
1506 * that array's values should be merged
1507 * into the existing array of template
1508 * variable values
1509 *
1510 */
1511 function append($tpl_var, $value = NULL, $merge = FALSE) {
1512
1513 trigger_error('Template subclass (' . $this->template_engine . 'Template.class.php) needs to implement the append() method.', E_USER_ERROR);
1514
1515 }
1516
1517 /**
1518 * Appends values to template variables by reference
1519 *
1520 * Note: this is an abstract method that must be implemented by subclass.
1521 *
1522 * @param string $tpl_var the template variable name
1523 * @param mixed $value the referenced value to append
1524 * @param boolean $merge when $value is given as an array,
1525 * this indicates whether or not that
1526 * array itself should be appended as
1527 * a new template variable value or if
1528 * that array's values should be merged
1529 * into the existing array of template
1530 * variable values
1531 *
1532 */
1533 function append_by_ref($tpl_var, &$value, $merge = FALSE) {
1534
1535 trigger_error('Template subclass (' . $this->template_engine . 'Template.class.php) needs to implement the append_by_ref() method.', E_USER_ERROR);
1536
1537 }
1538
1539 /**
1540 * Applys the template and generates final output destined
1541 * for the user's browser
1542 *
1543 * Note: this is an abstract method that must be implemented by subclass.
1544 *
1545 * @param string $filepath The full file path to the template to be applied
6806cbe5 1546 *
de4d58cb 1547 * @return string The output for the given template
1548 *
1549 */
1550 function apply_template($filepath) {
1551
1552 trigger_error('Template subclass (' . $this->template_engine . 'Template.class.php) needs to implement the apply_template() method.', E_USER_ERROR);
1553
1554 }
1555
1556}
1557