0a9bc8dc5f022fb22006b3c476f9c1d04efd54c7
[core.git] / inc / classes / main / template / console / class_ConsoleTemplateEngine.php
1 <?php
2 /**
3  * A Console template engine class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  * @todo                This template engine does not make use of setTemplateType()
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 ConsoleTemplateEngine 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       $applicationInstance    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 static final function createConsoleTemplateEngine (ManageableApplication $applicationInstance) {
49                 // Get a new instance
50                 $templateInstance = new ConsoleTemplateEngine();
51
52                 // Determine base path
53                 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
54
55                 // Is the base path valid?
56                 if (empty($templateBasePath)) {
57                         // Base path is empty
58                         throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
59                 } elseif (!is_string($templateBasePath)) {
60                         // Is not a string
61                         throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
62                 } elseif (!is_dir($templateBasePath)) {
63                         // Is not a path
64                         throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
65                 } elseif (!is_readable($templateBasePath)) {
66                         // Is not readable
67                         throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
68                 }
69
70                 // Set the base path
71                 $templateInstance->setTemplateBasePath($templateBasePath);
72
73                 // Set template extensions
74                 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
75                 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('code_template_extension'));
76
77                 // Absolute output path for compiled templates
78                 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
79
80                 // Return the prepared instance
81                 return $templateInstance;
82         }
83 }
84
85 // [EOF]
86 ?>