inc/classes/main/request/console/class_ConsoleRequest.php

   1 <?php
   2 /**
   3  * A concrete request class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class ConsoleRequest extends BaseRequest implements Requestable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class and prepares it a little
  37          *
  38          * @return      $httpInstance   An instance of this class
  39          */
  40         public static final function createConsoleRequest () {
  41                 // Create an instance
  42                 $httpInstance = new ConsoleRequest();
  43
  44                 // Prepare the console request data for usage
  45                 $httpInstance->prepareRequestData();
  46
  47                 // Return the prepared instance
  48                 return $httpInstance;
  49         }
  50
  51         /**
  52          * Prepares the request data for usage
  53          *
  54          * @return      void
  55          * @todo        Needs to be implemented
  56          */
  57         public function prepareRequestData () {
  58                 // Get the "request data" from the command-line argument list
  59                 $args = $_SERVER['argv'];
  60
  61                 // Are there less than two parameters?
  62                 if ($_SERVER['argc'] < 2) {
  63                         // Skip this
  64                         return;
  65                 } // END - if
  66
  67                 // Is the first element "index.php" ?
  68                 if ($args[0] == 'index.php') {
  69                         // Then remove it
  70                         array_shift($args);
  71                 } // END - if
  72
  73                 // Try to determine next parameters
  74                 foreach ($args as $arg) {
  75                         // Seperate arguemnt name from value
  76                         $argArray = explode('=', $arg);
  77
  78                         // Is the second one set?
  79                         if (!isset($argArray[1])) {
  80                                 // Add it likewise, but empty value
  81                                 $this->setRequestElement($argArray[0], '');
  82                         } else {
  83                                 // Set a name=value pair escaped and secured
  84                                 $this->setRequestElement($argArray[0], escapeshellcmd($argArray[1]));
  85                         }
  86                 } // END - foreach
  87         }
  88
  89         /**
  90          * Getter for a header element or 'null' if header was not found
  91          *
  92          * @param       $headerName             Name of the header
  93          * @return      $headerValue    Value of the header or 'null' if not found
  94          */
  95         public function getHeader ($headerName) {
  96                 $this->partialStub('Please implement this method.');
  97         }
  98
  99         /**
 100          * Getter for request method. This getter might be useful for security filters
 101          *
 102          * @return      $requestMethod  Used request method
 103          */
 104         public final function getRequestMethod () {
 105                 return 'LOCAL';
 106         }
 107
 108         /**
 109          * Reads a cookie and returns it's value or null if not found
 110          *
 111          * @param       $cookieName             Name of cookie we shall read
 112          * @return      $cookieValue    Value of cookie or null if not found
 113          */
 114         public final function readCookie ($cookieName) {
 115                 // @TODO There are no cookies on console
 116                 return null;
 117         }
 118 }
 119
 120 // [EOF]
 121 ?>