]> git.mxchange.org Git - shipsimu.git/commitdiff
header comments added
authorRoland Häder <roland@mxchange.org>
Sun, 24 Feb 2008 10:17:21 +0000 (10:17 +0000)
committerRoland Häder <roland@mxchange.org>
Sun, 24 Feb 2008 10:17:21 +0000 (10:17 +0000)
41 files changed:
.gitattributes
ship-simu/inc/classes/interfaces/compressor/.htaccess [new file with mode: 0644]
ship-simu/inc/classes/interfaces/compressor/class_Compressor.php
ship-simu/inc/classes/interfaces/database/class_FrameworkDatabaseInterface.php
ship-simu/inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php
ship-simu/inc/classes/interfaces/database/middleware/class_DatabaseConnector.php
ship-simu/inc/classes/interfaces/debug/class_Debugger.php
ship-simu/inc/classes/interfaces/extended/class_LimitableObject.php
ship-simu/inc/classes/interfaces/io/class_Streamable.php
ship-simu/inc/classes/interfaces/io/file/class_FileInputStreamer.php
ship-simu/inc/classes/interfaces/io/file/class_FileOutputStreamer.php
ship-simu/inc/classes/interfaces/io/output/class_OutputStreamer.php
ship-simu/inc/classes/interfaces/language/class_ManageableLanguage.php
ship-simu/inc/classes/interfaces/template/class_CompileableTemplate.php
ship-simu/inc/classes/main/class_BaseFrameworkSystem.php
ship-simu/inc/classes/main/class_FrameworkArrayObject.php
ship-simu/inc/classes/main/compressor/class_Bzip2Compressor.php
ship-simu/inc/classes/main/compressor/class_GzipCompressor.php
ship-simu/inc/classes/main/compressor/class_NullCompressor.php
ship-simu/inc/classes/main/console/class_ConsoleTools.php
ship-simu/inc/classes/main/database/class_BaseDatabaseFrontend.php
ship-simu/inc/classes/main/database/classes/class_LocalFileDatabase.php
ship-simu/inc/classes/main/debug/class_DebugConsoleOutput.php
ship-simu/inc/classes/main/debug/class_DebugErrorLogOutput.php
ship-simu/inc/classes/main/debug/class_DebugWebOutput.php
ship-simu/inc/classes/main/extended/class_ObjectLimits.php
ship-simu/inc/classes/main/extended/class_SerializationContainer.php
ship-simu/inc/classes/main/io/class_FileIOStream.php
ship-simu/inc/classes/main/io/class_FrameworkDirectoryPointer.php
ship-simu/inc/classes/main/io/class_FrameworkFileInputPointer.php
ship-simu/inc/classes/main/io/class_FrameworkFileOutputPointer.php
ship-simu/inc/classes/main/language/class_LanguageSystem.php
ship-simu/inc/classes/main/output/class_ConsoleOutput.php
ship-simu/inc/classes/main/output/class_WebOutput.php
ship-simu/inc/classes/main/template/class_TemplateEngine.php
ship-simu/inc/classes/middleware/class_BaseMiddleware.php
ship-simu/inc/classes/middleware/compressor/class_CompressorChannel.php
ship-simu/inc/classes/middleware/database/class_DatabaseConnection.php
ship-simu/inc/classes/middleware/debug/class_DebugMiddleware.php
ship-simu/inc/classes/middleware/io/class_FileIOHandler.php
ship-simu/inc/language/.htaccess [new file with mode: 0644]

index 32c4a2f5ee6c49875584f32ad15907eff2dcd8f8..3d5165cd984be40b0b6fe7be9b41d497578e6e94 100644 (file)
@@ -180,6 +180,7 @@ ship-simu/inc/classes/interfaces/.htaccess -text
 ship-simu/inc/classes/interfaces/application/.htaccess -text
 ship-simu/inc/classes/interfaces/application/class_ManageableApplication.php -text
 ship-simu/inc/classes/interfaces/class_FrameworkInterface.php -text
+ship-simu/inc/classes/interfaces/compressor/.htaccess -text
 ship-simu/inc/classes/interfaces/compressor/class_Compressor.php -text
 ship-simu/inc/classes/interfaces/database/.htaccess -text
 ship-simu/inc/classes/interfaces/database/class_FrameworkDatabaseInterface.php -text
@@ -253,6 +254,7 @@ ship-simu/inc/database/lib-local.php -text
 ship-simu/inc/file_io.php -text
 ship-simu/inc/includes.php -text
 ship-simu/inc/language.php -text
+ship-simu/inc/language/.htaccess -text
 ship-simu/inc/loader/.htaccess -text
 ship-simu/inc/loader/class_ClassLoader.php -text
 ship-simu/inc/output.php -text
diff --git a/ship-simu/inc/classes/interfaces/compressor/.htaccess b/ship-simu/inc/classes/interfaces/compressor/.htaccess
new file mode 100644 (file)
index 0000000..3a42882
--- /dev/null
@@ -0,0 +1 @@
+Deny from all
index b8d62b0487b4e149f21b0b8087b55ff88f44b433..5f42ec323a8bb0fae142e15001aec77d0a57e95d 100644 (file)
@@ -2,8 +2,23 @@
 /**
  * An interface for compression classes
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface Compressor extends FrameworkInterface {
        /**
index 6550eca55471674c9d20fa2a666ad33c966a53c4..0b0629800c37f728b4eadf39c3fa0816a7a50ead 100644 (file)
@@ -2,8 +2,23 @@
 /**
  * The general interface for all other database interfaces
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface FrameworkDatabaseInterface extends FrameworkInterface {
        /**
index 35c13b58af683bc6640149ab7f434ead969aa4c9..839ba634c1a87abc28420415d0a29d1b5a1857d8 100644 (file)
@@ -6,8 +6,23 @@
  * file databases the object shall be serialized and (maybe) transparently
  * compressed before they got saved to a local file.
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface DatabaseFrontendInterface extends FrameworkDatabaseInterface {
        /**
index 5964420b07b4e9523d1840ea1f6d9620d454059b..0182ef87ff691f7a64fe3b97d58d36c776b160fb 100644 (file)
@@ -2,8 +2,23 @@
 /**
  * An interface for middleware database classes
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface DatabaseConnector extends FrameworkDatabaseInterface {
 }
index 8ba621d3666cbe3eb75fa667c2e3b1857aea8652..46cdeb44a8585709b8f9fd0febaee7f850697b8a 100644 (file)
@@ -2,8 +2,23 @@
 /**
  * An interface for debugger classes
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface Debugger extends FrameworkInterface {
        /**
index f1fa6af03d2c2e394f4114014871b92cf6f2eb2c..8ed5eb955c2f26ec6c0ac6ccd81dde520b5b3157 100644 (file)
@@ -3,8 +3,23 @@
  * This is an inface for limiting object while saving them with the
  * DatabaseConnection class.
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface LimitableObject extends FrameworkInterface {
        /**
index aaa697d2062f9da3848d6f8cd6679f8e2df51a4b..1392564ea798e58c035499ba0d1fbccd907bc2ce 100644 (file)
@@ -1,10 +1,24 @@
 <?php
 /**
  * An interface for streams
- * 
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface Streamable extends FrameworkInterface {
 }
index 891c6581634f47b9f314c221ee0c934f7dec45d1..6204e34c629f68beeec65691fee5e61920fee274 100644 (file)
@@ -1,10 +1,24 @@
 <?php
 /**
  * An interface for file input operations.
- * 
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface FileInputStreamer extends Streamable {
        /**
index 2b866f4fc10b0574e580f0b9c2f92e042e84a76f..55bc37e59b2b362e2ae5dcaaf91f43241c9a4cb1 100644 (file)
@@ -2,8 +2,23 @@
 /**
  * An interface for file output operations.
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface FileOutputStreamer extends Streamable {
        /**
index 542e0b4721bccea3231730ca7a6b716ab4e6617f..6e4431f92ce5fdd1ac6bdec672d2aaac52e356d2 100644 (file)
@@ -1,10 +1,24 @@
 <?php
 /**
  * An interface for output streams
- * 
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface OutputStreamer extends Streamable {
        /**
@@ -14,14 +28,14 @@ interface OutputStreamer extends Streamable {
         * @param               $value  The value to store in the variable
         * @return      void
         */
-       function assignVariable ($var, $value);
+       function assignVariable($var, $value);
 
        /**
         * Output the code
         *
         * @return      void
         */
-       function output ($outStream=false);
+       function output($outStream=false);
 }
 
 //
index 0649c5e8375e00977e2a46dba40f315c5596d694..77f3fbc1fe3ec1c67bbd420b6dc0446d0f5c3e36 100644 (file)
@@ -2,8 +2,23 @@
 /**
  * An interface for language systems
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface ManageableLanguage extends FrameworkInterface {
        /**
index 8df39d83350fe7dcba03c02ed8f116b4fa6747c5..1477f74ba84f0bbcb74ae9ccaa63d98831f87836 100644 (file)
@@ -2,8 +2,23 @@
 /**
  * An interface for template engines
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 interface CompileableTemplate extends FrameworkInterface {
        /**
index 02ff36773466a5b39f635a426bdf8aa4ee86eb7c..3721f6399b07bfb27dfcae42b3f7842298c1d73f 100644 (file)
@@ -2,6 +2,24 @@
 /**
  * The simulator system class is the super class of all other classes. This
  * class handles saving of games etc.
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
@@ -107,7 +125,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        const EXCEPTION_VARIABLE_NOT_SET             = 0x02a;
        const EXCEPTION_ATTRIBUTES_ARE_MISSING       = 0x02b;
        const EXCEPTION_ARRAY_ELEMENTS_MISSING       = 0x02c;
-       const EXCEPTION_NOT_CONSTRUCTABLE                       = 0x02d;
 
        /**
         * In the super constructor these system classes shall be ignored or else
@@ -129,7 +146,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                "GzipCompressor",                       // GZIP compressor
                "WebOutput",                            // Web output sub-system
        );
-       
+
        /**
         * Private super constructor
         *
@@ -180,7 +197,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
                        $this->__toString(),
                        $methodName,
-                       $argsString                     
+                       $argsString
                ));
 
                // Return nothing
@@ -456,7 +473,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        private final function generateIdNumber () {
                return sprintf("%s@%s",
                        $this->__toString(),
-                       md5(sprintf("%s:%s:%s:%s:%s:%s", 
+                       md5(sprintf("%s:%s:%s:%s:%s:%s",
                                $this->__toString(),
                                $this->getPartDescr(),
                                time(),
index 89f6b7e587a95d67f880411cdf6c67b63c97e781..e73f8a8d8c9b68c21c6205ae24680f132b8aedbd 100644 (file)
@@ -3,6 +3,24 @@
  * Class for saving arrays as an object. We need this little extension for
  * some common methods used in the whole application. Please see below if you
  * need more details.
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class FrameworkArrayObject extends ArrayObject {
        /**
index 78c25714cd02a2324c849ca7eb82c8af3c386bd1..56e704c3d69bbd64a7e5d343c0860258c15175a8 100644 (file)
@@ -1,6 +1,24 @@
 <?php
 /**
  * BZIP2 compression and decompression class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class Bzip2Compressor extends BaseFrameworkSystem implements Compressor {
        /**
index d3ed86a9daa660f5ea6e25ea436e2741cff016bc..f00b2d03252ceec0a07d9b7629965a69c185bb87 100644 (file)
@@ -1,6 +1,24 @@
 <?php
 /**
  * GZIP compression and decompression class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class GzipCompressor extends BaseFrameworkSystem implements Compressor {
        /**
index 4762cb86414a11ea6521d63b2360fc61b53ed7b2..b4a1236379201f39ffe079c2ae66bff633a80dd9 100644 (file)
@@ -1,6 +1,24 @@
 <?php
 /**
  * Null compression and decompression class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class NullCompressor extends BaseFrameworkSystem implements Compressor {
        /**
index c57070d2756a806c3a506ed76402c0b82751931e..97f1bc2338cfb2741c3af6e121ccb7281ac66cf4 100644 (file)
@@ -1,6 +1,24 @@
 <?php
 /**
  * This class contains static helper functions for console applications
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class ConsoleTools extends BaseFrameworkSystem {
        /**
index 601c042594a452e3be4789f4425f2c3c6aa54b9b..7d6f8a0dc0934bdbbf59c095ea20e74656d26afe 100644 (file)
@@ -2,8 +2,24 @@
 /**
  * An abstract database access class for handling database I/O requests
  *
- * @see        DatabaseFrontendInterface       An interface for database frontends
- *                                                             (front-end to the application)
+ * @see        DatabaseFrontendInterface       An interface for database frontends (front-end to the application)
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 abstract class BaseDatabaseFrontend extends BaseFrameworkSystem implements DatabaseFrontendInterface, LimitableObject {
        /**
index 5a83742767a118b41b886e3555fc660925a6c4da..ff5f1dde0448456a437cb528aee8e4c3759f5ddd 100644 (file)
@@ -4,8 +4,24 @@
  *
  * This class serializes objects and saves them to local files.
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.1
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontendInterface {
        /**
@@ -311,7 +327,7 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
        /**
         * Getter for the file IO instance
         *
-        * @return      $ioInstance     An instance for IO operations
+        *�@return    $ioInstance     An instance for IO operations
         * @see         FileIOHandler   The concrete handler for IO operations
         */
        public final function getIOInstance () {
@@ -379,7 +395,7 @@ class LocalFileDatabase extends BaseDatabaseFrontend implements DatabaseFrontend
         *                                              serialized data
         * @throws      MismatchingCompressorsException If the compressor from
         *                                                                              the loaded file
-        *                                                                              mismatches with the 
+        *                                                                              mismatches with the
         *                                                                              current used one.
         * @throws      NullPointerException                    If the restored object
         *                                                                              is null
index dd930bc23e65a1a3acf89bfbfef5223f00aa7861..d92648eaf1148db58bf8d5a4f902e2bc436073d7 100644 (file)
@@ -1,8 +1,26 @@
 <?php
 /**
  * A debug output class for the console (e.g. hub software)
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-class DebugConsoleOutput extends BaseFrameworkSystem implements Debugger {
+class DebugConsoleOutput extends BaseFrameworkSystem implements Debugger, OutputStreamer {
        /**
         * Private constructor
         *
@@ -41,7 +59,31 @@ class DebugConsoleOutput extends BaseFrameworkSystem implements Debugger {
        public final function outputStream ($output) {
                print html_entity_decode(strip_tags($output));
        }
+
+       /**
+        * Outputs the given data without HTML tags
+        *
+        * @param               $output The HTML'ed output
+        * @return      void
+        */
+       public final function output ($outStream=false) {
+               // false will be silently ignored
+               if ($outStream !== false) {
+                       $this->outputStream($outStream);
+               }
+       }
+
+       /**
+        * Assigns a variable for output
+        *
+        * @param               $var            The variable we shall assign
+        * @param               $value  The value to store in the variable
+        * @return      void
+        */
+       public final function assignVariable ($var, $value) {
+               trigger_error(__METHOD__.": Stub!");
+       }
 }
 
-// [EOF]
+//
 ?>
index eebf0bb28696fddae23ce938661c1f184b3d5c95..8916b057e7359ec50e41faafdc8debe95b4aea02 100644 (file)
@@ -1,8 +1,26 @@
 <?php
 /**
  * A debug output class for PHP's error_log() command
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-class DebugErrorLogOutput extends BaseFrameworkSystem implements Debugger {
+class DebugErrorLogOutput extends BaseFrameworkSystem implements Debugger, OutputStreamer {
        /**
         * Private constructor
         *
@@ -50,7 +68,30 @@ class DebugErrorLogOutput extends BaseFrameworkSystem implements Debugger {
                        }
                }
        }
+
+       /**
+        * Assigns a variable for output
+        *
+        * @param               $var            The variable we shall assign
+        * @param               $value  The value to store in the variable
+        * @return      void
+        */
+       public final function assignVariable ($var, $value) {
+               trigger_error(__METHOD__.": Stub!");
+       }
+
+       /**
+        * Output the code
+        *
+        * @return      void
+        */
+       public final function output ($outStream=false) {
+               // false will be silently ignored
+               if ($outStream !== false) {
+                       $this->outputStream($outStream);
+               }
+       }
 }
 
-// [EOF]
+//
 ?>
index f48a053ba4963692c796f106a4e14e2ade70c490..062b2ccab6c66ff35c1a642d3a0aa2277866f9c8 100644 (file)
@@ -1,6 +1,24 @@
 <?php
 /**
  * A debug output class for the web browser
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class DebugWebOutput extends BaseFrameworkSystem implements Debugger {
        /**
index 017b6d1ca718c3706616dc640c3f98f0abb0b29f..8cfb0ec6c78f6ac702cb8e869eb09bb835567fd3 100644 (file)
@@ -2,6 +2,24 @@
 /**
  * This object limits other objects. This is mostly being used to prepare
  * objects to the datatabase connection or else a lot heap would be saved.
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class ObjectLimits extends BaseFrameworkSystem {
        /**
index 83464771991431dc0f359db8e5919205d75027e6..b8790ea642f26b5343051628a518be29ea0b2f2f 100644 (file)
@@ -2,6 +2,24 @@
 /**
  * This class contains object attributes which we can now send together to
  * other classes
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class SerializationContainer extends FrameworkArrayObject {
        /**
index a83bd26baa51d598109cf300291d56b770eb348f..0872f91922551d5ac18fd259810834bc551c985f 100644 (file)
@@ -1,6 +1,24 @@
 <?php
 /**
  * An universal class for file input/output streams.
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class FileIOStream extends BaseFrameworkSystem implements FileInputStreamer, FileOutputStreamer {
        /**
index dbd485aba91a5c746f864b5cc20e06f6f9fcbe6c..796c97022d673d8b2b25b01d59d135616ab5234a 100644 (file)
@@ -1,6 +1,24 @@
 <?php
 /**
  * A class for directory reading and getting its contents
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class FrameworkDirectoryPointer extends BaseFrameworkSystem {
        /**
index 62e0d3324589ffe0ec0c28bf3c116edc0b480c3e..954dffe90a091e8054dd3cb79ffc37a4c2dd4aff 100644 (file)
@@ -1,6 +1,24 @@
 <?php
 /**
  * A class for reading files
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class FrameworkFileInputPointer extends BaseFrameworkSystem {
        /**
index 439b12327cc1ea5dc51ac05ca226ed3096075803..fba46027c33c8461b94769c6b42b1953961ce559 100644 (file)
@@ -1,6 +1,24 @@
 <?php
 /**
  * A class for writing files
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class FrameworkFileOutputPointer extends BaseFrameworkSystem {
        /**
index e2bb71f45e52491a5e707cea3cf00cfb4d319a07..c9bf64d9977ba327a0dd0e3072a3ed69b6c22ad9 100644 (file)
@@ -2,6 +2,24 @@
 /**
  * The language sub-system for handling language strings being used in the
  * application and whole framework
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class LanguageSystem extends BaseFrameworkSystem implements ManageableLanguage {
        /**
index e3dd7ee62fb180f36683cc238418da54fae6df4b..26dca7806ead6ad504539b5a3f6c3f9b20a4477e 100644 (file)
@@ -2,6 +2,24 @@
 /**
  * This class simply puts HTML code / JavaScript code or CSS code out to the
  * browser
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class ConsoleOutput extends BaseFrameworkSystem implements OutputStreamer {
        /**
index 13d3571c4c5d6be702327e06f15ef0921d4f768d..8ed1c4f92524452fb4aad1b0af169af929cf2e28 100644 (file)
@@ -2,6 +2,24 @@
 /**
  * This class simply puts HTML code / JavaScript code or CSS code out to the
  * browser
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class WebOutput extends BaseFrameworkSystem implements OutputStreamer {
        /**
index 253cc86e22bb7886003e9b06ebeaef97069a81c0..a3e94b40b1700d9f6142eba2f9950fc13c37a4c6 100644 (file)
@@ -2,6 +2,24 @@
 /**
  * The own template engine for loading caching and sending out the web pages
  * and emails.
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate {
        /**
@@ -88,7 +106,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         * E.g.: {?template:variable=value;var2=value2;[...]?}
         */
        private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
-        
+
        // Exception codes for the template engine
        const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0xa00;
        const TEMPLATE_CONTAINS_INVALID_VAR_EXCEPTION = 0xa01;
@@ -245,7 +263,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
        public final function initVariableStack () {
                $this->varStack = new FrameworkArrayObject();
        }
-        
+
        /**
         * Setter for language instance which should be LanguageSystem
         *
@@ -255,7 +273,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
        public final function setLanguageInstance (ManageableLanguage $langInstance) {
                $this->langInstance = $langInstance;
        }
-        
+
        /**
         * Setter for file I/O instance which should be FileIOHandler
         *
@@ -265,7 +283,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
        public final function setIOInstance (FileIOHandler $ioInstance) {
                $this->ioInstance = $ioInstance;
        }
-        
+
        /**
         * Getter for file I/O instance which should be FileIOHandler
         *
@@ -389,7 +407,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
        public final function getTemplateType () {
                return $this->templateType;
        }
-        
+
        /**
         * Setter for the last loaded template's FQFN
         *
@@ -401,7 +419,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                $template = (string) $template;
                $this->lastTemplate = $template;
        }
-        
+
        /**
         * Getter for the last loaded template's FQFN
         *
@@ -410,7 +428,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
        private final function getLastTemplate () {
                return $this->lastTemplate;
        }
-       
+
        /**
         * Assign (add) a given variable with a value
         *
@@ -431,7 +449,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                        $this->modifyVariable($var, $value);
                }
        }
-       
+
        /**
         * Assign a given congfiguration variable with a value
         *
@@ -443,7 +461,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                // Sweet and simple...
                $this->configVariables[$var] = $value;
        }
-       
+
        /**
         * Removes a given variable
         *
@@ -930,7 +948,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                // Run the constructed command. This will "compile" all variables in
                eval($eval);
        }
-        
+
        /**
         * Compile all required templates into the current loaded one
         *
index e6ae48e121b54545201b8d82c0308189d0ecd4c7..e0a8b6b79e1aee6d55c4322234b08ae23bdd12cd 100644 (file)
@@ -1,6 +1,24 @@
 <?php
 /**
  * An abstract middleware class for all other middlware classes
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class BaseMiddleware extends BaseFrameworkSystem {
        /**
index 858401fb37b24d3a41b89e2b1145d5062a46771f..05fbad06ba59ace7c40a090953fbf1f72310e535 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Kompressor-Auswahl Klasse
+/**
+ * Middleware for selecting the right compressor channel
+ *
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 class CompressorChannel extends BaseMiddleware {
        // Output handler instance
        private $compressor = null;
@@ -80,7 +101,7 @@ class CompressorChannel extends BaseMiddleware {
                        // Set the null compressor handler
                        $cInstance->setCompressor(NullCompressor::createNullCompressor());
                }
-       
+
                // Return the compressor instance
                return $cInstance;
        }
index bb67ebc8ef5da6be2d55218793878d9426cdc706..8499c0f190416eee778fd99fb21e7456a0a21d1e 100644 (file)
@@ -1,6 +1,25 @@
 <?php
-
-// Database selector class
+/**
+ * Database selector class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 class DatabaseConnection extends BaseMiddleware implements DatabaseConnector, LimitableObject {
        // Array for connection data
        private $connectData = array();
@@ -148,7 +167,7 @@ class DatabaseConnection extends BaseMiddleware implements DatabaseConnector, Li
 
                // Pass the returning result through
                return $this->dbLayer->isUniqueIdUsed($uniqueID, $inConstructor);
-       }       
+       }
 
        /**
         * Gets cached data from the database layer and if not found fetch it from
index 1835ac87fa3f95d0a3fcd5bba6f04e341a0aa055..e43ce8ba6b0a94fd82944ef2f885964c12842c2e 100644 (file)
@@ -3,6 +3,24 @@
  * The middlware debug output system. A *real* or concrete output class shall
  * become registered with this middleware because the back-fall class will
  * become deprecated soon.
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class DebugMiddleware extends BaseMiddleware {
        /**
@@ -40,7 +58,7 @@ class DebugMiddleware extends BaseMiddleware {
         * This fall-back mechanism will become deprecated very soon.
         *
         * @param               $debuggerClass       The class name which we shall use for
-        *                                                      registering the *real* debug output 
+        *                                                      registering the *real* debug output
         * @return      $debugInstance          An instance of this middleware class
         */
        public final static function createDebugMiddleware ($debuggerClass) {
index 18147427c1876ae9c699e33282d60543ddc9dde6..40b2b3592db9f54e341de72fb6a36f102ecb7fbc 100644 (file)
@@ -2,6 +2,24 @@
 /**
  * This is a file IO handler. It handles reading from and writing to files.
  * Missing paths in writing process will be automatically created.
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class FileIOHandler extends BaseMiddleware {
        /**
@@ -68,7 +86,7 @@ class FileIOHandler extends BaseMiddleware {
        public final static function getInstance () {
                return self::$thisInstance;
        }
-       
+
        /**
         * Setter for the *real* file input instance
         *
diff --git a/ship-simu/inc/language/.htaccess b/ship-simu/inc/language/.htaccess
new file mode 100644 (file)
index 0000000..3a42882
--- /dev/null
@@ -0,0 +1 @@
+Deny from all