Class CorsBuilder
A builder object that assists in defining Cross Origin Request related headers.
Each of the methods in this object provide a fluent interface. Once you've
set all the headers you want to use, the build() method can be used to return
a modified Response.
It is most convenient to get this object via Request::cors().
Properties summary
-
$_headersprotectedarrayThe headers that have been queued so far. -
$_isSslprotectedbooleanWhether or not the request was over SSL. -
$_originprotectedstringThe request's Origin header value -
$_responseprotectedPsr\Http\Message\MessageInterfaceThe response object this builder is attached to.
Method Summary
-
__construct() public
Constructor. -
_normalizeDomains() protected
Normalize the origin to regular expressions and put in an array format -
allowCredentials() public
Enable cookies to be sent in CORS requests. -
allowHeaders() public
Whitelist headers that can be sent in CORS requests. -
allowMethods() public
Set the list of allowed HTTP Methods. -
allowOrigin() public
Set the list of allowed domains. -
build() public
Apply the queued headers to the response. -
exposeHeaders() public
Define the headers a client library/browser can expose to scripting -
maxAge() public
Define the max-age preflight OPTIONS requests are valid for.
Method Detail
__construct() public ¶
__construct( Psr\Http\Message\MessageInterface $response , string $origin , boolean $isSsl = false )
Constructor.
Parameters
- Psr\Http\Message\MessageInterface $response
- The response object to add headers onto.
- string $origin
- The request's Origin header.
- boolean $isSsl optional false
- Whether or not the request was over SSL.
_normalizeDomains() protected ¶
_normalizeDomains( string[] $domains )
Normalize the origin to regular expressions and put in an array format
Parameters
- string[] $domains
- Domain names to normalize.
Returns
allowCredentials() public ¶
allowCredentials( )
Enable cookies to be sent in CORS requests.
Returns
$this
allowHeaders() public ¶
allowHeaders( array $headers )
Whitelist headers that can be sent in CORS requests.
Parameters
- array $headers
- The list of headers to accept in CORS requests.
Returns
$this
allowMethods() public ¶
allowMethods( array $methods )
Set the list of allowed HTTP Methods.
Parameters
- array $methods
- The allowed HTTP methods
Returns
$this
allowOrigin() public ¶
allowOrigin( string|string[] $domains )
Set the list of allowed domains.
Accepts a string or an array of domains that have CORS enabled.
You can use *.example.com wildcards to accept subdomains, or * to allow all domains
Parameters
- string|string[] $domains
- The allowed domains
Returns
$this
build() public ¶
build( )
Apply the queued headers to the response.
If the builder has no Origin, or if there are no allowed domains, or if the allowed domains do not match the Origin header no headers will be applied.
Returns
A new instance of the response with new headers.
exposeHeaders() public ¶
exposeHeaders( array $headers )
Define the headers a client library/browser can expose to scripting
Parameters
- array $headers
- The list of headers to expose CORS responses
Returns
$this
Properties detail
$_response ¶
The response object this builder is attached to.