azure-storage-common\src\Common\Models\CORS.php

Show: PublicProtectedPrivateinherited
Table of Contents
LICENSE: The MIT License (the "License") you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://github.com/azure/azure-storage-php/LICENSE

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

PHP version 5

Author
Azure Storage PHP SDK  
Category
Microsoft  
Copyright
2016 Microsoft Corporation  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  
Package
MicrosoftAzure\Storage\Common\Models  

\MicrosoftAzure\Storage\Common\Models\CORS

Package: MicrosoftAzure\Storage\Common\Models
Provides functionality and data structure for Cross-Origin Resource Sharing rules.
Author
Azure Storage PHP SDK  
Category
Microsoft  
Copyright
2017 Microsoft Corporation  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  

Methods

methodpublic__construct(array<mixed,string> $allowedOrigins, array<mixed,string> $allowedMethods, array<mixed,string> $allowedHeaders, array<mixed,string> $exposedHeaders, integer $maxAgeInSeconds) : void

Constructor of the class.

Parameters
NameTypeDescription
$allowedOriginsarray<mixed,string>

The origin domains that are permitted to make request against the storage service via CORS.

$allowedMethodsarray<mixed,string>

The methods (HTTP request verbs) that the origin domain may use for a CORS request.

$allowedHeadersarray<mixed,string>

The request headers that the origin domain may specify on the CORS request.

$exposedHeadersarray<mixed,string>

The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

$maxAgeInSecondsinteger

The maximum amount of time that a browser should cache the preflight OPTIONS request.

methodpublicgetAllowedHeaders() : array<mixed,string>

Getter for allowedHeaders

Returns
TypeDescription
array<mixed,string>
methodpublicgetAllowedMethods() : array<mixed,string>

Getter for allowedMethods

Returns
TypeDescription
array<mixed,string>
methodpublicgetAllowedOrigins() : array<mixed,string>

Getter for allowedOrigins

Returns
TypeDescription
array<mixed,string>
methodpublicgetExposedHeaders() : array<mixed,string>

Getter for exposedHeaders

Returns
TypeDescription
array<mixed,string>
methodpublicgetMaxedAgeInSeconds() : integer

Getter for maxAgeInSeconds

Returns
TypeDescription
integer
methodpublicsetAllowedHeaders(array<mixed,string> $allowedHeaders) : void

Setter for allowedHeaders

Parameters
NameTypeDescription
$allowedHeadersarray<mixed,string>

the allowed headers to be set.

methodpublicsetAllowedMethods(array<mixed,string> $allowedMethods) : void

Setter for allowedMethods

Parameters
NameTypeDescription
$allowedMethodsarray<mixed,string>

the allowed methods to be set.

methodpublicsetAllowedOrigins(array<mixed,string> $allowedOrigins) : void

Setter for allowedOrigins

Parameters
NameTypeDescription
$allowedOriginsarray<mixed,string>

the allowed origins to be set.

methodpublicsetExposedHeaders(array<mixed,string> $exposedHeaders) : void

Setter for exposedHeaders

Parameters
NameTypeDescription
$exposedHeadersarray<mixed,string>

the exposed headers to be set.

methodpublicsetMaxedAgeInSeconds(integer $maxAgeInSeconds) : void

Setter for maxAgeInSeconds

Parameters
NameTypeDescription
$maxAgeInSecondsinteger

the max age in seconds to be set.

methodpublictoArray() : array

Converts this object to array with XML tags

Returns
TypeDescription
array
Documentation was generated by phpDocumentor 2.9.1.