Lumen CORS

Cross-Origin Resource Sharing (CORS) module for the Lumen PHP framework.

NOTE: Branch 5.3 uses Lumen framework 5.3. Only bug-fixes 1.7.X should be tagged in the 5.3 branch.

Requirements

PHP 5.6 or newer
Composer
Lumen 5.4 or newer

Usage

Installation

Run the following command to install the package through Composer:

composer require nordsoftware/lumen-cors

Configure

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:

allow_origins array Origins that are allowed to perform requests, defaults to an empty array
allow_methods array HTTP methods that are allowed, defaults to an empty array
allow_headers array HTTP headers that are allowed, defaults to an empty array
allow_credentials boolean Whether or not the response can be exposed when credentials are present, defaults to false
expose_headers array HTTP headers that are allowed to be exposed to the web browser, defaults to an empty array
max_age integer Indicates how long preflight request can be cached, defaults to 0
origin_not_allowed callable Creates the response if the origin is not allowed
method_not_allowed callable Creates the response if the method is not allowed
header_not_allowed callable Creates the response if the header is not allowed

Bootstrapping

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.

Contributing

Please read the guidelines.

Running tests

Clone the project and install its dependencies by running:

composer install

Run the following command to run the test suite:

vendor/bin/codecept run unit

License

See LICENSE.

winyatasenjaya/lumen-cors