Fake template engine added, variables can now be compiled for config entries:
authorRoland Häder <roland@mxchange.org>
Tue, 5 Jan 2010 05:14:16 +0000 (05:14 +0000)
committerRoland Häder <roland@mxchange.org>
Tue, 5 Jan 2010 05:14:16 +0000 (05:14 +0000)
- New fake template engine ConsoleTemplateEngine added (unfinished)
- New method to compile configuration entries in 'general' variable stack added

.gitattributes
inc/classes/main/template/class_BaseTemplateEngine.php
inc/classes/main/template/console/.htaccess [new file with mode: 0644]
inc/classes/main/template/console/class_ConsoleTemplateEngine.php [new file with mode: 0644]

index 7f6e83f..c45a449 100644 (file)
@@ -490,6 +490,8 @@ inc/classes/main/streams/crypto/class_NullCryptoStream.php -text
 inc/classes/main/template/.htaccess -text
 inc/classes/main/template/class_ -text
 inc/classes/main/template/class_BaseTemplateEngine.php -text
 inc/classes/main/template/.htaccess -text
 inc/classes/main/template/class_ -text
 inc/classes/main/template/class_BaseTemplateEngine.php -text
+inc/classes/main/template/console/.htaccess -text
+inc/classes/main/template/console/class_ConsoleTemplateEngine.php -text
 inc/classes/main/template/image/.htaccess -text
 inc/classes/main/template/image/class_ImageTemplateEngine.php -text
 inc/classes/main/template/mail/.htaccess -text
 inc/classes/main/template/image/.htaccess -text
 inc/classes/main/template/image/class_ImageTemplateEngine.php -text
 inc/classes/main/template/mail/.htaccess -text
index fe332f2..2256fab 100644 (file)
@@ -197,13 +197,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                // Is the variable found?
                if ($found !== false) {
                        // Read it
                // Is the variable found?
                if ($found !== false) {
                        // Read it
-                       $found = $this->varStack[$this->currGroup][$found]['value'];
+                       $content = $this->varStack[$this->currGroup][$found]['value'];
                } // END - if
 
                } // END - if
 
-               //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.",var=".$var.", found=".$found."<br />\n";
-
                // Return the current position
                // Return the current position
-               return $found;
+               //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.",var=".$var.", content[".gettype($content)."]=".$content."<br />\n";
+               return $content;
        }
 
        /**
        }
 
        /**
@@ -475,7 +474,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                if ($idx !== false) {
                        // Remove this variable
                        $this->varStack->offsetUnset($idx);
                if ($idx !== false) {
                        // Remove this variable
                        $this->varStack->offsetUnset($idx);
-               }
+               } // END - if
        }
 
        /**
        }
 
        /**
@@ -988,6 +987,27 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                $this->loadTemplate($template);
        }
 
                $this->loadTemplate($template);
        }
 
+       /**
+        * Compiles configuration place-holders in all variables. This 'walks'
+        * through the variable stack 'general'. It interprets all values from that
+        * variables as configuration entries after compiling them.
+        *
+        * @return      void
+        */
+       public final function compileConfigInVariables () {
+               // Iterate through all general variables
+               foreach ($this->varStack['general'] as $idx=>$currVariable) {
+                       // Compile the value
+                       $value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
+
+                       // Remove it from stack
+                       unset($this->varStack['general'][$idx]);
+
+                       // Re-assign the variable
+                       $this->assignConfigVariable($value);
+               } // END - foreach
+       }
+
        /**
         * Compile all variables by inserting their respective values
         *
        /**
         * Compile all variables by inserting their respective values
         *
@@ -1242,16 +1262,17 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        /**
         * "Compiles" a variable by replacing {?var?} with it's content
         *
        /**
         * "Compiles" a variable by replacing {?var?} with it's content
         *
-        * @param       $rawCode        Raw code to compile
+        * @param       $rawCode                        Raw code to compile
+        * @param       $setMatchAsCode         Sets $match if readVariable() returns empty result
         * @return      $rawCode        Compile code with inserted variable value
         */
         * @return      $rawCode        Compile code with inserted variable value
         */
-       public function compileRawCode ($rawCode) {
+       public function compileRawCode ($rawCode, $setMatchAsCode=false) {
                // Find the variables
                // Find the variables
-               //* DEBUG: */ echo "rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
+               //* DEBUG: */ echo __METHOD__.":rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
                preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
 
                // Compile all variables
                preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
 
                // Compile all variables
-               //* DEBUG: */ echo "<pre>".print_r($varMatches, true)."</pre>";
+               //* DEBUG: */ echo __METHOD__.":<pre>".print_r($varMatches, true)."</pre>\n";
                foreach ($varMatches[0] as $match) {
                        // Add variable tags around it
                        $varCode = '{?' . $match . '?}';
                foreach ($varMatches[0] as $match) {
                        // Add variable tags around it
                        $varCode = '{?' . $match . '?}';
@@ -1259,12 +1280,20 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                        // Is the variable found in code? (safes some calls)
                        if (strpos($rawCode, $varCode) !== false) {
                                // Replace the variable with it's value, if found
                        // Is the variable found in code? (safes some calls)
                        if (strpos($rawCode, $varCode) !== false) {
                                // Replace the variable with it's value, if found
-                               //* DEBUG: */ echo __METHOD__.": match=".$match."<br />\n";
-                               $rawCode = str_replace($varCode, $this->readVariable($match), $rawCode);
+                               $value = $this->readVariable($match);
+                               //* DEBUG: */ echo __METHOD__.": match=".$match.",value[".gettype($value)."]=".$value."<br />\n";
+                               if (($setMatchAsCode === true) && (is_null($value))) {
+                                       // Insert match
+                                       $rawCode = str_replace($varCode, $match, $rawCode);
+                               } else {
+                                       // Insert value
+                                       $rawCode = str_replace($varCode, $value, $rawCode);
+                               }
                        } // END - if
                } // END - foreach
 
                // Return the compiled data
                        } // END - if
                } // END - foreach
 
                // Return the compiled data
+               //* DEBUG: */ echo __METHOD__.":rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
                return $rawCode;
        }
 
                return $rawCode;
        }
 
diff --git a/inc/classes/main/template/console/.htaccess b/inc/classes/main/template/console/.htaccess
new file mode 100644 (file)
index 0000000..3a42882
--- /dev/null
@@ -0,0 +1 @@
+Deny from all
diff --git a/inc/classes/main/template/console/class_ConsoleTemplateEngine.php b/inc/classes/main/template/console/class_ConsoleTemplateEngine.php
new file mode 100644 (file)
index 0000000..ce4230f
--- /dev/null
@@ -0,0 +1,96 @@
+<?php
+/**
+ * A Console template engine class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class ConsoleTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+       }
+
+       /**
+        * Creates an instance of the class TemplateEngine and prepares it for usage
+        *
+        * @param       $appInstance    A manageable application
+        * @return      $tplInstance    An instance of TemplateEngine
+        * @throws      BasePathIsEmptyException                If the provided $templateBasePath is empty
+        * @throws      InvalidBasePathStringException  If $templateBasePath is no string
+        * @throws      BasePathIsNoDirectoryException  If $templateBasePath is no
+        *                                                                                      directory or not found
+        * @throws      BasePathReadProtectedException  If $templateBasePath is
+        *                                                                                      read-protected
+        */
+       public final static function createConsoleTemplateEngine (ManageableApplication $appInstance) {
+               // Get a new instance
+               $tplInstance = new ConsoleTemplateEngine();
+
+               // Get language and file I/O instances from application
+               $langInstance = $appInstance->getLanguageInstance();
+               $ioInstance = $appInstance->getFileIoInstance();
+
+               // Determine base path
+               $templateBasePath = $tplInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/';
+
+               // Is the base path valid?
+               if (empty($templateBasePath)) {
+                       // Base path is empty
+                       throw new BasePathIsEmptyException($tplInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
+               } elseif (!is_string($templateBasePath)) {
+                       // Is not a string
+                       throw new InvalidBasePathStringException(array($tplInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
+               } elseif (!is_dir($templateBasePath)) {
+                       // Is not a path
+                       throw new BasePathIsNoDirectoryException(array($tplInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
+               } elseif (!is_readable($templateBasePath)) {
+                       // Is not readable
+                       throw new BasePathReadProtectedException(array($tplInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
+               }
+
+               // Get configuration instance
+               $configInstance = FrameworkConfiguration::getInstance();
+
+               // Set the base path
+               $tplInstance->setTemplateBasePath($templateBasePath);
+
+               // Set the language and IO instances
+               $tplInstance->setLanguageInstance($langInstance);
+               $tplInstance->setFileIoInstance($ioInstance);
+
+               // Set template extensions
+               $tplInstance->setRawTemplateExtension($configInstance->getConfigEntry('raw_template_extension'));
+               $tplInstance->setCodeTemplateExtension($configInstance->getConfigEntry('code_template_extension'));
+
+               // Absolute output path for compiled templates
+               $tplInstance->setCompileOutputPath($configInstance->getConfigEntry('base_path') . $configInstance->getConfigEntry('compile_output_path'));
+
+               // Return the prepared instance
+               return $tplInstance;
+       }
+}
+
+// [EOF]
+?>