]> git.mxchange.org Git - core.git/blob - framework/main/classes/application/class_BaseApplication.php
Continued:
[core.git] / framework / main / classes / application / class_BaseApplication.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Application;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Controller\Controller;
7 use Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper;
8 use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
9 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
10
11 /**
12  * A general application class for the ApplicationHelper classes.
13  *
14  * @author              Roland Haeder <webmaster@shipsimu.org>
15  * @version             0.0.0
16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
17  * @license             GNU GPL 3.0 or any newer version
18  * @link                http://www.shipsimu.org
19  *
20  * This program is free software: you can redistribute it and/or modify
21  * it under the terms of the GNU General Public License as published by
22  * the Free Software Foundation, either version 3 of the License, or
23  * (at your option) any later version.
24  *
25  * This program is distributed in the hope that it will be useful,
26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
28  * GNU General Public License for more details.
29  *
30  * You should have received a copy of the GNU General Public License
31  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
32  */
33 abstract class BaseApplication extends BaseFrameworkSystem {
34         /**
35          * The version number of this application
36          */
37         private $appVersion = '';
38
39         /**
40          * The human-readable name for this application
41          */
42         private $appName = '';
43
44         /**
45          * The short uni*-like name for this application
46          */
47         private $shortName = '';
48
49         /**
50          * Own singleton instance of this application helper
51          */
52         private static $applicationInstance = NULL;
53
54         /**
55          * A controller instance
56          */
57         private $controllerInstance = NULL;
58
59         /**
60          * Protected constructor
61          *
62          * @param       $className      Name of the class
63          * @return      void
64          */
65         protected function __construct (string $className) {
66                 // Call parent constructor
67                 parent::__construct($className);
68         }
69
70         /**
71          * Getter for own instance
72          *
73          * @return      $applicationInstance    An instance of a ManageableApplication class
74          */
75         public static final function getApplicationInstance () {
76                 return self::$applicationInstance;
77         }
78
79         /**
80          * Setter for own instance
81          *
82          * @param       $applicationInstance    An instance of a ManageableApplication class
83          */
84         public static final function setApplicationInstance (ManageableApplication $applicationInstance) {
85                 self::$applicationInstance = $applicationInstance;
86         }
87
88         /**
89          * Setter for controller instance (this surely breaks a bit the MVC patterm)
90          *
91          * @param       $controllerInstance             An instance of the controller
92          * @return      void
93          */
94         public final function setControllerInstance (Controller $controllerInstance) {
95                 $this->controllerInstance = $controllerInstance;
96         }
97
98         /**
99          * Getter for controller instance (this surely breaks a bit the MVC patterm)
100          *
101          * @return      $controllerInstance             An instance of the controller
102          */
103         public final function getControllerInstance () {
104                 return $this->controllerInstance;
105         }
106
107         /**
108          * Getter for the version number
109          *
110          * @return      $appVersion     The application's version number
111          */
112         public final function getAppVersion () {
113                 return $this->appVersion;
114         }
115
116         /**
117          * Setter for the version number
118          *
119          * @param       $appVersion     The application's version number
120          * @return      void
121          */
122         public final function setAppVersion (string $appVersion) {
123                 // Cast and set it
124                 $this->appVersion = $appVersion;
125         }
126
127         /**
128          * Getter for human-readable name
129          *
130          * @return      $appName        The application's human-readable name
131          */
132         public final function getAppName () {
133                 return $this->appName;
134         }
135
136         /**
137          * Setter for human-readable name
138          *
139          * @param       $appName        The application's human-readable name
140          * @return      void
141          */
142         public final function setAppName (string $appName) {
143                 // Cast and set it
144                 $this->appName = $appName;;
145         }
146
147         /**
148          * Getter for short uni*-like name
149          *
150          * @return      $shortName      The application's short uni*-like name
151          */
152         public final function getAppShortName () {
153                 return $this->shortName;
154         }
155
156         /**
157          * Setter for short uni*-like name
158          *
159          * @param       $shortName      The application's short uni*-like name
160          * @return      void
161          */
162         public final function setAppShortName (string $shortName) {
163                 // Cast and set it
164                 $this->shortName = $shortName;
165         }
166
167 }