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()
.
array
The headers that have been queued so far.
bool
Whether or not the request was over SSL.
string
The request's Origin header value
\Psr\Http\Message\MessageInterface
The response object this builder is attached to.
Normalize the origin to regular expressions and put in an array format
__construct(\Psr\Http\Message\MessageInterface $response, string $origin, bool $isSsl)
Constructor.
\Psr\Http\Message\MessageInterface
$response The response object to add headers onto.
string
$origin The request's Origin header.
bool
$isSsl optional Whether or not the request was over SSL.
_normalizeDomains(array $domains)
Normalize the origin to regular expressions and put in an array format
string[]
$domains Domain names to normalize.
array
allowCredentials()
Enable cookies to be sent in CORS requests.
$this
allowHeaders(array $headers)
Allowed headers that can be sent in CORS requests.
string[]
$headers The list of headers to accept in CORS requests.
$this
allowMethods(array $methods)
Set the list of allowed HTTP Methods.
string[]
$methods The allowed HTTP methods
$this
allowOrigin(mixed $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
string|string[]
$domains The allowed domains
$this
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.
\Psr\Http\Message\MessageInterface
A new instance of the response with new headers.
exposeHeaders(array $headers)
Define the headers a client library/browser can expose to scripting
string[]
$headers The list of headers to expose CORS responses
$this
maxAge(mixed $age)
Define the max-age preflight OPTIONS requests are valid for.
int|string
$age The max-age for OPTIONS requests in seconds
$this
The headers that have been queued so far.
array
Whether or not the request was over SSL.
bool
The request's Origin header value
string
The response object this builder is attached to.
\Psr\Http\Message\MessageInterface
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Http.CorsBuilder.html