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