0 关注者

类 yii\filters\Cors

继承	yii\filters\Cors » yii\base\ActionFilter » yii\base\Behavior » yii\base\BaseObject
实现	yii\base\Configurable
可用版本	2.0
源代码	https://github.com/yiisoft/yii2/blob/master/framework/filters/Cors.php

Cors 过滤器实现跨域资源共享.

确保仔细阅读 CORS 的功能和限制。 CORS 不会保护您的 API，而是允许开发人员授予第三方代码访问权限（来自外部域的 AJAX 调用）。

您可以通过将其作为行为附加到控制器或模块来使用 CORS 过滤器，例如以下内容，

public function behaviors()
{
    return [
        'corsFilter' => [
            'class' => \yii\filters\Cors::class,
        ],
    ];
}

CORS 过滤器可以专门用于限制参数，例如，MDN CORS 信息

public function behaviors()
{
    return [
        'corsFilter' => [
            'class' => \yii\filters\Cors::class,
            'cors' => [
                // restrict access to
                'Origin' => ['http://www.myserver.com', 'https://www.myserver.com'],
                // Allow only POST and PUT methods
                'Access-Control-Request-Method' => ['POST', 'PUT'],
                // Allow only headers 'X-Wsse'
                'Access-Control-Request-Headers' => ['X-Wsse'],
                // Allow credentials (cookies, authorization headers, etc.) to be exposed to the browser
                'Access-Control-Allow-Credentials' => true,
                // Allow OPTIONS caching
                'Access-Control-Max-Age' => 3600,
                // Allow the X-Pagination-Current-Page header to be exposed to the browser.
                'Access-Control-Expose-Headers' => ['X-Pagination-Current-Page'],
            ],

        ],
    ];
}

有关如何将 CORS 过滤器添加到控制器的更多信息，请参阅 REST 控制器指南.

公共属性

隐藏继承的属性

属性	类型	描述	定义于
$actions	array	为特定操作定义特定 CORS 规则	yii\filters\Cors
$cors	array	为 CORS 请求处理的基本头部。	yii\filters\Cors
$except	array	此过滤器不应应用到的操作 ID 列表。	yii\base\ActionFilter
$only	array	此过滤器应应用到的操作 ID 列表。	yii\base\ActionFilter
$owner	yii\base\Component\|null	此行为的拥有者	yii\base\Behavior
$request	yii\web\Request\|null	当前请求。	yii\filters\Cors
$response	yii\web\Response\|null	要发送的响应。	yii\filters\Cors

公共方法

隐藏继承的方法

方法	描述	定义于
__call()	调用不是类方法的命名方法。	yii\base\BaseObject
__construct()	构造函数。	yii\base\BaseObject
__get()	返回对象属性的值。	yii\base\BaseObject
__isset()	检查属性是否已设置，即已定义且不为空。	yii\base\BaseObject
__set()	设置对象属性的值。	yii\base\BaseObject
__unset()	将对象属性设置为 null。	yii\base\BaseObject
addCorsHeaders()	向响应添加 CORS 头部。	yii\filters\Cors
afterAction()	此方法在操作执行后立即调用。	yii\base\ActionFilter
afterFilter()		yii\base\ActionFilter
attach()	将行为对象附加到组件。	yii\base\ActionFilter
beforeAction()	此方法在要执行的操作之前立即调用（在所有可能的过滤器之后）。您可以覆盖此方法以对操作进行最后一分钟的准备。	yii\filters\Cors
beforeFilter()		yii\base\ActionFilter
canGetProperty()	返回一个值，指示是否可以读取属性。	yii\base\BaseObject
canSetProperty()	返回一个值，指示是否可以设置属性。	yii\base\BaseObject
className()	返回此类的完全限定名称。	yii\base\BaseObject
detach()	从组件中分离行为对象。	yii\base\ActionFilter
events()	为 $owner 的事件声明事件处理程序。	yii\base\Behavior
extractHeaders()	从请求中提取 CORS 头部。	yii\filters\Cors
hasMethod()	返回一个值，指示是否定义了方法。	yii\base\BaseObject
hasProperty()	返回一个值，指示是否定义了属性。	yii\base\BaseObject
init()	初始化对象。	yii\base\BaseObject
overrideDefaultSettings()	覆盖特定操作的设置。	yii\filters\Cors
prepareHeaders()	为每个 CORS 头部创建特定的响应。	yii\filters\Cors

受保护的方法

隐藏继承的方法

方法	描述	定义于
getActionId()	通过将 yii\base\Action::$uniqueId 转换为相对于模块的 ID 来返回操作 ID。	yii\base\ActionFilter
headerize()	将任何字符串（包括带有 HTTP 前缀的 PHP 头部）转换为头部格式。	yii\filters\Cors
headerizeToPhp()	将任何字符串（包括带有 HTTP 前缀的 PHP 头部）转换为头部格式。	yii\filters\Cors
isActive()	返回一个值，指示过滤器对给定操作是否处于活动状态。	yii\base\ActionFilter
prepareAllowHeaders()	处理经典 CORS 请求以避免重复代码。	yii\filters\Cors

属性详细信息

隐藏继承的属性

$actions 公共属性

为特定操作定义特定 CORS 规则

public array $actions = []

$cors 公共属性

为 CORS 请求处理的基本头部。

public array $cors = [
    'Origin' => [
        '*',
    ],
    'Access-Control-Request-Method' => [
        'GET',
        'POST',
        'PUT',
        'PATCH',
        'DELETE',
        'HEAD',
        'OPTIONS',
    ],
    'Access-Control-Request-Headers' => [
        '*',
    ],
    'Access-Control-Allow-Credentials' => null,
    'Access-Control-Max-Age' => 86400,
    'Access-Control-Expose-Headers' => [],
]

$request 公共属性

当前请求。如果未设置，则将使用 request 应用组件。

public yii\web\Request|null $request = null

$response 公共属性

要发送的响应。如果未设置，则将使用 response 应用组件。

public yii\web\Response|null $response = null

方法详情

隐藏继承的方法

__call() 公共方法

定义于： yii\base\BaseObject::__call()

调用不是类方法的命名方法。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时会隐式调用。

public mixed __call ( $name, $params )
$name	string	方法名
$params	array	方法参数
返回值	mixed	方法返回值
抛出异常	yii\base\UnknownMethodException	调用未知方法时

public void __construct ( $config = [] )
$config	array	将用于初始化对象属性的名称-值对

public mixed __get ( $name )
$name	string	属性名
返回值	mixed	属性值
抛出异常	yii\base\UnknownPropertyException	如果未定义属性
抛出异常	yii\base\InvalidCallException	如果属性是只写的

public boolean __isset ( $name )
$name	string	属性名或事件名
返回值	boolean	命名的属性是否已设置（不为空）。

public void __set ( $name, $value )
$name	string	属性名或事件名
$value	mixed	属性值
抛出异常	yii\base\UnknownPropertyException	如果未定义属性
抛出异常	yii\base\InvalidCallException	如果属性是只读的

public void __unset ( $name )
$name	string	属性名
抛出异常	yii\base\InvalidCallException	如果属性是只读的。

public void addCorsHeaders ( $response, $headers )
$response	yii\web\Response
$headers	array	已计算的 CORS 头部

public mixed afterAction ( $action, $result )
$action	yii\base\Action	刚刚执行的动作。
$result	mixed	动作执行结果
返回值	mixed	已处理的动作结果。

public void afterFilter ( $event )
$event	yii\base\ActionEvent

public void attach ( $owner )
$owner	yii\base\Component	将要附加此行为的组件。

public boolean beforeAction ( $action )
$action	yii\base\Action	要执行的操作。
返回值	boolean	操作是否应该继续执行。

protected string headerize ( $string )
$string	string	要转换的字符串
返回值	string	"header" 格式的结果

protected string headerizeToPhp ( $string )
$string	string	要转换的字符串
返回值	string	"php $_SERVER header" 格式的结果

protected void prepareAllowHeaders ( $type, $requestHeaders, &$responseHeaders )
$type	string	我们要处理的标题类型
$requestHeaders	array	客户端请求的 CORS 标头
$responseHeaders	array	发送给客户端的 CORS 响应标头

public array prepareHeaders ( $requestHeaders )
$requestHeaders	array	我们检测到的 CORS 标头
返回值	array	准备发送的 CORS 标头

public void beforeFilter ( $event )
$event	yii\base\ActionEvent

public boolean canGetProperty ( $name, $checkVars = true )
$name	string	属性名
$checkVars	boolean	是否将成员变量视为属性
返回值	boolean	该属性是否可读

public boolean canSetProperty ( $name, $checkVars = true )
$name	string	属性名
$checkVars	boolean	是否将成员变量视为属性
返回值	boolean	该属性是否可写

public static string className ( )
返回值	string	此类的完全限定名称。

public array events ( )
返回值	array	事件（数组键）和相应的事件处理程序方法（数组值）。

public array extractHeaders ( )
返回值	array	要处理的 CORS 标头

protected string getActionId ( $action )
$action	yii\base\Action

public boolean hasMethod ( $name )
$name	string	方法名
返回值	boolean	该方法是否已定义

public boolean hasProperty ( $name, $checkVars = true )
$name	string	属性名
$checkVars	boolean	是否将成员变量视为属性
返回值	boolean	该属性是否已定义

protected boolean isActive ( $action )
$action	yii\base\Action	正在过滤的动作
返回值	boolean	过滤器是否对给定动作有效。

public void overrideDefaultSettings ( $action )
$action	yii\base\Action	要覆盖的动作设置