Continued with renaming-season:

[core.git] / framework / main / classes / request / class_

diff --git a/framework/main/classes/request/class_ b/framework/main/classes/request/class_
new file mode 100644 (file)
index 0000000..e046132
--- /dev/null
+++ b/framework/main/classes/request/class_
@@ -0,0 +1,96 @@
+<?php
+// Own namespace
+namespace CoreFramework\Request;
+
+/**
+ * A concrete request class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.org
+ *
+ * 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 ???Request extends BaseRequest implements Requestable {
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+       }
+
+       /**
+        * Creates an instance of this class and prepares it a little
+        *
+        * @return      $httpInstance   An instance of this class
+        */
+       public final static function create???Request () {
+               // Create an instance
+               $httpInstance = new ???Request();
+
+               // Prepare the HTTP request data for usage
+               $httpInstance->prepareRequestData();
+
+               // Return the prepared instance
+               return $httpInstance;
+       }
+
+       /**
+        * Prepares the request data for usage
+        *
+        * @return      void
+        * @todo        Needs to be implemented
+        */
+       public function prepareRequestData () {
+               $this->partialStub("Please implement this method.");
+       }
+
+       /**
+        * Getter for a header element or 'null' if header was not found
+        *
+        * @param       $headerName             Name of the header
+        * @return      $headerValue    Value of the header or 'null' if not found
+        */
+       public function getHeaderElement ($headerName) {
+               $this->partialStub("Please implement this method.");
+       }
+
+       /**
+        * Getter for request method. This getter might be useful for security filters
+        *
+        * @return      $requestMethod  Used request method
+        */
+       public final function getRequestMethod () {
+               $this->partialStub("Please implement this method.");
+               return $_SERVER['REQUEST_METHOD'];
+       }
+
+       /**
+        * Reads a cookie and returns it's value or null if not found
+        *
+        * @param       $cookieName             Name of cookie we shall read
+        * @return      $cookieValue    Value of cookie or null if not found
+        */
+       public final function readCookie ($cookieName) {
+               $this->partialStub("Please implement this method.");
+       }
+}
+
+// [EOF]
+?>