framework/main/classes/request/class_

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Request;
   4
   5 /**
   6  * A concrete request class
   7  *
   8  * @author              Roland Haeder <webmaster@ship-simu.org>
   9  * @version             0.0.0
  10 <<<<<<< HEAD:framework/main/classes/request/class_
  11  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  12 =======
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  14 >>>>>>> Some updates::inc/main/classes/request/class_
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.ship-simu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class ???Request extends BaseRequest implements Requestable {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Creates an instance of this class and prepares it a little
  44          *
  45          * @return      $requestInstance        An instance of this class
  46          */
  47         public final static function create???Request () {
  48                 // Create an instance
  49                 $requestInstance = new ???Request();
  50
  51                 // Prepare the HTTP request data for usage
  52                 $requestInstance->prepareRequestData();
  53
  54                 // Return the prepared instance
  55                 return $requestInstance;
  56         }
  57
  58         /**
  59          * Prepares the request data for usage
  60          *
  61          * @return      void
  62          * @todo        Needs to be implemented
  63          */
  64         protected function prepareRequestData () {
  65                 $this->partialStub("Please implement this method.");
  66         }
  67
  68         /**
  69          * Getter for a header element or 'null' if header was not found
  70          *
  71          * @param       $headerName             Name of the header
  72          * @return      $headerValue    Value of the header or 'null' if not found
  73          */
  74         public function getHeaderElement ($headerName) {
  75                 $this->partialStub("Please implement this method.");
  76         }
  77
  78         /**
  79          * Getter for request method. This getter might be useful for security filters
  80          *
  81          * @return      $requestMethod  Used request method
  82          */
  83         public final function getRequestMethod () {
  84                 $this->partialStub("Please implement this method.");
  85                 return $_SERVER['REQUEST_METHOD'];
  86         }
  87
  88         /**
  89          * Reads a cookie and returns it's value or null if not found
  90          *
  91          * @param       $cookieName             Name of cookie we shall read
  92          * @return      $cookieValue    Value of cookie or null if not found
  93          */
  94         public final function readCookie ($cookieName) {
  95                 $this->partialStub("Please implement this method.");
  96         }
  97
  98 }