Download the PHP package tuupola/cors-middleware without Composer
On this page you can find all versions of the php package tuupola/cors-middleware. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tuupola/cors-middleware
More information about tuupola/cors-middleware
Files in tuupola/cors-middleware
Package cors-middleware
Short Description PSR-7 and PSR-15 CORS middleware
License MIT
Homepage https://github.com/tuupola/cors-middleware
Informations about the package cors-middleware
PSR-7 and PSR-15 CORS Middleware
This middleware implements Cross-origin resource sharing. It supports both PSR-7 style doublepass and PSR-15 middleware standards. It has been tested with Slim Framework and Zend Expressive. Internally the middleware uses neomerx/cors-psr7 library for heavy lifting.
Install
Install using composer.
Usage
Documentation assumes you have working knowledge of CORS. There are no mandatory parameters. If you are using Zend Expressive skeleton middlewares are added to file called config/pipeline.php
. Note that you must disable the default ImplicitOptionsMiddleware
for this middleware to work.
Slim Framework does not have specified config files. Otherwise adding the middleware is similar with previous.
Rest of the examples use Slim Framework.
If called without any parameters the following defaults are used.
However, you most likely want to change some of the defaults. For example if developing a REST API which supports caching and conditional requests you could use the following.
Parameters
Origin
By default all origins are allowed. You can limit allowed origins by passing them as an array.
You can also use wildcards to define multiple origins at once. Wildcards are matched by using the fnmatch() function.
Methods
Methods can be passed either as an array or a callable which returns an array. Below example is for Zend Expressive where value of methods
is dynamic depending on the requested route.
Same thing for Slim 3. This assumes you have not defined the OPTIONS
route.
Logger
The optional logger
parameter allows you to pass in a PSR-3 compatible logger to help with debugging or other application logging needs.
Error
Error is called when CORS request fails. It receives last error message in arguments. This can be used for example to create application/json
responses when CORS request fails.
Server origin
If your same-origin requests contain an unnecessary Origin
header, they might get blocked in case the server origin is not among the allowed origins already. In this case you can use the optional origin.server
parameter to specify the origin of the server.
Testing
You can run tests either manually or automatically on every code change. Automatic tests require entr to work.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
License
The MIT License (MIT). Please see License File for more information.
All versions of cors-middleware with dependencies
neomerx/cors-psr7 Version ^2.0|^3.0
psr/http-message Version ^1.0.1
psr/http-server-middleware Version ^1.0
tuupola/callable-handler Version ^1.0
tuupola/http-factory Version ^1.0.2