inc/classes/main/template/class_BaseTemplateEngine.php

   1 <?php
   2 /**
   3  * A generic template engine
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class BaseTemplateEngine extends BaseFrameworkSystem {
  25         /**
  26          * The local path name where all templates and sub folders for special
  27          * templates are stored. We will internally determine the language plus
  28          * "html" for web templates or "emails" for email templates
  29          */
  30         private $templateBasePath = '';
  31
  32         /**
  33          * Template type
  34          */
  35         private $templateType = 'html';
  36
  37         /**
  38          * The extension for web and email templates (not compiled templates)
  39          */
  40         private $templateExtension = '.tpl';
  41
  42         /**
  43          * The extension for code templates (not compiled templates)
  44          */
  45         private $codeExtension = '.ctp';
  46
  47         /**
  48          * Path relative to $templateBasePath and language code for compiled code-templates
  49          */
  50         private $compileOutputPath = 'templates/_compiled/';
  51
  52         /**
  53          * The path name for all templates
  54          */
  55         private $genericBasePath = 'templates/';
  56
  57         /**
  58          * The raw (maybe uncompiled) template
  59          */
  60         private $rawTemplateData = '';
  61
  62         /**
  63          * Template data with compiled-in variables
  64          */
  65         private $compiledData = '';
  66
  67         /**
  68          * The last loaded template's FQFN for debugging the engine
  69          */
  70         private $lastTemplate = '';
  71
  72         /**
  73          * The variable stack for the templates
  74          */
  75         private $varStack = array();
  76
  77         /**
  78          * Loaded templates for recursive protection and detection
  79          */
  80         private $loadedTemplates = array();
  81
  82         /**
  83          * Compiled templates for recursive protection and detection
  84          */
  85         private $compiledTemplates = array();
  86
  87         /**
  88          * Loaded raw template data
  89          */
  90         private $loadedRawData = NULL;
  91
  92         /**
  93          * Raw templates which are linked in code templates
  94          */
  95         private $rawTemplates = NULL;
  96
  97         /**
  98          * A regular expression for variable=value pairs
  99          */
 100         private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/';
 101
 102         /**
 103          * A regular expression for filtering out code tags
 104          *
 105          * E.g.: {?template:variable=value;var2=value2;[...]?}
 106          */
 107         private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
 108
 109         /**
 110          * Loaded helpers
 111          */
 112         private $helpers = array();
 113
 114         /**
 115          * Current variable group
 116          */
 117         private $currGroup = 'general';
 118
 119         /**
 120          * All template groups except "general"
 121          */
 122         private $varGroups = array();
 123
 124         /**
 125          * Code begin
 126          */
 127         private $codeBegin = '<?php';
 128
 129         /**
 130          * Code end
 131          */
 132         private $codeEnd = '?>';
 133
 134         /**
 135          * Language support is enabled by default
 136          */
 137         private $languageSupport = true;
 138
 139         /**
 140          * XML compacting is disabled by default
 141          */
 142         private $xmlCompacting = false;
 143
 144         // Exception codes for the template engine
 145         const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0x110;
 146         const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
 147         const EXCEPTION_INVALID_VIEW_HELPER           = 0x112;
 148         const EXCEPTION_VARIABLE_IS_MISSING           = 0x113;
 149
 150         /**
 151          * Protected constructor
 152          *
 153          * @param       $className      Name of the class
 154          * @return      void
 155          */
 156         protected function __construct ($className) {
 157                 // Call parent constructor
 158                 parent::__construct($className);
 159
 160                 // Init file I/O instance
 161                 $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
 162
 163                 // Set it
 164                 $this->setFileIoInstance($ioInstance);
 165         }
 166
 167         /**
 168          * Search for a variable in the stack
 169          *
 170          * @param       $var    The variable we are looking for
 171          * @param       $stack  Optional variable stack to look in
 172          * @return      $index  FALSE means not found, >=0 means found on a specific index
 173          */
 174         private function getVariableIndex ($var, $stack = NULL) {
 175                 // Replace all dashes to underscores to match variables with configuration entries
 176                 $var = trim($this->convertDashesToUnderscores($var));
 177
 178                 // First everything is not found
 179                 $found = false;
 180
 181                 // If the stack is null, use the current group
 182                 if (is_null($stack)) {
 183                         // Use current group
 184                         //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
 185                         $stack = $this->currGroup;
 186                 } // END - if
 187
 188                 // Is the group there?
 189                 if ($this->isVarStackSet($stack)) {
 190                         // Now search for it
 191                         foreach ($this->getVarStack($stack) as $index => $currEntry) {
 192                                 //* DEBUG: */ $this->debugOutput(__METHOD__.':currGroup=' . $stack . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',var=' . $var);
 193                                 // Is the entry found?
 194                                 if ($currEntry['name'] == $var) {
 195                                         // Found!
 196                                         //* DEBUG: */ $this->debugOutput(__METHOD__.':FOUND!');
 197                                         $found = $index;
 198                                         break;
 199                                 } // END - if
 200                         } // END - foreach
 201                 } // END - if
 202
 203                 // Return the current position
 204                 return $found;
 205         }
 206
 207         /**
 208          * Checks whether the given variable stack is set
 209          *
 210          * @param       $stack  Variable stack to check
 211          * @return      $isSet  Whether the given variable stack is set
 212          */
 213         protected final function isVarStackSet ($stack) {
 214                 // Check it
 215                 $isSet = isset($this->varStack[$stack]);
 216
 217                 // Return result
 218                 return $isSet;
 219         }
 220
 221         /**
 222          * Getter for given variable stack
 223          *
 224          * @param       $stack          Variable stack to check
 225          * @return      $varStack       Found variable stack
 226          */
 227         public final function getVarStack ($stack) {
 228                 return $this->varStack[$stack];
 229         }
 230
 231         /**
 232          * Setter for given variable stack
 233          *
 234          * @param       $stack          Variable stack to check
 235          * @param       $varStack       Variable stack to check
 236          * @return      void
 237          */
 238         protected final function setVarStack ($stack, array $varStack) {
 239                 $this->varStack[$stack]  = $varStack;
 240         }
 241
 242         /**
 243          * Return a content of a variable or null if not found
 244          *
 245          * @param       $var            The variable we are looking for
 246          * @param       $stack          Optional variable stack to look in
 247          * @return      $content        Content of the variable or null if not found
 248          */
 249         protected function readVariable ($var, $stack = NULL) {
 250                 // Replace all dashes to underscores to match variables with configuration entries
 251                 $var = trim($this->convertDashesToUnderscores($var));
 252
 253                 // First everything is not found
 254                 $content = NULL;
 255
 256                 // If the stack is null, use the current group
 257                 if (is_null($stack)) {
 258                         // Use current group
 259                         //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
 260                         $stack = $this->currGroup;
 261                 } // END - if
 262
 263                 // Get variable index
 264                 $found = $this->getVariableIndex($var, $stack);
 265
 266                 // Is the variable found?
 267                 if ($found !== false) {
 268                         // Read it
 269                         $content = $this->getVariableValue($stack, $found);
 270                 } // END - if
 271
 272                 // Return the current position
 273                 //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $stack . ',var=' . $var . ', content[' . gettype($content) . ']=' . $content);
 274                 return $content;
 275         }
 276
 277         /**
 278          * Add a variable to the stack
 279          *
 280          * @param       $var    The variable we are looking for
 281          * @param       $value  The value we want to store in the variable
 282          * @return      void
 283          */
 284         private function addVariable ($var, $value) {
 285                 // Set general variable group
 286                 $this->setVariableGroup('general');
 287
 288                 // Add it to the stack
 289                 $this->addGroupVariable($var, $value);
 290         }
 291
 292         /**
 293          * Returns all variables of current group or empty array
 294          *
 295          * @return      $result         Whether array of found variables or empty array
 296          */
 297         private function readCurrentGroup () {
 298                 // Default is not found
 299                 $result = array();
 300
 301                 // Is the group there?
 302                 if ($this->isVarStackSet($this->currGroup)) {
 303                         // Then use it
 304                         $result = $this->getVarStack($this->currGroup);
 305                 } // END - if
 306
 307                 // Return result
 308                 return $result;
 309         }
 310
 311         /**
 312          * Settter for variable group
 313          *
 314          * @param       $groupName      Name of variable group
 315          * @param       $add            Whether add this group
 316          * @return      void
 317          */
 318         public function setVariableGroup ($groupName, $add = true) {
 319                 // Set group name
 320                 //* DEBIG: */ $this->debugOutput(__METHOD__.': currGroup=' . $groupName);
 321                 $this->currGroup = $groupName;
 322
 323                 // Skip group 'general'
 324                 if (($groupName != 'general') && ($add === true)) {
 325                         $this->varGroups[$groupName] = 'OK';
 326                 } // END - if
 327         }
 328
 329
 330         /**
 331          * Adds a variable to current group
 332          *
 333          * @param       $var    Variable to set
 334          * @param       $value  Value to store in variable
 335          * @return      void
 336          */
 337         public function addGroupVariable ($var, $value) {
 338                 // Replace all dashes to underscores to match variables with configuration entries
 339                 $var = trim($this->convertDashesToUnderscores($var));
 340
 341                 // Debug message
 342                 //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $this->currGroup . ', var=' . $var . ', value=' . $value);
 343
 344                 // Get current variables in group
 345                 $currVars = $this->readCurrentGroup();
 346
 347                 // Append our variable
 348                 $currVars[] = $this->generateVariableArray($var, $value);
 349
 350                 // Add it to the stack
 351                 $this->setVarStack($this->currGroup, $currVars);
 352         }
 353
 354         /**
 355          * Getter for variable value, throws a NoVariableException if the variable is not found
 356          *
 357          * @param       $varGroup       Variable group to use
 358          * @param       $index          Index in variable array
 359          * @return      $value          Value to set
 360          */
 361         private function getVariableValue ($varGroup, $index) {
 362                 // Return it
 363                 return $this->varStack[$varGroup][$index]['value'];
 364         }
 365
 366         /**
 367          * Modify an entry on the stack
 368          *
 369          * @param       $var    The variable we are looking for
 370          * @param       $value  The value we want to store in the variable
 371          * @return      void
 372          * @throws      NoVariableException     If the given variable is not found
 373          */
 374         private function modifyVariable ($var, $value) {
 375                 // Replace all dashes to underscores to match variables with configuration entries
 376                 $var = trim($this->convertDashesToUnderscores($var));
 377
 378                 // Get index for variable
 379                 $index = $this->getVariableIndex($var);
 380
 381                 // Is the variable set?
 382                 if ($index === false) {
 383                         // Unset variables cannot be modified
 384                         throw new NoVariableException(array($this, $var, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
 385                 } // END - if
 386
 387                 // Then modify it
 388                 $this->setVariableValue($this->currGroup, $index, $value);
 389         }
 390
 391         /**
 392          * Sets a variable value for given variable group and index
 393          *
 394          * @param       $varGroup       Variable group to use
 395          * @param       $index          Index in variable array
 396          * @param       $value          Value to set
 397          * @return      void
 398          */
 399         private function setVariableValue ($varGroup, $index, $value) {
 400                 $this->varStack[$varGroup][$index]['value'] = $value;
 401         }
 402
 403         /**
 404          * Sets a variable within given group. This method does detect if the
 405          * variable is already set. If so, the variable got modified, otherwise
 406          * added.
 407          *
 408          * @param       $varGroup       Variable group to use
 409          * @param       $var            Variable to set
 410          * @param       $value          Value to set
 411          * @return      void
 412          */
 413         protected function setVariable ($varGroup, $var, $value) {
 414                 // Replace all dashes to underscores to match variables with configuration entries
 415                 $var = trim($this->convertDashesToUnderscores($var));
 416
 417                 // Get index for variable
 418                 $index = $this->getVariableIndex($var);
 419
 420                 // Is the variable set?
 421                 if ($index === false) {
 422                         // Not found, add it
 423                         $this->varStack[$varGroup][] = $this->generateVariableArray($var, $value);
 424                 } else {
 425                         // Then modify it
 426                         $this->setVariableValue($this->currGroup, $index, $value);
 427                 }
 428         }
 429
 430         /**
 431          * "Generates" (better returns) an array for all variables for given
 432          * variable/value pay.
 433          *
 434          * @param       $var            Variable to set
 435          * @param       $value          Value to set
 436          * @return      $varData        Variable data array
 437          */
 438         private function generateVariableArray ($var, $value) {
 439                 // Replace all dashes to underscores to match variables with configuration entries
 440                 $var = trim($this->convertDashesToUnderscores($var));
 441
 442                 // Generate the temporary array
 443                 $varData = array(
 444                         'name'  => $var,
 445                         'value' => $value
 446                 );
 447
 448                 // And return it
 449                 return $varData;
 450         }
 451
 452         /**
 453          * Setter for template type. Only 'html', 'emails' and 'compiled' should
 454          * be sent here
 455          *
 456          * @param       $templateType   The current template's type
 457          * @return      void
 458          */
 459         protected final function setTemplateType ($templateType) {
 460                 $this->templateType = (string) $templateType;
 461         }
 462
 463         /**
 464          * Setter for the last loaded template's FQFN
 465          *
 466          * @param       $template       The last loaded template
 467          * @return      void
 468          */
 469         private final function setLastTemplate ($template) {
 470                 $this->lastTemplate = (string) $template;
 471         }
 472
 473         /**
 474          * Getter for the last loaded template's FQFN
 475          *
 476          * @return      $template       The last loaded template
 477          */
 478         private final function getLastTemplate () {
 479                 return $this->lastTemplate;
 480         }
 481
 482         /**
 483          * Setter for base path
 484          *
 485          * @param               $templateBasePath               The relative base path for all templates
 486          * @return      void
 487          */
 488         public final function setTemplateBasePath ($templateBasePath) {
 489                 // And set it
 490                 $this->templateBasePath = (string) $templateBasePath;
 491         }
 492
 493         /**
 494          * Getter for base path
 495          *
 496          * @return      $templateBasePath               The relative base path for all templates
 497          */
 498         public final function getTemplateBasePath () {
 499                 // And set it
 500                 return $this->templateBasePath;
 501         }
 502
 503         /**
 504          * Getter for generic base path
 505          *
 506          * @return      $templateBasePath               The relative base path for all templates
 507          */
 508         public final function getGenericBasePath () {
 509                 // And set it
 510                 return $this->genericBasePath;
 511         }
 512
 513         /**
 514          * Setter for template extension
 515          *
 516          * @param               $templateExtension      The file extension for all uncompiled
 517          *                                                      templates
 518          * @return      void
 519          */
 520         public final function setRawTemplateExtension ($templateExtension) {
 521                 // And set it
 522                 $this->templateExtension = (string) $templateExtension;
 523         }
 524
 525         /**
 526          * Setter for code template extension
 527          *
 528          * @param               $codeExtension          The file extension for all uncompiled
 529          *                                                      templates
 530          * @return      void
 531          */
 532         public final function setCodeTemplateExtension ($codeExtension) {
 533                 // And set it
 534                 $this->codeExtension = (string) $codeExtension;
 535         }
 536
 537         /**
 538          * Getter for template extension
 539          *
 540          * @return      $templateExtension      The file extension for all uncompiled
 541          *                                                      templates
 542          */
 543         public final function getRawTemplateExtension () {
 544                 // And set it
 545                 return $this->templateExtension;
 546         }
 547
 548         /**
 549          * Getter for code-template extension
 550          *
 551          * @return      $codeExtension          The file extension for all code-
 552          *                                                      templates
 553          */
 554         public final function getCodeTemplateExtension () {
 555                 // And set it
 556                 return $this->codeExtension;
 557         }
 558
 559         /**
 560          * Setter for path of compiled templates
 561          *
 562          * @param       $compileOutputPath      The local base path for all compiled
 563          *                                                              templates
 564          * @return      void
 565          */
 566         public final function setCompileOutputPath ($compileOutputPath) {
 567                 // And set it
 568                 $this->compileOutputPath = (string) $compileOutputPath;
 569         }
 570
 571         /**
 572          * Getter for template type
 573          *
 574          * @return      $templateType   The current template's type
 575          */
 576         public final function getTemplateType () {
 577                 return $this->templateType;
 578         }
 579
 580         /**
 581          * Assign (add) a given variable with a value
 582          *
 583          * @param       $var    The variable we are looking for
 584          * @param       $value  The value we want to store in the variable
 585          * @return      void
 586          * @throws      EmptyVariableException  If the variable name is left empty
 587          */
 588         public final function assignVariable ($var, $value) {
 589                 // Replace all dashes to underscores to match variables with configuration entries
 590                 $var = trim($this->convertDashesToUnderscores($var));
 591
 592                 // Empty variable found?
 593                 if (empty($var)) {
 594                         // Throw an exception
 595                         throw new EmptyVariableException(array($this, 'var'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
 596                 } // END - if
 597
 598                 // First search for the variable if it was already added
 599                 $index = $this->getVariableIndex($var);
 600
 601                 // Was it found?
 602                 if ($index === false) {
 603                         // Add it to the stack
 604                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ':ADD: ' . $var . '[' . gettype($value) . ']=' . $value);
 605                         $this->addVariable($var, $value);
 606                 } elseif (!empty($value)) {
 607                         // Modify the stack entry
 608                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ':MOD: ' . $var . '[' . gettype($value) . ']=' . $value);
 609                         $this->modifyVariable($var, $value);
 610                 }
 611         }
 612
 613         /**
 614          * Removes a given variable
 615          *
 616          * @param       $var    The variable we are looking for
 617          * @return      void
 618          */
 619         public final function removeVariable ($var) {
 620                 // First search for the variable if it was already added
 621                 $index = $this->getVariableIndex($var);
 622
 623                 // Was it found?
 624                 if ($index !== false) {
 625                         // Remove this variable
 626                         $this->unsetVariableStackOffset($index);
 627                 } // END - if
 628         }
 629
 630         /**
 631          * Unsets the given offset in the variable stack
 632          *
 633          * @param       $index  Index to unset
 634          * @return      void
 635          */
 636         protected final function unsetVariableStackOffset ($index) {
 637                 // Is the entry there?
 638                 if (!isset($this->varStack[$this->currGroup][$index])) {
 639                         // Abort here, we need fixing!
 640                         $this->debugInstance();
 641                 } // END - if
 642
 643                 // Remove it
 644                 unset($this->varStack[$this->currGroup][$index]);
 645         }
 646
 647         /**
 648          * Private setter for raw template data
 649          *
 650          * @param       $rawTemplateData        The raw data from the template
 651          * @return      void
 652          */
 653         protected final function setRawTemplateData ($rawTemplateData) {
 654                 // And store it in this class
 655                 //* DEBUG: */ $this->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
 656                 //* DEBUG: */ $this->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
 657                 $this->rawTemplateData = (string) $rawTemplateData;
 658         }
 659
 660         /**
 661          * Getter for raw template data
 662          *
 663          * @return      $rawTemplateData        The raw data from the template
 664          */
 665         public final function getRawTemplateData () {
 666                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
 667                 return $this->rawTemplateData;
 668         }
 669
 670         /**
 671          * Private setter for compiled templates
 672          *
 673          * @return      void
 674          */
 675         private final function setCompiledData ($compiledData) {
 676                 // And store it in this class
 677                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
 678                 $this->compiledData = (string) $compiledData;
 679         }
 680
 681         /**
 682          * Getter for compiled templates
 683          *
 684          * @return      $compiledData   Compiled template data
 685          */
 686         public final function getCompiledData () {
 687                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.');
 688                 return $this->compiledData;
 689         }
 690
 691         /**
 692          * Private loader for all template types
 693          *
 694          * @param       $template       The template we shall load
 695          * @param       $extOther       An other extension to use
 696          * @return      void
 697          * @throws      FileIoException If the template was not found
 698          */
 699         protected function loadTemplate ($template, $extOther = '') {
 700                 // Get extension for the template if empty
 701                 if (empty($extOther)) {
 702                         // None provided, so get the raw one
 703                         $ext = $this->getRawTemplateExtension();
 704                 } else {
 705                         // Then use it!
 706                         $ext = (string) $extOther;
 707                 }
 708
 709                 // Is language support enabled?
 710                 if ($this->isLanguageSupportEnabled()) {
 711                         // Construct the FQFN for the template by honoring the current language
 712                         $fqfn = sprintf("%s%s%s%s/%s/%s%s",
 713                                 $this->getConfigInstance()->getConfigEntry('base_path'),
 714                                 $this->getTemplateBasePath(),
 715                                 $this->getGenericBasePath(),
 716                                 $this->getLanguageInstance()->getLanguageCode(),
 717                                 $this->getTemplateType(),
 718                                 (string) $template,
 719                                 $ext
 720                         );
 721                 } else {
 722                         // Construct the FQFN for the template without language
 723                         $fqfn = sprintf("%s%s%s%s/%s%s",
 724                                 $this->getConfigInstance()->getConfigEntry('base_path'),
 725                                 $this->getTemplateBasePath(),
 726                                 $this->getGenericBasePath(),
 727                                 $this->getTemplateType(),
 728                                 (string) $template,
 729                                 $ext
 730                         );
 731                 }
 732
 733                 // First try this
 734                 try {
 735                         // Load the raw template data
 736                         $this->loadRawTemplateData($fqfn);
 737                 } catch (FileIoException $e) {
 738                         // If we shall load a code-template we need to switch the file extension
 739                         if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
 740                                 // Switch over to the code-template extension and try it again
 741                                 $ext = $this->getCodeTemplateExtension();
 742
 743                                 // Try it again...
 744                                 $this->loadTemplate($template, $ext);
 745                         } else {
 746                                 // Throw it again
 747                                 throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
 748                         }
 749                 }
 750
 751         }
 752
 753         /**
 754          * A private loader for raw template names
 755          *
 756          * @param       $fqfn   The full-qualified file name for a template
 757          * @return      void
 758          */
 759         private function loadRawTemplateData ($fqfn) {
 760                 // Get a input/output instance from the middleware
 761                 $ioInstance = $this->getFileIoInstance();
 762
 763                 // Some debug code to look on the file which is being loaded
 764                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
 765
 766                 // Load the raw template
 767                 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
 768
 769                 // Store the template's contents into this class
 770                 $this->setRawTemplateData($rawTemplateData);
 771
 772                 // Remember the template's FQFN
 773                 $this->setLastTemplate($fqfn);
 774         }
 775
 776         /**
 777          * Try to assign an extracted template variable as a "content" or 'config'
 778          * variable.
 779          *
 780          * @param       $varName        The variable's name (shall be content orconfig) by
 781          *                                              default
 782          * @param       $var            The variable we want to assign
 783          */
 784         private function assignTemplateVariable ($varName, $var) {
 785                 // Replace all dashes to underscores to match variables with configuration entries
 786                 $var = trim($this->convertDashesToUnderscores($var));
 787
 788                 // Debug message
 789                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': varName=' . $varName . ',var=' . $var);
 790
 791                 // Is it not a config variable?
 792                 if ($varName != 'config') {
 793                         // Regular template variables
 794                         $this->assignVariable($var, '');
 795                 } else {
 796                         // Configuration variables
 797                         $this->assignConfigVariable($var);
 798                 }
 799         }
 800
 801         /**
 802          * Extract variables from a given raw data stream
 803          *
 804          * @param       $rawData        The raw template data we shall analyze
 805          * @return      void
 806          */
 807         private function extractVariablesFromRawData ($rawData) {
 808                 // Cast to string
 809                 $rawData = (string) $rawData;
 810
 811                 // Search for variables
 812                 preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
 813
 814                 // Debug message
 815                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, true));
 816
 817                 // Did we find some variables?
 818                 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
 819                         // Initialize all missing variables
 820                         foreach ($variableMatches[3] as $key => $var) {
 821                                 // Variable name
 822                                 $varName = $variableMatches[1][$key];
 823
 824                                 // Workarround: Do not assign empty variables
 825                                 if (!empty($var)) {
 826                                         // Try to assign it, empty strings are being ignored
 827                                         $this->assignTemplateVariable($varName, $var);
 828                                 } // END - if
 829                         } // END - foreach
 830                 } // END - if
 831         }
 832
 833         /**
 834          * Main analysis of the loaded template
 835          *
 836          * @param       $templateMatches        Found template place-holders, see below
 837          * @return      void
 838          *
 839          *---------------------------------
 840          * Structure of $templateMatches:
 841          *---------------------------------
 842          * [0] => Array - An array with all full matches
 843          * [1] => Array - An array with left part (before the ':') of a match
 844          * [2] => Array - An array with right part of a match including ':'
 845          * [3] => Array - An array with right part of a match excluding ':'
 846          */
 847         private function analyzeTemplate (array $templateMatches) {
 848                 // Backup raw template data
 849                 $backup = $this->getRawTemplateData();
 850
 851                 // Initialize some arrays
 852                 if (is_null($this->loadedRawData)) {
 853                         // Initialize both
 854                         $this->loadedRawData = array();
 855                         $this->rawTemplates = array();
 856                 } // END - if
 857
 858                 // Load all requested templates
 859                 foreach ($templateMatches[1] as $template) {
 860                         // Load and compile only templates which we have not yet loaded
 861                         // RECURSIVE PROTECTION! BE CAREFUL HERE!
 862                         if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
 863                                 // Debug message
 864                                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':template=' . $template);
 865
 866                                 // Template not found, but maybe variable assigned?
 867                                 if ($this->getVariableIndex($template, 'config') !== false) {
 868                                         // Use that content here
 869                                         $this->loadedRawData[$template] = $this->readVariable($template, 'config');
 870
 871                                         // Recursive protection:
 872                                         $this->loadedTemplates[] = $template;
 873                                 } elseif ($this->getVariableIndex($template) !== false) {
 874                                         // Use that content here
 875                                         $this->loadedRawData[$template] = $this->readVariable($template);
 876
 877                                         // Recursive protection:
 878                                         $this->loadedTemplates[] = $template;
 879                                 } else {
 880                                         // Then try to search for code-templates
 881                                         try {
 882                                                 // Load the code template and remember it's contents
 883                                                 $this->loadCodeTemplate($template);
 884                                                 $this->loadedRawData[$template] = $this->getRawTemplateData();
 885
 886                                                 // Remember this template for recursion detection
 887                                                 // RECURSIVE PROTECTION!
 888                                                 $this->loadedTemplates[] = $template;
 889                                         } catch (FileIoException $e) {
 890                                                 // Even this is not done... :/
 891                                                 $this->rawTemplates[] = $template;
 892                                         }
 893                                 }
 894                         } // END - if
 895                 } // END - foreach
 896
 897                 // Restore the raw template data
 898                 $this->setRawTemplateData($backup);
 899         }
 900
 901         /**
 902          * Compile a given raw template code and remember it for later usage
 903          *
 904          * @param       $code           The raw template code
 905          * @param       $template       The template's name
 906          * @return      void
 907          */
 908         private function compileCode ($code, $template) {
 909                 // Is this template already compiled?
 910                 if (in_array($template, $this->compiledTemplates)) {
 911                         // Abort here...
 912                         return;
 913                 } // END - if
 914
 915                 // Remember this template being compiled
 916                 $this->compiledTemplates[] = $template;
 917
 918                 // Compile the loaded code in five steps:
 919                 //
 920                 // 1. Backup current template data
 921                 $backup = $this->getRawTemplateData();
 922
 923                 // 2. Set the current template's raw data as the new content
 924                 $this->setRawTemplateData($code);
 925
 926                 // 3. Compile the template data
 927                 $this->compileTemplate();
 928
 929                 // 4. Remember it's contents
 930                 $this->loadedRawData[$template] = $this->getRawTemplateData();
 931
 932                 // 5. Restore the previous raw content from backup variable
 933                 $this->setRawTemplateData($backup);
 934         }
 935
 936         /**
 937          * Insert all given and loaded templates by running through all loaded
 938          * codes and searching for their place-holder in the main template
 939          *
 940          * @param       $templateMatches        See method analyzeTemplate()
 941          * @return      void
 942          */
 943         private function insertAllTemplates (array $templateMatches) {
 944                 // Run through all loaded codes
 945                 foreach ($this->loadedRawData as $template => $code) {
 946
 947                         // Search for the template
 948                         $foundIndex = array_search($template, $templateMatches[1]);
 949
 950                         // Lookup the matching template replacement
 951                         if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
 952
 953                                 // Get the current raw template
 954                                 $rawData = $this->getRawTemplateData();
 955
 956                                 // Replace the space holder with the template code
 957                                 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
 958
 959                                 // Set the new raw data
 960                                 $this->setRawTemplateData($rawData);
 961                         } // END - if
 962                 } // END - foreach
 963         }
 964
 965         /**
 966          * Load all extra raw templates
 967          *
 968          * @return      void
 969          */
 970         private function loadExtraRawTemplates () {
 971                 // Are there some raw templates we need to load?
 972                 if (count($this->rawTemplates) > 0) {
 973                         // Try to load all raw templates
 974                         foreach ($this->rawTemplates as $key => $template) {
 975                                 try {
 976                                         // Load the template
 977                                         $this->loadWebTemplate($template);
 978
 979                                         // Remember it's contents
 980                                         $this->rawTemplates[$template] = $this->getRawTemplateData();
 981
 982                                         // Remove it from the loader list
 983                                         unset($this->rawTemplates[$key]);
 984
 985                                         // Remember this template for recursion detection
 986                                         // RECURSIVE PROTECTION!
 987                                         $this->loadedTemplates[] = $template;
 988                                 } catch (FileIoException $e) {
 989                                         // This template was never found. We silently ignore it
 990                                         unset($this->rawTemplates[$key]);
 991                                 }
 992                         } // END - foreach
 993                 } // END - if
 994         }
 995
 996         /**
 997          * Assign all found template variables
 998          *
 999          * @param       $varMatches             An array full of variable/value pairs.
1000          * @return      void
1001          * @todo        Unfinished work or don't die here.
1002          */
1003         private function assignAllVariables (array $varMatches) {
1004                 // Debug message
1005                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches));
1006
1007                 // Search for all variables
1008                 foreach ($varMatches[1] as $key => $var) {
1009                         // Replace all dashes to underscores to match variables with configuration entries
1010                         $var = trim($this->convertDashesToUnderscores($var));
1011
1012                         // Debug message
1013                         $this->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var);
1014
1015                         // Detect leading equals
1016                         if (substr($varMatches[2][$key], 0, 1) == '=') {
1017                                 // Remove and cast it
1018                                 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
1019                         } // END - if
1020
1021                         // Do we have some quotes left and right side? Then it is free text
1022                         if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) {
1023                                 // Free string detected! Which we can assign directly
1024                                 $this->assignVariable($var, $varMatches[3][$key]);
1025                         } elseif (!empty($varMatches[2][$key])) {
1026                                 // @TODO Non-string found so we need some deeper analysis...
1027                                 ApplicationEntryPoint::app_die('Deeper analysis not yet implemented!');
1028                         }
1029                 } // END - foreach
1030         }
1031
1032         /**
1033          * Compiles all loaded raw templates
1034          *
1035          * @param       $templateMatches        See method analyzeTemplate() for details
1036          * @return      void
1037          */
1038         private function compileRawTemplateData (array $templateMatches) {
1039                 // Debug message
1040                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData));
1041
1042                 // Are some code-templates found which we need to compile?
1043                 if (count($this->loadedRawData) > 0) {
1044                         // Then compile all!
1045                         foreach ($this->loadedRawData as $template => $code) {
1046                                 // Debug message
1047                                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code);
1048
1049                                 // Is this template already compiled?
1050                                 if (in_array($template, $this->compiledTemplates)) {
1051                                         // Then skip it
1052                                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!');
1053                                         continue;
1054                                 } // END - if
1055
1056                                 // Search for the template
1057                                 $foundIndex = array_search($template, $templateMatches[1]);
1058
1059                                 // Lookup the matching variable data
1060                                 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
1061                                         // Split it up with another reg. exp. into variable=value pairs
1062                                         preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
1063                                         ///* DEBUG: */ $this->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches,true));
1064
1065                                         // Assign all variables
1066                                         $this->assignAllVariables($varMatches);
1067                                 } // END - if (isset($templateMatches ...
1068
1069                                 // Compile the loaded template
1070                                 $this->compileCode($code, $template);
1071                         } // END - foreach ($this->loadedRawData ...
1072
1073                         // Insert all templates
1074                         $this->insertAllTemplates($templateMatches);
1075                 } // END - if (count($this->loadedRawData) ...
1076         }
1077
1078         /**
1079          * Inserts all raw templates into their respective variables
1080          *
1081          * @return      void
1082          */
1083         private function insertRawTemplates () {
1084                 // Load all templates
1085                 foreach ($this->rawTemplates as $template => $content) {
1086                         // Set the template as a variable with the content
1087                         $this->assignVariable($template, $content);
1088                 }
1089         }
1090
1091         /**
1092          * Finalizes the compilation of all template variables
1093          *
1094          * @return      void
1095          */
1096         private function finalizeVariableCompilation () {
1097                 // Get the content
1098                 $content = $this->getRawTemplateData();
1099                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')');
1100
1101                 // Do we have the stack?
1102                 if (!$this->isVarStackSet('general')) {
1103                         // Abort here silently
1104                         // @TODO This silent abort should be logged, maybe.
1105                         return;
1106                 } // END - if
1107
1108                 // Walk through all variables
1109                 foreach ($this->getVarStack('general') as $currEntry) {
1110                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
1111                         // Replace all [$var] or {?$var?} with the content
1112                         // @TODO Old behaviour, will become obsolete!
1113                         $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1114
1115                         // @TODO Yet another old way
1116                         $content = str_replace('[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1117
1118                         // The new behaviour
1119                         $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
1120                 } // END - for
1121
1122                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
1123
1124                 // Set the content back
1125                 $this->setRawTemplateData($content);
1126         }
1127
1128         /**
1129          * Load a specified web template into the engine
1130          *
1131          * @param       $template       The web template we shall load which is located in
1132          *                                              'html' by default
1133          * @return      void
1134          */
1135         public function loadWebTemplate ($template) {
1136                 // Set template type
1137                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
1138
1139                 // Load the special template
1140                 $this->loadTemplate($template);
1141         }
1142
1143         /**
1144          * Assign a given congfiguration variable with a value
1145          *
1146          * @param       $var    The configuration variable we want to assign
1147          * @return      void
1148          */
1149         public function assignConfigVariable ($var) {
1150                 // Replace all dashes to underscores to match variables with configuration entries
1151                 $var = trim($this->convertDashesToUnderscores($var));
1152
1153                 // Sweet and simple...
1154                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': var=' . $var . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($var));
1155                 $this->setVariable('config', $var, $this->getConfigInstance()->getConfigEntry($var));
1156         }
1157
1158         /**
1159          * Load a specified code template into the engine
1160          *
1161          * @param       $template       The code template we shall load which is
1162          *                                              located in 'code' by default
1163          * @return      void
1164          */
1165         public function loadCodeTemplate ($template) {
1166                 // Set template type
1167                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_template_type'));
1168
1169                 // Load the special template
1170                 $this->loadTemplate($template);
1171         }
1172
1173         /**
1174          * Compiles configuration place-holders in all variables. This 'walks'
1175          * through the variable stack 'general'. It interprets all values from that
1176          * variables as configuration entries after compiling them.
1177          *
1178          * @return      void
1179          */
1180         public final function compileConfigInVariables () {
1181                 // Do we have the stack?
1182                 if (!$this->isVarStackSet('general')) {
1183                         // Abort here silently
1184                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
1185                         return;
1186                 } // END - if
1187
1188                 // Iterate through all general variables
1189                 foreach ($this->getVarStack('general') as $index => $currVariable) {
1190                         // Compile the value
1191                         $value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
1192
1193                         // Debug message
1194                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value);
1195
1196                         // Remove it from stack
1197                         $this->removeVariable($index, 'general');
1198
1199                         // Re-assign the variable
1200                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
1201                         $this->assignConfigVariable($value);
1202                 } // END - foreach
1203         }
1204
1205         /**
1206          * Compile all variables by inserting their respective values
1207          *
1208          * @return      void
1209          * @todo        Make this code some nicer...
1210          */
1211         public final function compileVariables () {
1212                 // Initialize the $content array
1213                 $validVar = $this->getConfigInstance()->getConfigEntry('tpl_valid_var');
1214                 $dummy = array();
1215
1216                 // Iterate through all general variables
1217                 foreach ($this->getVarStack('general') as $currVariable) {
1218                         // Transfer it's name/value combination to the $content array
1219                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
1220                         $dummy[$currVariable['name']] = $currVariable['value'];
1221                 }// END - if
1222
1223                 // Set the new variable (don't remove the second dollar!)
1224                 $$validVar = $dummy;
1225
1226                 // Remove some variables
1227                 unset($index);
1228                 unset($currVariable);
1229
1230                 // Run the compilation three times to get content from helper classes in
1231                 $cnt = 0;
1232                 while ($cnt < 3) {
1233                         // Finalize the compilation of template variables
1234                         $this->finalizeVariableCompilation();
1235
1236                         // Prepare the eval() command for comiling the template
1237                         $eval = sprintf("\$result = \"%s\";",
1238                                 addslashes($this->getRawTemplateData())
1239                         );
1240
1241                         // This loop does remove the backslashes (\) in PHP parameters
1242                         while (strpos($eval, $this->codeBegin) !== false) {
1243                                 // Get left part before "<?"
1244                                 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1245
1246                                 // Get all from right of "<?"
1247                                 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1248
1249                                 // Cut middle part out and remove escapes
1250                                 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1251                                 $evalMiddle = stripslashes($evalMiddle);
1252
1253                                 // Remove the middle part from right one
1254                                 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1255
1256                                 // And put all together
1257                                 $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
1258                         } // END - while
1259
1260                         // Prepare PHP code for eval() command
1261                         $eval = str_replace(
1262                                 "<%php", "\";",
1263                                 str_replace(
1264                                         "%>",
1265                                         "\n\$result .= \"",
1266                                         $eval
1267                                 )
1268                         );
1269
1270                         // Run the constructed command. This will "compile" all variables in
1271                         eval($eval);
1272
1273                         // Goes something wrong?
1274                         if ((!isset($result)) || (empty($result))) {
1275                                 // Output eval command
1276                                 $this->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, true)), true);
1277
1278                                 // Output backtrace here
1279                                 $this->debugBackTrace();
1280                         } // END - if
1281
1282                         // Set raw template data
1283                         $this->setRawTemplateData($result);
1284                         $cnt++;
1285                 } // END - while
1286
1287                 // Final variable assignment
1288                 $this->finalizeVariableCompilation();
1289
1290                 // Set the new content
1291                 $this->setCompiledData($this->getRawTemplateData());
1292         }
1293
1294         /**
1295          * Compile all required templates into the current loaded one
1296          *
1297          * @return      void
1298          * @throws      UnexpectedTemplateTypeException If the template type is
1299          *                                                                                      not "code"
1300          * @throws      InvalidArrayCountException              If an unexpected array
1301          *                                                                                      count has been found
1302          */
1303         public function compileTemplate () {
1304                 // Get code type to make things shorter
1305                 $codeType = $this->getConfigInstance()->getConfigEntry('code_template_type');
1306
1307                 // We will only work with template type "code" from configuration
1308                 if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
1309                         // Abort here
1310                         throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1311                 } // END - if
1312
1313                 // Get the raw data.
1314                 $rawData = $this->getRawTemplateData();
1315
1316                 // Remove double spaces and trim leading/trailing spaces
1317                 $rawData = trim(str_replace('  ', ' ', $rawData));
1318
1319                 // Search for raw variables
1320                 $this->extractVariablesFromRawData($rawData);
1321
1322                 // Search for code-tags which are {? ?}
1323                 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1324
1325                 // Debug message
1326                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , true));
1327
1328                 // Analyze the matches array
1329                 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1330                         // Entries are found:
1331                         //
1332                         // The main analysis
1333                         $this->analyzeTemplate($templateMatches);
1334
1335                         // Compile raw template data
1336                         $this->compileRawTemplateData($templateMatches);
1337
1338                         // Are there some raw templates left for loading?
1339                         $this->loadExtraRawTemplates();
1340
1341                         // Are some raw templates found and loaded?
1342                         if (count($this->rawTemplates) > 0) {
1343                                 // Insert all raw templates
1344                                 $this->insertRawTemplates();
1345
1346                                 // Remove the raw template content as well
1347                                 $this->setRawTemplateData('');
1348                         } // END - if
1349                 } // END - if($templateMatches ...
1350         }
1351
1352         /**
1353          * Loads a given view helper (by name)
1354          *
1355          * @param       $helperName             The helper's name
1356          * @return      void
1357          */
1358         protected function loadViewHelper ($helperName) {
1359                 // Make first character upper case, rest low
1360                 $helperName = $this->convertToClassName($helperName);
1361
1362                 // Is this view helper loaded?
1363                 if (!isset($this->helpers[$helperName])) {
1364                         // Create a class name
1365                         $className = $helperName . 'ViewHelper';
1366
1367                         // Generate new instance
1368                         $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1369                 } // END - if
1370
1371                 // Return the requested instance
1372                 return $this->helpers[$helperName];
1373         }
1374
1375         /**
1376          * Assigns the last loaded raw template content with a given variable
1377          *
1378          * @param       $templateName   Name of the template we want to assign
1379          * @param       $variableName   Name of the variable we want to assign
1380          * @return      void
1381          */
1382         public function assignTemplateWithVariable ($templateName, $variableName) {
1383                 // Get the content from last loaded raw template
1384                 $content = $this->getRawTemplateData();
1385
1386                 // Assign the variable
1387                 $this->assignVariable($variableName, $content);
1388
1389                 // Purge raw content
1390                 $this->setRawTemplateData('');
1391         }
1392
1393         /**
1394          * Transfers the content of this template engine to a given response instance
1395          *
1396          * @param       $responseInstance       An instance of a response class
1397          * @return      void
1398          */
1399         public function transferToResponse (Responseable $responseInstance) {
1400                 // Get the content and set it in response class
1401                 $responseInstance->writeToBody($this->getCompiledData());
1402         }
1403
1404         /**
1405          * Assigns all the application data with template variables
1406          *
1407          * @param       $applicationInstance    A manageable application instance
1408          * @return      void
1409          */
1410         public function assignApplicationData (ManageableApplication $applicationInstance) {
1411                 // Get long name and assign it
1412                 $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
1413
1414                 // Get short name and assign it
1415                 $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
1416
1417                 // Get version number and assign it
1418                 $this->assignVariable('app_version'   , $applicationInstance->getAppVersion());
1419
1420                 // Assign extra application-depending data
1421                 $applicationInstance->assignExtraTemplateData($this);
1422         }
1423
1424         /**
1425          * "Compiles" a variable by replacing {?var?} with it's content
1426          *
1427          * @param       $rawCode                        Raw code to compile
1428          * @param       $setMatchAsCode         Sets $match if readVariable() returns empty result
1429          * @return      $rawCode        Compile code with inserted variable value
1430          */
1431         public function compileRawCode ($rawCode, $setMatchAsCode=false) {
1432                 // Find the variables
1433                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1434                 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1435
1436                 // Compile all variables
1437                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':<pre>' . print_r($varMatches, true) . '</pre>');
1438                 foreach ($varMatches[0] as $match) {
1439                         // Add variable tags around it
1440                         $varCode = '{?' . $match . '?}';
1441
1442                         // Debug message
1443                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ':varCode=' . $varCode);
1444
1445                         // Is the variable found in code? (safes some calls)
1446                         if (strpos($rawCode, $varCode) !== false) {
1447                                 // Debug message
1448                                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': match=' . $match . ',value[' . gettype($value) . ']=' . $value);
1449
1450                                 // Use $match as new value or $value from read variable?
1451                                 if ($setMatchAsCode === true) {
1452                                         // Insert match
1453                                         $rawCode = str_replace($varCode, $match, $rawCode);
1454                                 } else {
1455                                         // Read the variable
1456                                         $value = $this->readVariable($match);
1457
1458                                         // Insert value
1459                                         $rawCode = str_replace($varCode, $value, $rawCode);
1460                                 }
1461                         } // END - if
1462                 } // END - foreach
1463
1464                 // Return the compiled data
1465                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1466                 return $rawCode;
1467         }
1468
1469         /**
1470          * Getter for variable group array
1471          *
1472          * @return      $vargroups      All variable groups
1473          */
1474         public final function getVariableGroups () {
1475                 return $this->varGroups;
1476         }
1477
1478         /**
1479          * Renames a variable in code and in stack
1480          *
1481          * @param       $oldName        Old name of variable
1482          * @param       $newName        New name of variable
1483          * @return      void
1484          */
1485         public function renameVariable ($oldName, $newName) {
1486                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
1487                 // Get raw template code
1488                 $rawData = $this->getRawTemplateData();
1489
1490                 // Replace it
1491                 $rawData = str_replace($oldName, $newName, $rawData);
1492
1493                 // Set the code back
1494                 $this->setRawTemplateData($rawData);
1495         }
1496
1497         /**
1498          * Renders the given XML content
1499          *
1500          * @param       $content        Valid XML content or if not set the current loaded raw content
1501          * @return      void
1502          * @throws      XmlParserException      If an XML error was found
1503          */
1504         public function renderXmlContent ($content = NULL) {
1505                 // Is the content set?
1506                 if (is_null($content)) {
1507                         // Get current content
1508                         $content = $this->getRawTemplateData();
1509                 } // END - if
1510
1511                 // Get a XmlParser instance
1512                 $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
1513
1514                 // Check if we have XML compacting enabled
1515                 if ($this->isXmlCompactingEnabled()) {
1516                         // Yes, so get a decorator class for transparent compacting
1517                         $parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
1518                 } // END - if
1519
1520                 // Parse the XML document
1521                 $parserInstance->parseXmlContent($content);
1522         }
1523
1524         /**
1525          * Enables or disables language support
1526          *
1527          * @param       $languageSupport        New language support setting
1528          * @return      void
1529          */
1530         public final function enableLanguageSupport ($languageSupport = true) {
1531                 $this->languageSupport = (bool) $languageSupport;
1532         }
1533
1534         /**
1535          * Checks whether language support is enabled
1536          *
1537          * @return      $languageSupport        Whether language support is enabled or disabled
1538          */
1539         public final function isLanguageSupportEnabled () {
1540                 return $this->languageSupport;
1541         }
1542
1543         /**
1544          * Enables or disables XML compacting
1545          *
1546          * @param       $xmlCompacting  New XML compacting setting
1547          * @return      void
1548          */
1549         public final function enableXmlCompacting ($xmlCompacting = true) {
1550                 $this->xmlCompacting = (bool) $xmlCompacting;
1551         }
1552
1553         /**
1554          * Checks whether XML compacting is enabled
1555          *
1556          * @return      $xmlCompacting  Whether XML compacting is enabled or disabled
1557          */
1558         public final function isXmlCompactingEnabled () {
1559                 return $this->xmlCompacting;
1560         }
1561
1562         /**
1563          * Removes all commentd, tabs and new-line characters to compact the content
1564          *
1565          * @param       $uncompactedContent             The uncompacted content
1566          * @return      $compactedContent               The compacted content
1567          */
1568         public function compactContent ($uncompactedContent) {
1569                 // First, remove all tab/new-line/revert characters
1570                 $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
1571
1572                 // Then regex all comments like <!-- //--> away
1573                 preg_match_all('/<!--[\w\W]*?(\/\/){0,1}-->/', $compactedContent, $matches);
1574
1575                 // Do we have entries?
1576                 if (isset($matches[0][0])) {
1577                         // Remove all
1578                         foreach ($matches[0] as $match) {
1579                                 // Remove the match
1580                                 $compactedContent = str_replace($match, '', $compactedContent);
1581                         } // END - foreach
1582                 } // END - if
1583
1584                 // Set the content again
1585                 $this->setRawTemplateData($compactedContent);
1586
1587                 // Return compacted content
1588                 return $compactedContent;
1589         }
1590 }
1591
1592 // [EOF]
1593 ?>