3 * A ??? template engine class
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class ???TemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of the class TemplateEngine and prepares it for usage
38 * @param $applicationInstance A manageable application
39 * @return $templateInstance An instance of TemplateEngine
40 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
41 * @throws InvalidBasePathStringException If $templateBasePath is no string
42 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
43 * directory or not found
44 * @throws BasePathReadProtectedException If $templateBasePath is
47 public final static function create???TemplateEngine (ManageableApplication $applicationInstance) {
49 $templateInstance = new ???TemplateEngine();
51 // Determine base path
52 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
54 // Is the base path valid?
55 if (empty($templateBasePath)) {
57 throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
58 } elseif (!is_string($templateBasePath)) {
60 throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
61 } elseif (!is_dir($templateBasePath)) {
63 throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
64 } elseif (!is_readable($templateBasePath)) {
66 throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
70 $templateInstance->setTemplateBasePath($templateBasePath);
72 // Set template extensions
73 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
74 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('code_template_extension'));
76 // Absolute output path for compiled templates
77 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
79 // Return the prepared instance
80 return $templateInstance;