]> git.mxchange.org Git - core.git/blobdiff - inc/classes/interfaces/request/class_Requestable.php
Had to rename more stuff.
[core.git] / inc / classes / interfaces / request / class_Requestable.php
index a06ddd3cc52580952b53f474b48738e0960f93d0..2f12a09798ebe83fe030a670165d9f05ba6f4b6e 100644 (file)
@@ -2,11 +2,11 @@
 /**
  * An interface for requests
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 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
  */
 interface Requestable extends FrameworkInterface {
        /**
-        * Prepares the HTTP request data for usage by currently copying
-        * $_REQUEST into a private attribute. Later on we can add more
-        * things for initialization here.
+        * Prepares the request data for usage
         *
         * @return      void
         */
        function prepareRequestData ();
 
        /**
-        * Checks wether a request element is set
+        * Checks whether a request element is set
+        *
         * @param       $element        Name of the request element we want to check
-        * @return      $isSet          Wether the request element is set
+        * @return      $isSet          Whether the request element is set
         * @throws      MissingArrayElementsException   Thrown if a request element is not set
         */
        function isRequestElementSet ($element);
@@ -61,15 +60,15 @@ interface Requestable extends FrameworkInterface {
         * @param       $headerName             Name of the header
         * @return      $headerValue    Value of the header or 'null' if not found
         */
-       function getHeader ($headerName);
+       function getHeaderElement ($headerName);
 
        /**
-        * Sets wether the request was valid (default: true)
+        * Sets whether the request was valid (default: TRUE)
         *
-        * @param       $isValid                Wether the request is valid
+        * @param       $isValid        Whether the request is valid
         * @return      void
         */
-       function requestIsValid ($isValid = true);
+       function requestIsValid ($isValid = TRUE);
 
        /**
         * Reads a cookie and returns it's value or null if not found
@@ -80,5 +79,5 @@ interface Requestable extends FrameworkInterface {
        function readCookie ($cookieName);
 }
 
-//
+// [EOF]
 ?>