0 追蹤者

類別 yii\filters\VerbFilter

所有類別 | 屬性 | 方法
繼承關係yii\filters\VerbFilter » yii\base\Behavior » yii\base\BaseObject
實作yii\base\Configurable
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/filters/VerbFilter.php

VerbFilter 是一個動作過濾器，會依據 HTTP 請求方法進行過濾。

它允許為每個動作定義允許的 HTTP 請求方法，並在方法不允許時拋出 HTTP 405 錯誤。

若要使用 VerbFilter，請在您的控制器類別的 behaviors() 方法中宣告它。例如，以下宣告將為 REST CRUD 動作定義一組典型的允許請求方法。

public function behaviors()
{
    return [
        'verbs' => [
            'class' => \yii\filters\VerbFilter::class,
            'actions' => [
                'index'  => ['GET'],
                'view'   => ['GET'],
                'create' => ['GET', 'POST'],
                'update' => ['GET', 'PUT', 'POST'],
                'delete' => ['POST', 'DELETE'],
            ],
        ],
    ];
}

另請參閱 https://tools.ietf.org/html/rfc2616#section-14.7。

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$actions 陣列 此屬性定義每個動作允許的請求方法。 yii\filters\VerbFilter
$owner yii\base\Component|null 此行為的所有者 yii\base\Behavior

公共方法

隱藏繼承的方法

方法 描述 定義於
__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
attach() 將行為物件附加到組件。 yii\base\Behavior
beforeAction() yii\filters\VerbFilter
canGetProperty() 傳回一個值，指示屬性是否可讀取。 yii\base\BaseObject
canSetProperty() 傳回一個值，指示屬性是否可設定。 yii\base\BaseObject
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
detach() 從組件分離行為物件。 yii\base\Behavior
events() 宣告 $owner 事件的事件處理常式。 yii\filters\VerbFilter
hasMethod() 傳回一個值，指示方法是否已定義。 yii\base\BaseObject
hasProperty() 傳回一個值，指示屬性是否已定義。 yii\base\BaseObject
init() 初始化物件。 yii\base\BaseObject

屬性詳細資訊

隱藏繼承的屬性

$actions 公共屬性

此屬性定義每個動作允許的請求方法。對於每個僅應支援有限請求方法集的動作，您需要新增一個條目，其中動作 ID 作為陣列鍵，而允許的方法陣列（例如 GET、HEAD、PUT）作為值。如果未列出動作，則所有請求方法都被視為允許。

您可以使用 '*' 代表所有動作。當明確指定動作時，它優先於 '*' 給定的規範。

另請參閱 https://yii.dev.org.tw/doc/guide/2.0/en/structure-controllers#action-ids 例如，`php [ 'create' => ['GET', 'POST'], 'update' => ['GET', 'PUT', 'POST'], 'delete' => ['POST', 'DELETE'], 'author-comment' => ['POST', 'DELETE'], '*' => ['GET'], ] `。

public array $actions = []

方法詳細資訊

隱藏繼承的方法

__call() 公共方法

定義於： yii\base\BaseObject::__call()

呼叫未定義為類別方法的具名方法。

不要直接呼叫此方法，因為它是 PHP 魔術方法，當調用未知方法時，它會被隱式呼叫。

public mixed __call ( $name, $params )
$name 字串

方法名稱
$params 陣列

方法參數
return mixed

方法傳回值
throws yii\base\UnknownMethodException

當呼叫未知方法時

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() 公共方法

定義於： yii\base\BaseObject::__construct()

建構子。

預設實作執行兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()。

如果在子類別中覆寫此方法，建議

  • 建構子的最後一個參數是組態陣列，如這裡的 $config。
  • 在建構子的末尾呼叫父類別實作。
public void __construct ( $config = [] )
$config 陣列

將用於初始化物件屬性的名稱-值配對

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() 公共方法

定義於： yii\base\BaseObject::__get()

傳回物件屬性的值。

不要直接呼叫此方法，因為它是 PHP 魔術方法，當執行 $value = $object->property; 時，它會被隱式呼叫。

另請參閱 __set()。

public mixed __get ( $name )
$name 字串

屬性名稱
return mixed

屬性值
throws yii\base\UnknownPropertyException

如果屬性未定義
throws yii\base\InvalidCallException

如果屬性為唯寫

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() 公共方法

定義於： yii\base\BaseObject::__isset()

檢查屬性是否已設定，即已定義且非 null。

不要直接呼叫此方法，因為它是 PHP 魔術方法，當執行 isset($object->property) 時，它會被隱式呼叫。

請注意，如果屬性未定義，將傳回 false。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php。

public boolean __isset ( $name )
$name 字串

屬性名稱或事件名稱
return boolean

具名屬性是否已設定（非 null）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() 公共方法

定義於： yii\base\BaseObject::__set()

設定物件屬性的值。

不要直接呼叫此方法，因為它是 PHP 魔術方法，當執行 $object->property = $value; 時，它會被隱式呼叫。

另請參閱 __get()。

public void __set ( $name, $value )
$name 字串

屬性名稱或事件名稱
$value mixed

屬性值
throws yii\base\UnknownPropertyException

如果屬性未定義
throws yii\base\InvalidCallException

如果屬性為唯讀

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() 公共方法

定義於： yii\base\BaseObject::__unset()

將物件屬性設定為 null。

不要直接呼叫此方法，因為它是 PHP 魔術方法，當執行 unset($object->property) 時，它會被隱式呼叫。

請注意，如果屬性未定義，此方法將不執行任何操作。 如果屬性為唯讀，它將拋出例外。

另請參閱 https://php.dev.org.tw/manual/en/function.unset.php。

public void __unset ( $name )
$name 字串

屬性名稱
throws yii\base\InvalidCallException

如果屬性為唯讀。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
attach() 公共方法

定義於： yii\base\Behavior::attach()

將行為物件附加到組件。

預設實作將設定 $owner 屬性，並附加在 events() 中宣告的事件處理常式。如果您覆寫此方法，請確保呼叫父類別實作。

public void attach ( $owner )
$owner yii\base\Component

要附加此行為的組件。

 

                public function attach($owner)
{
    $this->owner = $owner;
    foreach ($this->events() as $event => $handler) {
        $this->_attachedEvents[$event] = $handler;
        $owner->on($event, is_string($handler) ? [$this, $handler] : $handler);
    }
}
beforeAction() 公共方法

public boolean beforeAction ( $event )
$event yii\base\ActionEvent
throws yii\web\MethodNotAllowedHttpException

當請求方法不允許時。

 

                public function beforeAction($event)
{
    $action = $event->action->id;
    if (isset($this->actions[$action])) {
        $verbs = $this->actions[$action];
    } elseif (isset($this->actions['*'])) {
        $verbs = $this->actions['*'];
    } else {
        return $event->isValid;
    }
    $verb = Yii::$app->getRequest()->getMethod();
    $allowed = array_map('strtoupper', $verbs);
    if (!in_array($verb, $allowed)) {
        $event->isValid = false;
        // https://tools.ietf.org/html/rfc2616#section-14.7
        Yii::$app->getResponse()->getHeaders()->set('Allow', implode(', ', $allowed));
        throw new MethodNotAllowedHttpException('Method Not Allowed. This URL can only handle the following request methods: ' . implode(', ', $allowed) . '.');
    }
    return $event->isValid;
}
canGetProperty() 公共方法

定義於： yii\base\BaseObject::canGetProperty()

傳回一個值，指示屬性是否可讀取。

如果滿足以下條件，屬性是可讀取的

  • 類別具有與指定名稱關聯的 getter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱 canSetProperty()。

public boolean canGetProperty ( $name, $checkVars = true )
$name 字串

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

屬性是否可讀取

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() 公共方法

定義於： yii\base\BaseObject::canSetProperty()

傳回一個值，指示屬性是否可設定。

如果滿足以下條件，屬性是可寫入的

  • 類別具有與指定名稱關聯的 setter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱 canGetProperty()。

public boolean canSetProperty ( $name, $checkVars = true )
$name 字串

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

屬性是否可寫入

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() 公共靜態方法
自 2.0.14 版本起已棄用。在 PHP >=5.5 上，請改用 ::class。

定義於： yii\base\BaseObject::className()

傳回此類別的完整限定名稱。

public static string className ( )
return 字串

此類別的完整限定名稱。

 

                public static function className()
{
    return get_called_class();
}
detach() 公共方法

定義於： yii\base\Behavior::detach()

從組件分離行為物件。

預設實作將取消設定 $owner 屬性，並分離在 events() 中宣告的事件處理常式。如果您覆寫此方法，請確保呼叫父類別實作。

public void detach ( )

                public function detach()
{
    if ($this->owner) {
        foreach ($this->_attachedEvents as $event => $handler) {
            $this->owner->off($event, is_string($handler) ? [$this, $handler] : $handler);
        }
        $this->_attachedEvents = [];
        $this->owner = null;
    }
}
events() 公共方法

宣告 $owner 事件的事件處理常式。

public array events ( )
return 陣列

事件（陣列鍵）和對應的事件處理常式方法（陣列值）。

 

                public function events()
{
    return [Controller::EVENT_BEFORE_ACTION => 'beforeAction'];
}
hasMethod() 公共方法

定義於： yii\base\BaseObject::hasMethod()

傳回一個值，指示方法是否已定義。

預設實作是對 php 函數 method_exists() 的呼叫。當您實作 php 魔術方法 __call() 時，您可以覆寫此方法。

public boolean hasMethod ( $name )
$name 字串

方法名稱
return boolean

方法是否已定義

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() 公共方法

定義於： yii\base\BaseObject::hasProperty()

傳回一個值，指示屬性是否已定義。

如果滿足以下條件，則屬性已定義

  • 類別具有與指定名稱關聯的 getter 或 setter 方法（在這種情況下，屬性名稱不區分大小寫）；
  • 類別具有具有指定名稱的成員變數（當 $checkVars 為 true 時）；

另請參閱

public boolean hasProperty ( $name, $checkVars = true )
$name 字串

屬性名稱
$checkVars boolean

是否將成員變數視為屬性
return boolean

屬性是否已定義

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() 公共方法

定義於： yii\base\BaseObject::init()

初始化物件。

在物件使用給定的組態初始化後，此方法會在建構子的末尾被調用。

public void init ( )

                public function init()
{
}