Downloads
Stars
Version
Cross-Origin Resource Sharing (CORS) module for the Lumen PHP framework.
Run the following command to install the package through Composer:
composer require nordsoftware/lumen-cors
Copy the configuration template in config/cors.php
to your application's config
directory and modify according to your needs.
For more information see the Configuration Files section in the Lumen documentation.
Available configuration options:
array
Origins that are allowed to perform requests, defaults to an empty array. Patterns also accepted, for example *.foo.com
array
HTTP methods that are allowed, defaults to an empty array
array
HTTP headers that are allowed, defaults to an empty array
boolean
Whether or not the response can be exposed when credentials are present, defaults to false
array
HTTP headers that are allowed to be exposed to the web browser, defaults to an empty array
integer
Indicates how long preflight request can be cached, defaults to 0
Add the following lines to bootstrap/app.php
:
$app->register('Nord\Lumen\Cors\CorsServiceProvider');
$app->middleware([
.....
'Nord\Lumen\Cors\CorsMiddleware',
]);
The module now automatically handles all CORS requests.
While the service can be configured somewhat using config/cors.php
, some more exotic things such as regular
expressions for allowed origins cannot. If you need to, you can provide this custom functionality yourself:
CorsService
and override e.g. isOriginAllowed()
CorsServiceProvider
and override registerBindings()
, then register your own service class insteadPlease read the guidelines.
Clone the project and install its dependencies by running:
composer install
Run the following command to run the test suite:
composer test
See LICENSE.