https://github.com/fruitcake/php-cors

CORS (Cross-Origin Resource Sharing) for your Symfony/Laravel requests
https://github.com/fruitcake/php-cors

cors hacktoberfest laravel php symfony

Last synced: 3 days ago
JSON representation

CORS (Cross-Origin Resource Sharing) for your Symfony/Laravel requests

• Host: GitHub
• URL: https://github.com/fruitcake/php-cors
• Owner: fruitcake
• License: mit
• Created: 2022-02-18T17:08:22.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-11-19T11:35:11.000Z (about 1 month ago)
• Last Synced: 2024-12-13T17:22:31.979Z (9 days ago)
• Topics: cors, hacktoberfest, laravel, php, symfony
• Language: PHP
• Homepage:
• Size: 134 KB
• Stars: 250
• Watchers: 4
• Forks: 17
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# CORS for PHP (using the Symfony HttpFoundation)

[![Unit Tests](https://github.com/fruitcake/php-cors/actions/workflows/run-tests.yml/badge.svg)](https://github.com/fruitcake/php-cors/actions)

[![PHPStan Level 9](https://img.shields.io/badge/PHPStan-Level%209-blue)](https://github.com/fruitcake/php-cors/actions)

[![Code Coverage](https://img.shields.io/badge/CodeCoverage-100%25-brightgreen)](https://github.com/fruitcake/php-cors/actions/workflows/run-coverage.yml)

[![Packagist License](https://img.shields.io/badge/Licence-MIT-blue)](http://choosealicense.com/licenses/mit/)

[![Latest Stable Version](https://img.shields.io/packagist/v/fruitcake/php-cors?label=Stable)](https://packagist.org/packages/fruitcake/php-cors)

[![Total Downloads](https://img.shields.io/packagist/dt/fruitcake/php-cors?label=Downloads)](https://packagist.org/packages/fruitcake/php-cors)

[![Fruitcake](https://img.shields.io/badge/Powered%20By-Fruitcake-b2bc35.svg)](https://fruitcake.nl/)

Library and middleware enabling cross-origin resource sharing for your

http-{foundation,kernel} using application. It attempts to implement the

[W3C Recommendation] for cross-origin resource sharing.

[W3C Recommendation]: http://www.w3.org/TR/cors/

> Note: This is a standalone fork of https://github.com/asm89/stack-cors and is compatible with the options for CorsService.

## Installation

Require `fruitcake/php-cors` using composer.

## Usage

This package can be used as a library. You can use it in your framework using:

 - [Stack middleware](http://stackphp.com/): https://github.com/asm89/stack-cors

 - [Laravel](https://laravel.com): https://github.com/fruitcake/laravel-cors

 

### Options

| Option                 | Description                                                | Default value |

|------------------------|------------------------------------------------------------|---------------|

| allowedMethods         | Matches the request method.                                | `[]`          |

| allowedOrigins         | Matches the request origin.                                | `[]`          |

| allowedOriginsPatterns | Matches the request origin with `preg_match`.              | `[]`          |

| allowedHeaders         | Sets the Access-Control-Allow-Headers response header.     | `[]`          |

| exposedHeaders         | Sets the Access-Control-Expose-Headers response header.    | `[]`          |

| maxAge                 | Sets the Access-Control-Max-Age response header.           | `0`           |

| 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. A wildcard in allowedOrigins will be converted to a pattern.

If `['*']` is provided to _allowedMethods_, _allowedOrigins_ or _allowedHeaders_ all methods / origins / headers are allowed.

> Note: Allowing a single static origin will improve cacheability.

### Example: using the library

```php

 ['x-allowed-header', 'x-other-allowed-header'],

    'allowedMethods'         => ['DELETE', 'GET', 'POST', 'PUT'],

    'allowedOrigins'         => ['http://localhost', 'https://*.example.com'],

    'allowedOriginsPatterns' => ['/localhost:\d/'],

    'exposedHeaders'         => ['Content-Encoding'],

    'maxAge'                 => 0,

    'supportsCredentials'    => false,

]);

$cors->addActualRequestHeaders(Response $response, $origin);

$cors->handlePreflightRequest(Request $request);

$cors->isActualRequestAllowed(Request $request);

$cors->isCorsRequest(Request $request);

$cors->isPreflightRequest(Request $request);

```

## License

Released under the MIT License, see [LICENSE](LICENSE).

> This package is split-off from https://github.com/asm89/stack-cors and developed as stand-alone library since 2022