X-Git-Url: http://www.aleph1.co.uk/gitweb/?p=yaffs-website;a=blobdiff_plain;f=vendor%2Fasm89%2Fstack-cors%2FREADME.md;fp=vendor%2Fasm89%2Fstack-cors%2FREADME.md;h=40b60e5b7868c6be49dd76ab822749499f636584;hp=904ac936d7845491d9c3425eb542d5ce9b94b83b;hb=9917807b03b64faf00f6a1f29dcb6eafc454efa5;hpb=aea91e65e895364e460983b890e295aa5d5540a5

diff --git a/vendor/asm89/stack-cors/README.md b/vendor/asm89/stack-cors/README.md
index 904ac936d..40b60e5b7 100644
--- a/vendor/asm89/stack-cors/README.md
+++ b/vendor/asm89/stack-cors/README.md
@@ -18,6 +18,24 @@ This package can be used as a library or as [stack middleware].
 
 [stack middleware]: http://stackphp.com/
 
+### Options
+
+| Option                 | Description                                                | Default value |
+|------------------------|------------------------------------------------------------|---------------|
+| allowedMethods         | Matches the request method.                                | `array()`     |
+| allowedOrigins         | Matches the request origin.                                | `array()`     |
+| allowedOriginsPatterns | Matches the request origin with `preg_match`.              | `array()`  |
+| allowedHeaders         | Sets the Access-Control-Allow-Headers response header.     | `array()`     |
+| exposedHeaders         | Sets the Access-Control-Expose-Headers response header.    | `false`       |
+| maxAge                 | Sets the Access-Control-Max-Age response header.           | `false`       |
+| supportsCredentials    | Sets the Access-Control-Allow-Credentials header.          | `false`       |
+
+The _allowedMethods_ and _allowedHeaders_ options are case-insensitive.
+
+You don't need to provide both _allowedOrigins_ and _allowedOriginsPatterns_. If one of the strings passed matches, it is considered a valid origin.
+
+If `array('*')` is provided to _allowedMethods_, _allowedOrigins_ or _allowedHeaders_ all methods / origins / headers are allowed.
+
 ### Example: using the library
 
 ```php
@@ -26,12 +44,13 @@ This package can be used as a library or as [stack middleware].
 use Asm89\Stack\CorsService;
 
 $cors = new CorsService(array(
-    'allowedHeaders'      => array('x-allowed-header', 'x-other-allowed-header'),
-    'allowedMethods'      => array('DELETE', 'GET', 'POST', 'PUT'),
-    'allowedOrigins'      => array('localhost'),
-    'exposedHeaders'      => false,
-    'maxAge'              => false,
-    'supportsCredentials' => false,
+    'allowedHeaders'         => array('x-allowed-header', 'x-other-allowed-header'),
+    'allowedMethods'         => array('DELETE', 'GET', 'POST', 'PUT'),
+    'allowedOrigins'         => array('localhost'),
+    'allowedOriginsPatterns' => array('/localhost:\d/'),
+    'exposedHeaders'         => false,
+    'maxAge'                 => false,
+    'supportsCredentials'    => false,
 ));
 
 $cors->addActualRequestHeaders(Response $response, $origin);
@@ -55,6 +74,8 @@ $app = new Cors($app, array(
     'allowedMethods'      => array('DELETE', 'GET', 'POST', 'PUT'),
     // you can use array('*') to allow requests from any origin
     'allowedOrigins'      => array('localhost'),
+    // you can enter regexes that are matched to the origin request header
+    'allowedOriginsPatterns' => array('/localhost:\d/'),
     'exposedHeaders'      => false,
     'maxAge'              => false,
     'supportsCredentials' => false,