inc/classes/main/template/web/class_WebTemplateEngine.php

   1 <?php
   2 /**
   3  * The own template engine for loading caching and sending out the web pages
   4  * and emails.
   5  *
   6  * @author              Roland Haeder <webmaster@ship-simu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.ship-simu.org
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class WebTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
  26         /**
  27          * Protected constructor
  28          *
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34         }
  35
  36         /**
  37          * Creates an instance of the class TemplateEngine and prepares it for usage
  38          *
  39          * @param       $appInstance    A manageable application
  40          * @return      $templateInstance       An instance of TemplateEngine
  41          * @throws      BasePathIsEmptyException                If the provided $templateBasePath is empty
  42          * @throws      InvalidBasePathStringException  If $templateBasePath is no string
  43          * @throws      BasePathIsNoDirectoryException  If $templateBasePath is no
  44          *                                                                                      directory or not found
  45          * @throws      BasePathReadProtectedException  If $templateBasePath is
  46          *                                                                                      read-protected
  47          */
  48         public final static function createWebTemplateEngine (ManageableApplication $appInstance) {
  49                 // Get a new instance
  50                 $templateInstance = new WebTemplateEngine();
  51
  52                 // Get language and file I/O instances from application
  53                 $langInstance = $appInstance->getLanguageInstance();
  54                 $ioInstance = $appInstance->getFileIoInstance();
  55
  56                 // Determine base path
  57                 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/';
  58
  59                 // Is the base path valid?
  60                 if (empty($templateBasePath)) {
  61                         // Base path is empty
  62                         throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  63                 } elseif (!is_string($templateBasePath)) {
  64                         // Is not a string
  65                         throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
  66                 } elseif (!is_dir($templateBasePath)) {
  67                         // Is not a path
  68                         throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
  69                 } elseif (!is_readable($templateBasePath)) {
  70                         // Is not readable
  71                         throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
  72                 }
  73
  74                 // Set the base path
  75                 $templateInstance->setTemplateBasePath($templateBasePath);
  76
  77                 // Set the language and IO instances
  78                 $templateInstance->setLanguageInstance($langInstance);
  79                 $templateInstance->setFileIoInstance($ioInstance);
  80
  81                 // Set template extensions
  82                 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
  83                 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('code_template_extension'));
  84
  85                 // Absolute output path for compiled templates
  86                 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
  87
  88                 // Return the prepared instance
  89                 return $templateInstance;
  90         }
  91 }
  92
  93 // [EOF]
  94 ?>