Test function documentation for HTTP header helpers

mebjas · Nov 4, 2016 · 5007eb1 · 5007eb1
1 parent c503910
commit 5007eb1
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/test/csrfprotector_test.php b/test/csrfprotector_test.php
@@ -15,6 +15,10 @@ public static function changeRequestType($type)
         self::$requestType = $type;
     }
 
+    /**
+     * Function to check for a string value anywhere within HTTP response headers
+     * Returns true on first match of $needle in header names or values
+     */
     public static function checkHeader($needle)
     {
         $haystack = xdebug_get_headers();
@@ -25,6 +29,10 @@ public static function checkHeader($needle)
         return false;
     }
 
+    /**
+     * Function to return the string value of the last response header
+     * identified by name $needle
+     */
     public static function getHeaderValue($needle)
     {
         $haystack = xdebug_get_headers();