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	陣列	為特定動作定義特定的 CORS 規則	yii\filters\Cors
$cors	陣列	為 CORS 請求處理的基本標頭。	yii\filters\Cors
$except	陣列	此過濾器不應套用的動作 ID 清單。	yii\base\ActionFilter
$only	陣列	此過濾器應套用的動作 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()	檢查屬性是否已設定，即已定義且非 null。	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	陣列	方法參數
return	mixed	方法回傳值
throws	yii\base\UnknownMethodException	當呼叫未知方法時

public void __construct ( $config = [] )
$config	陣列	將用於初始化物件屬性的名稱-值配對

public mixed __get ( $name )
$name	string	屬性名稱
return	mixed	屬性值
throws	yii\base\UnknownPropertyException	如果屬性未定義
throws	yii\base\InvalidCallException	如果屬性為唯寫

public boolean __isset ( $name )
$name	string	屬性名稱或事件名稱
return	boolean	具名屬性是否已設定（非 null）。

public void __set ( $name, $value )
$name	string	屬性名稱或事件名稱
$value	mixed	屬性值
throws	yii\base\UnknownPropertyException	如果屬性未定義
throws	yii\base\InvalidCallException	如果屬性為唯讀

public void __unset ( $name )
$name	string	屬性名稱
throws	yii\base\InvalidCallException	如果屬性為唯讀。

public void addCorsHeaders ( $response, $headers )
$response	yii\web\Response
$headers	陣列	已計算的 CORS 標頭

public mixed afterAction ( $action, $result )
$action	yii\base\Action	剛執行的 action。
$result	mixed	action 執行結果
return	mixed	已處理的 action 結果。

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

public void attach ( $owner )
$owner	yii\base\Component	此行為要附加到的組件。

public boolean beforeAction ( $action )
$action	yii\base\Action	要執行的 action。
return	boolean	是否應繼續執行 action。

protected string headerize ( $string )
$string	string	要轉換的字串
return	string	“標頭”格式的結果

protected string headerizeToPhp ( $string )
$string	string	要轉換的字串
return	string	“php $_SERVER 標頭”格式的結果

protected void prepareAllowHeaders ( $type, $requestHeaders, &$responseHeaders )
$type	string	我們將處理的標頭類型
$requestHeaders	陣列	用戶端請求的 CORS 標頭
$responseHeaders	陣列	傳送至用戶端的 CORS 回應標頭

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

public boolean canGetProperty ( $name, $checkVars = true )
$name	string	屬性名稱
$checkVars	boolean	是否將成員變數視為屬性
return	boolean	屬性是否可以讀取

public boolean canSetProperty ( $name, $checkVars = true )
$name	string	屬性名稱
$checkVars	boolean	是否將成員變數視為屬性
return	boolean	屬性是否可以寫入

public static string className ( )
return	string	此類別的完整限定名稱。

public array events ( )
return	陣列	事件（陣列鍵）和對應的事件處理器方法（陣列值）。

public array extractHeaders ( )
return	陣列	要處理的 CORS 標頭

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

public boolean hasMethod ( $name )
$name	string	方法名稱
return	boolean	方法是否已定義

public boolean hasProperty ( $name, $checkVars = true )
$name	string	屬性名稱
$checkVars	boolean	是否將成員變數視為屬性
return	boolean	屬性是否已定義

protected boolean isActive ( $action )
$action	yii\base\Action	正在篩選的 action
return	boolean	篩選器是否對給定的 action 處於活動狀態。

public void overrideDefaultSettings ( $action )
$action	yii\base\Action	要覆寫的 action 設定

public array prepareHeaders ( $requestHeaders )
$requestHeaders	陣列	我們偵測到的 CORS 標頭
return	陣列	準備好要傳送的 CORS 標頭