From 6f7d29bc135479335436751f4dca7aa9bd55612f Mon Sep 17 00:00:00 2001 From: =?utf8?q?Roland=20H=C3=A4der?= Date: Sun, 24 Feb 2008 10:17:21 +0000 Subject: [PATCH] header comments added --- .gitattributes | 2 + .../classes/interfaces/compressor/.htaccess | 1 + .../compressor/class_Compressor.php | 19 +++++++- .../class_FrameworkDatabaseInterface.php | 19 +++++++- .../class_DatabaseFrontendInterface.php | 19 +++++++- .../middleware/class_DatabaseConnector.php | 19 +++++++- .../interfaces/debug/class_Debugger.php | 19 +++++++- .../extended/class_LimitableObject.php | 19 +++++++- .../interfaces/io/class_Streamable.php | 20 ++++++-- .../io/file/class_FileInputStreamer.php | 20 ++++++-- .../io/file/class_FileOutputStreamer.php | 19 +++++++- .../io/output/class_OutputStreamer.php | 24 ++++++++-- .../language/class_ManageableLanguage.php | 19 +++++++- .../template/class_CompileableTemplate.php | 19 +++++++- .../main/class_BaseFrameworkSystem.php | 25 ++++++++-- .../main/class_FrameworkArrayObject.php | 18 ++++++++ .../main/compressor/class_Bzip2Compressor.php | 18 ++++++++ .../main/compressor/class_GzipCompressor.php | 18 ++++++++ .../main/compressor/class_NullCompressor.php | 18 ++++++++ .../main/console/class_ConsoleTools.php | 18 ++++++++ .../database/class_BaseDatabaseFrontend.php | 20 +++++++- .../classes/class_LocalFileDatabase.php | 24 ++++++++-- .../main/debug/class_DebugConsoleOutput.php | 46 ++++++++++++++++++- .../main/debug/class_DebugErrorLogOutput.php | 45 +++++++++++++++++- .../main/debug/class_DebugWebOutput.php | 18 ++++++++ .../main/extended/class_ObjectLimits.php | 18 ++++++++ .../extended/class_SerializationContainer.php | 18 ++++++++ .../classes/main/io/class_FileIOStream.php | 18 ++++++++ .../io/class_FrameworkDirectoryPointer.php | 18 ++++++++ .../io/class_FrameworkFileInputPointer.php | 18 ++++++++ .../io/class_FrameworkFileOutputPointer.php | 18 ++++++++ .../main/language/class_LanguageSystem.php | 18 ++++++++ .../main/output/class_ConsoleOutput.php | 18 ++++++++ .../classes/main/output/class_WebOutput.php | 18 ++++++++ .../main/template/class_TemplateEngine.php | 38 +++++++++++---- .../middleware/class_BaseMiddleware.php | 18 ++++++++ .../compressor/class_CompressorChannel.php | 25 +++++++++- .../database/class_DatabaseConnection.php | 25 ++++++++-- .../debug/class_DebugMiddleware.php | 20 +++++++- .../middleware/io/class_FileIOHandler.php | 20 +++++++- ship-simu/inc/language/.htaccess | 1 + 41 files changed, 755 insertions(+), 60 deletions(-) create mode 100644 ship-simu/inc/classes/interfaces/compressor/.htaccess create mode 100644 ship-simu/inc/language/.htaccess diff --git a/.gitattributes b/.gitattributes index 32c4a2f..3d5165c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -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 index 0000000..3a42882 --- /dev/null +++ b/ship-simu/inc/classes/interfaces/compressor/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/ship-simu/inc/classes/interfaces/compressor/class_Compressor.php b/ship-simu/inc/classes/interfaces/compressor/class_Compressor.php index b8d62b0..5f42ec3 100644 --- a/ship-simu/inc/classes/interfaces/compressor/class_Compressor.php +++ b/ship-simu/inc/classes/interfaces/compressor/class_Compressor.php @@ -2,8 +2,23 @@ /** * An interface for compression classes * - * @author Roland Haeder - * @version 0.1 + * @author Roland Haeder + * @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 . */ interface Compressor extends FrameworkInterface { /** diff --git a/ship-simu/inc/classes/interfaces/database/class_FrameworkDatabaseInterface.php b/ship-simu/inc/classes/interfaces/database/class_FrameworkDatabaseInterface.php index 6550eca..0b06298 100644 --- a/ship-simu/inc/classes/interfaces/database/class_FrameworkDatabaseInterface.php +++ b/ship-simu/inc/classes/interfaces/database/class_FrameworkDatabaseInterface.php @@ -2,8 +2,23 @@ /** * The general interface for all other database interfaces * - * @author Roland Haeder - * @version 0.1 + * @author Roland Haeder + * @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 . */ interface FrameworkDatabaseInterface extends FrameworkInterface { /** diff --git a/ship-simu/inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php b/ship-simu/inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php index 35c13b5..839ba63 100644 --- a/ship-simu/inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php +++ b/ship-simu/inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php @@ -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 - * @version 0.1 + * @author Roland Haeder + * @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 . */ interface DatabaseFrontendInterface extends FrameworkDatabaseInterface { /** diff --git a/ship-simu/inc/classes/interfaces/database/middleware/class_DatabaseConnector.php b/ship-simu/inc/classes/interfaces/database/middleware/class_DatabaseConnector.php index 5964420..0182ef8 100644 --- a/ship-simu/inc/classes/interfaces/database/middleware/class_DatabaseConnector.php +++ b/ship-simu/inc/classes/interfaces/database/middleware/class_DatabaseConnector.php @@ -2,8 +2,23 @@ /** * An interface for middleware database classes * - * @author Roland Haeder - * @version 0.1 + * @author Roland Haeder + * @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 . */ interface DatabaseConnector extends FrameworkDatabaseInterface { } diff --git a/ship-simu/inc/classes/interfaces/debug/class_Debugger.php b/ship-simu/inc/classes/interfaces/debug/class_Debugger.php index 8ba621d..46cdeb4 100644 --- a/ship-simu/inc/classes/interfaces/debug/class_Debugger.php +++ b/ship-simu/inc/classes/interfaces/debug/class_Debugger.php @@ -2,8 +2,23 @@ /** * An interface for debugger classes * - * @author Roland Haeder - * @version 0.1 + * @author Roland Haeder + * @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 . */ interface Debugger extends FrameworkInterface { /** diff --git a/ship-simu/inc/classes/interfaces/extended/class_LimitableObject.php b/ship-simu/inc/classes/interfaces/extended/class_LimitableObject.php index f1fa6af..8ed5eb9 100644 --- a/ship-simu/inc/classes/interfaces/extended/class_LimitableObject.php +++ b/ship-simu/inc/classes/interfaces/extended/class_LimitableObject.php @@ -3,8 +3,23 @@ * This is an inface for limiting object while saving them with the * DatabaseConnection class. * - * @author Roland Haeder - * @version 0.1 + * @author Roland Haeder + * @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 . */ interface LimitableObject extends FrameworkInterface { /** diff --git a/ship-simu/inc/classes/interfaces/io/class_Streamable.php b/ship-simu/inc/classes/interfaces/io/class_Streamable.php index aaa697d..1392564 100644 --- a/ship-simu/inc/classes/interfaces/io/class_Streamable.php +++ b/ship-simu/inc/classes/interfaces/io/class_Streamable.php @@ -1,10 +1,24 @@ - * @version 0.1 + * @author Roland Haeder + * @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 . */ interface Streamable extends FrameworkInterface { } diff --git a/ship-simu/inc/classes/interfaces/io/file/class_FileInputStreamer.php b/ship-simu/inc/classes/interfaces/io/file/class_FileInputStreamer.php index 891c658..6204e34 100644 --- a/ship-simu/inc/classes/interfaces/io/file/class_FileInputStreamer.php +++ b/ship-simu/inc/classes/interfaces/io/file/class_FileInputStreamer.php @@ -1,10 +1,24 @@ - * @version 0.1 + * @author Roland Haeder + * @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 . */ interface FileInputStreamer extends Streamable { /** diff --git a/ship-simu/inc/classes/interfaces/io/file/class_FileOutputStreamer.php b/ship-simu/inc/classes/interfaces/io/file/class_FileOutputStreamer.php index 2b866f4..55bc37e 100644 --- a/ship-simu/inc/classes/interfaces/io/file/class_FileOutputStreamer.php +++ b/ship-simu/inc/classes/interfaces/io/file/class_FileOutputStreamer.php @@ -2,8 +2,23 @@ /** * An interface for file output operations. * - * @author Roland Haeder - * @version 0.1 + * @author Roland Haeder + * @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 . */ interface FileOutputStreamer extends Streamable { /** diff --git a/ship-simu/inc/classes/interfaces/io/output/class_OutputStreamer.php b/ship-simu/inc/classes/interfaces/io/output/class_OutputStreamer.php index 542e0b4..6e4431f 100644 --- a/ship-simu/inc/classes/interfaces/io/output/class_OutputStreamer.php +++ b/ship-simu/inc/classes/interfaces/io/output/class_OutputStreamer.php @@ -1,10 +1,24 @@ - * @version 0.1 + * @author Roland Haeder + * @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 . */ 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); } // diff --git a/ship-simu/inc/classes/interfaces/language/class_ManageableLanguage.php b/ship-simu/inc/classes/interfaces/language/class_ManageableLanguage.php index 0649c5e..77f3fbc 100644 --- a/ship-simu/inc/classes/interfaces/language/class_ManageableLanguage.php +++ b/ship-simu/inc/classes/interfaces/language/class_ManageableLanguage.php @@ -2,8 +2,23 @@ /** * An interface for language systems * - * @author Roland Haeder - * @version 0.1 + * @author Roland Haeder + * @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 . */ interface ManageableLanguage extends FrameworkInterface { /** diff --git a/ship-simu/inc/classes/interfaces/template/class_CompileableTemplate.php b/ship-simu/inc/classes/interfaces/template/class_CompileableTemplate.php index 8df39d8..1477f74 100644 --- a/ship-simu/inc/classes/interfaces/template/class_CompileableTemplate.php +++ b/ship-simu/inc/classes/interfaces/template/class_CompileableTemplate.php @@ -2,8 +2,23 @@ /** * An interface for template engines * - * @author Roland Haeder - * @version 0.1 + * @author Roland Haeder + * @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 . */ interface CompileableTemplate extends FrameworkInterface { /** diff --git a/ship-simu/inc/classes/main/class_BaseFrameworkSystem.php b/ship-simu/inc/classes/main/class_BaseFrameworkSystem.php index 02ff367..3721f63 100644 --- a/ship-simu/inc/classes/main/class_BaseFrameworkSystem.php +++ b/ship-simu/inc/classes/main/class_BaseFrameworkSystem.php @@ -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 + * @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 . */ 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(), diff --git a/ship-simu/inc/classes/main/class_FrameworkArrayObject.php b/ship-simu/inc/classes/main/class_FrameworkArrayObject.php index 89f6b7e..e73f8a8 100644 --- a/ship-simu/inc/classes/main/class_FrameworkArrayObject.php +++ b/ship-simu/inc/classes/main/class_FrameworkArrayObject.php @@ -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 + * @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 . */ class FrameworkArrayObject extends ArrayObject { /** diff --git a/ship-simu/inc/classes/main/compressor/class_Bzip2Compressor.php b/ship-simu/inc/classes/main/compressor/class_Bzip2Compressor.php index 78c2571..56e704c 100644 --- a/ship-simu/inc/classes/main/compressor/class_Bzip2Compressor.php +++ b/ship-simu/inc/classes/main/compressor/class_Bzip2Compressor.php @@ -1,6 +1,24 @@ + * @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 . */ class Bzip2Compressor extends BaseFrameworkSystem implements Compressor { /** diff --git a/ship-simu/inc/classes/main/compressor/class_GzipCompressor.php b/ship-simu/inc/classes/main/compressor/class_GzipCompressor.php index d3ed86a..f00b2d0 100644 --- a/ship-simu/inc/classes/main/compressor/class_GzipCompressor.php +++ b/ship-simu/inc/classes/main/compressor/class_GzipCompressor.php @@ -1,6 +1,24 @@ + * @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 . */ class GzipCompressor extends BaseFrameworkSystem implements Compressor { /** diff --git a/ship-simu/inc/classes/main/compressor/class_NullCompressor.php b/ship-simu/inc/classes/main/compressor/class_NullCompressor.php index 4762cb8..b4a1236 100644 --- a/ship-simu/inc/classes/main/compressor/class_NullCompressor.php +++ b/ship-simu/inc/classes/main/compressor/class_NullCompressor.php @@ -1,6 +1,24 @@ + * @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 . */ class NullCompressor extends BaseFrameworkSystem implements Compressor { /** diff --git a/ship-simu/inc/classes/main/console/class_ConsoleTools.php b/ship-simu/inc/classes/main/console/class_ConsoleTools.php index c57070d..97f1bc2 100644 --- a/ship-simu/inc/classes/main/console/class_ConsoleTools.php +++ b/ship-simu/inc/classes/main/console/class_ConsoleTools.php @@ -1,6 +1,24 @@ + * @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 . */ class ConsoleTools extends BaseFrameworkSystem { /** diff --git a/ship-simu/inc/classes/main/database/class_BaseDatabaseFrontend.php b/ship-simu/inc/classes/main/database/class_BaseDatabaseFrontend.php index 601c042..7d6f8a0 100644 --- a/ship-simu/inc/classes/main/database/class_BaseDatabaseFrontend.php +++ b/ship-simu/inc/classes/main/database/class_BaseDatabaseFrontend.php @@ -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 + * @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 . */ abstract class BaseDatabaseFrontend extends BaseFrameworkSystem implements DatabaseFrontendInterface, LimitableObject { /** diff --git a/ship-simu/inc/classes/main/database/classes/class_LocalFileDatabase.php b/ship-simu/inc/classes/main/database/classes/class_LocalFileDatabase.php index 5a83742..ff5f1dd 100644 --- a/ship-simu/inc/classes/main/database/classes/class_LocalFileDatabase.php +++ b/ship-simu/inc/classes/main/database/classes/class_LocalFileDatabase.php @@ -4,8 +4,24 @@ * * This class serializes objects and saves them to local files. * - * @author Roland Haeder - * @version 0.1 + * + * @author Roland Haeder + * @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 . */ 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 diff --git a/ship-simu/inc/classes/main/debug/class_DebugConsoleOutput.php b/ship-simu/inc/classes/main/debug/class_DebugConsoleOutput.php index dd930bc..d92648e 100644 --- a/ship-simu/inc/classes/main/debug/class_DebugConsoleOutput.php +++ b/ship-simu/inc/classes/main/debug/class_DebugConsoleOutput.php @@ -1,8 +1,26 @@ + * @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 . */ -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] +// ?> diff --git a/ship-simu/inc/classes/main/debug/class_DebugErrorLogOutput.php b/ship-simu/inc/classes/main/debug/class_DebugErrorLogOutput.php index eebf0bb..8916b05 100644 --- a/ship-simu/inc/classes/main/debug/class_DebugErrorLogOutput.php +++ b/ship-simu/inc/classes/main/debug/class_DebugErrorLogOutput.php @@ -1,8 +1,26 @@ + * @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 . */ -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] +// ?> diff --git a/ship-simu/inc/classes/main/debug/class_DebugWebOutput.php b/ship-simu/inc/classes/main/debug/class_DebugWebOutput.php index f48a053..062b2cc 100644 --- a/ship-simu/inc/classes/main/debug/class_DebugWebOutput.php +++ b/ship-simu/inc/classes/main/debug/class_DebugWebOutput.php @@ -1,6 +1,24 @@ + * @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 . */ class DebugWebOutput extends BaseFrameworkSystem implements Debugger { /** diff --git a/ship-simu/inc/classes/main/extended/class_ObjectLimits.php b/ship-simu/inc/classes/main/extended/class_ObjectLimits.php index 017b6d1..8cfb0ec 100644 --- a/ship-simu/inc/classes/main/extended/class_ObjectLimits.php +++ b/ship-simu/inc/classes/main/extended/class_ObjectLimits.php @@ -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 + * @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 . */ class ObjectLimits extends BaseFrameworkSystem { /** diff --git a/ship-simu/inc/classes/main/extended/class_SerializationContainer.php b/ship-simu/inc/classes/main/extended/class_SerializationContainer.php index 8346477..b8790ea 100644 --- a/ship-simu/inc/classes/main/extended/class_SerializationContainer.php +++ b/ship-simu/inc/classes/main/extended/class_SerializationContainer.php @@ -2,6 +2,24 @@ /** * This class contains object attributes which we can now send together to * other classes + * + * @author Roland Haeder + * @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 . */ class SerializationContainer extends FrameworkArrayObject { /** diff --git a/ship-simu/inc/classes/main/io/class_FileIOStream.php b/ship-simu/inc/classes/main/io/class_FileIOStream.php index a83bd26..0872f91 100644 --- a/ship-simu/inc/classes/main/io/class_FileIOStream.php +++ b/ship-simu/inc/classes/main/io/class_FileIOStream.php @@ -1,6 +1,24 @@ + * @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 . */ class FileIOStream extends BaseFrameworkSystem implements FileInputStreamer, FileOutputStreamer { /** diff --git a/ship-simu/inc/classes/main/io/class_FrameworkDirectoryPointer.php b/ship-simu/inc/classes/main/io/class_FrameworkDirectoryPointer.php index dbd485a..796c970 100644 --- a/ship-simu/inc/classes/main/io/class_FrameworkDirectoryPointer.php +++ b/ship-simu/inc/classes/main/io/class_FrameworkDirectoryPointer.php @@ -1,6 +1,24 @@ + * @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 . */ class FrameworkDirectoryPointer extends BaseFrameworkSystem { /** diff --git a/ship-simu/inc/classes/main/io/class_FrameworkFileInputPointer.php b/ship-simu/inc/classes/main/io/class_FrameworkFileInputPointer.php index 62e0d33..954dffe 100644 --- a/ship-simu/inc/classes/main/io/class_FrameworkFileInputPointer.php +++ b/ship-simu/inc/classes/main/io/class_FrameworkFileInputPointer.php @@ -1,6 +1,24 @@ + * @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 . */ class FrameworkFileInputPointer extends BaseFrameworkSystem { /** diff --git a/ship-simu/inc/classes/main/io/class_FrameworkFileOutputPointer.php b/ship-simu/inc/classes/main/io/class_FrameworkFileOutputPointer.php index 439b123..fba4602 100644 --- a/ship-simu/inc/classes/main/io/class_FrameworkFileOutputPointer.php +++ b/ship-simu/inc/classes/main/io/class_FrameworkFileOutputPointer.php @@ -1,6 +1,24 @@ + * @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 . */ class FrameworkFileOutputPointer extends BaseFrameworkSystem { /** diff --git a/ship-simu/inc/classes/main/language/class_LanguageSystem.php b/ship-simu/inc/classes/main/language/class_LanguageSystem.php index e2bb71f..c9bf64d 100644 --- a/ship-simu/inc/classes/main/language/class_LanguageSystem.php +++ b/ship-simu/inc/classes/main/language/class_LanguageSystem.php @@ -2,6 +2,24 @@ /** * The language sub-system for handling language strings being used in the * application and whole framework + * + * @author Roland Haeder + * @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 . */ class LanguageSystem extends BaseFrameworkSystem implements ManageableLanguage { /** diff --git a/ship-simu/inc/classes/main/output/class_ConsoleOutput.php b/ship-simu/inc/classes/main/output/class_ConsoleOutput.php index e3dd7ee..26dca78 100644 --- a/ship-simu/inc/classes/main/output/class_ConsoleOutput.php +++ b/ship-simu/inc/classes/main/output/class_ConsoleOutput.php @@ -2,6 +2,24 @@ /** * This class simply puts HTML code / JavaScript code or CSS code out to the * browser + * + * @author Roland Haeder + * @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 . */ class ConsoleOutput extends BaseFrameworkSystem implements OutputStreamer { /** diff --git a/ship-simu/inc/classes/main/output/class_WebOutput.php b/ship-simu/inc/classes/main/output/class_WebOutput.php index 13d3571..8ed1c4f 100644 --- a/ship-simu/inc/classes/main/output/class_WebOutput.php +++ b/ship-simu/inc/classes/main/output/class_WebOutput.php @@ -2,6 +2,24 @@ /** * This class simply puts HTML code / JavaScript code or CSS code out to the * browser + * + * @author Roland Haeder + * @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 . */ class WebOutput extends BaseFrameworkSystem implements OutputStreamer { /** diff --git a/ship-simu/inc/classes/main/template/class_TemplateEngine.php b/ship-simu/inc/classes/main/template/class_TemplateEngine.php index 253cc86..a3e94b4 100644 --- a/ship-simu/inc/classes/main/template/class_TemplateEngine.php +++ b/ship-simu/inc/classes/main/template/class_TemplateEngine.php @@ -2,6 +2,24 @@ /** * The own template engine for loading caching and sending out the web pages * and emails. + * + * @author Roland Haeder + * @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 . */ 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 * diff --git a/ship-simu/inc/classes/middleware/class_BaseMiddleware.php b/ship-simu/inc/classes/middleware/class_BaseMiddleware.php index e6ae48e..e0a8b6b 100644 --- a/ship-simu/inc/classes/middleware/class_BaseMiddleware.php +++ b/ship-simu/inc/classes/middleware/class_BaseMiddleware.php @@ -1,6 +1,24 @@ + * @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 . */ class BaseMiddleware extends BaseFrameworkSystem { /** diff --git a/ship-simu/inc/classes/middleware/compressor/class_CompressorChannel.php b/ship-simu/inc/classes/middleware/compressor/class_CompressorChannel.php index 858401f..05fbad0 100644 --- a/ship-simu/inc/classes/middleware/compressor/class_CompressorChannel.php +++ b/ship-simu/inc/classes/middleware/compressor/class_CompressorChannel.php @@ -1,5 +1,26 @@ + * @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 . + */ 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; } diff --git a/ship-simu/inc/classes/middleware/database/class_DatabaseConnection.php b/ship-simu/inc/classes/middleware/database/class_DatabaseConnection.php index bb67ebc..8499c0f 100644 --- a/ship-simu/inc/classes/middleware/database/class_DatabaseConnection.php +++ b/ship-simu/inc/classes/middleware/database/class_DatabaseConnection.php @@ -1,6 +1,25 @@ + * @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 . + */ 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 diff --git a/ship-simu/inc/classes/middleware/debug/class_DebugMiddleware.php b/ship-simu/inc/classes/middleware/debug/class_DebugMiddleware.php index 1835ac8..e43ce8b 100644 --- a/ship-simu/inc/classes/middleware/debug/class_DebugMiddleware.php +++ b/ship-simu/inc/classes/middleware/debug/class_DebugMiddleware.php @@ -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 + * @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 . */ 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) { diff --git a/ship-simu/inc/classes/middleware/io/class_FileIOHandler.php b/ship-simu/inc/classes/middleware/io/class_FileIOHandler.php index 1814742..40b2b35 100644 --- a/ship-simu/inc/classes/middleware/io/class_FileIOHandler.php +++ b/ship-simu/inc/classes/middleware/io/class_FileIOHandler.php @@ -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 + * @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 . */ 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 index 0000000..3a42882 --- /dev/null +++ b/ship-simu/inc/language/.htaccess @@ -0,0 +1 @@ +Deny from all -- 2.30.2