Updated copyright:

[core.git] / inc / classes / main / request / console / class_ConsoleRequest.php

diff --git a/inc/classes/main/request/console/class_ConsoleRequest.php b/inc/classes/main/request/console/class_ConsoleRequest.php
index ffe52144cbfd3a371af1029e90f982c7058e3382..eba7b74d48792161d65c3f59d579a4d9d9c3b39e 100644 (file)
--- a/inc/classes/main/request/console/class_ConsoleRequest.php
+++ b/inc/classes/main/request/console/class_ConsoleRequest.php
@@ -2,11 +2,11 @@
 /**
  * A concrete request class
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.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
@@ -37,7 +37,7 @@ class ConsoleRequest extends BaseRequest implements Requestable {
         *
         * @return      $httpInstance   An instance of this class
         */
-       public final static function createConsoleRequest () {
+       public static final function createConsoleRequest () {
                // Create an instance
                $httpInstance = new ConsoleRequest();
 
@@ -52,7 +52,6 @@ class ConsoleRequest extends BaseRequest implements Requestable {
         * Prepares the request data for usage
         *
         * @return      void
-        * @todo        Needs to be implemented
         */
        public function prepareRequestData () {
                // Get the "request data" from the command-line argument list
@@ -91,9 +90,11 @@ class ConsoleRequest extends BaseRequest implements Requestable {
         *
         * @param       $headerName             Name of the header
         * @return      $headerValue    Value of the header or 'null' if not found
+        * @throws      UnsupportedOperationException   This method should never be called
         */
-       public function getHeader ($headerName) {
-               $this->partialStub('Please implement this method.');
+       public function getHeaderElement ($headerName) {
+               // Console doesn't have any headers
+               throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);
        }
 
        /**
@@ -102,6 +103,7 @@ class ConsoleRequest extends BaseRequest implements Requestable {
         * @return      $requestMethod  Used request method
         */
        public final function getRequestMethod () {
+               // @TODO Can't this be 'CONSOLE' ?
                return 'LOCAL';
        }
 
@@ -110,10 +112,11 @@ class ConsoleRequest extends BaseRequest implements Requestable {
         *
         * @param       $cookieName             Name of cookie we shall read
         * @return      $cookieValue    Value of cookie or null if not found
+        * @throws      UnsupportedOperationException   This method should never be called
         */
        public final function readCookie ($cookieName) {
-               // @TODO There are no cookies on console
-               return null;
+               // There are no cookies on console
+               throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);
        }
 }