framework/main/classes/template/class_

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