60 lines
1.8 KiB
Markdown
60 lines
1.8 KiB
Markdown
|
# Stack/Cors
|
||
|
|
|
||
|
|
Library and middleware enabling cross-origin resource sharing for your
|
||
|
|
http-{foundation,kernel} using application. It attempts to implement the
|
||
|
|
[W3C Candidate Recommendation] for cross-origin resource sharing.
|
||
|
|
|
||
|
|
[W3C Candidate Recommendation]: http://www.w3.org/TR/cors/
|
||
|
|
|
||
|
|
Master [](http://travis-ci.org/asm89/stack-cors)
|
||
|
|
Develop [](http://travis-ci.org/asm89/stack-cors)
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
Require `asm89/stack-cors` using composer.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Stack middleware:
|
||
|
|
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
|
||
|
|
use Asm89\Stack\Cors;
|
||
|
|
|
||
|
|
$app = new Cors($app, array(
|
||
|
|
// you can use array('*') to allow any headers
|
||
|
|
'allowedHeaders' => array('x-allowed-header', 'x-other-allowed-header'),
|
||
|
|
// you can use array('*') to allow any methods
|
||
|
|
'allowedMethods' => array('DELETE', 'GET', 'POST', 'PUT'),
|
||
|
|
// you can use array('*') to allow requests from any origin
|
||
|
|
'allowedOrigins' => array('localhost'),
|
||
|
|
'exposedHeaders' => false,
|
||
|
|
'maxAge' => false,
|
||
|
|
'supportsCredentials' => false,
|
||
|
|
));
|
||
|
|
```
|
||
|
|
|
||
|
|
Or use the library:
|
||
|
|
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
|
||
|
|
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,
|
||
|
|
));
|
||
|
|
|
||
|
|
$cors->addActualRequestHeaders(Response $response, $origin);
|
||
|
|
$cors->handlePreflightRequest(Request $request);
|
||
|
|
$cors->isActualRequestAllowed(Request $request);
|
||
|
|
$cors->isCorsRequest(Request $request);
|
||
|
|
$cors->isPreflightRequest(Request $request);
|
||
|
|
```
|