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() 检查属性是否已设置，即已定义且不为空。 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://yiiframework.cn/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 数组

方法参数
返回值 混合

方法返回值
抛出 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 字符串

属性名
返回值 混合

属性值
抛出 yii\base\UnknownPropertyException

如果属性未定义
抛出 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() public method

定义于: yii\base\BaseObject::__isset()

检查属性是否已设置，即已定义且不为空。

不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 isset($object->property) 时会隐式调用。

注意，如果属性未定义，将返回 false。

另请参阅 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name 字符串

属性名称或事件名称
返回值 boolean

命名的属性是否已设置（不为 null）。

 

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

定义于: yii\base\BaseObject::__set()

设置对象属性的值。

不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 $object->property = $value; 时会隐式调用。

另请参阅 __get().

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

属性名称或事件名称
$value 混合

属性值
抛出 yii\base\UnknownPropertyException

如果属性未定义
抛出 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() public method

定义于: yii\base\BaseObject::__unset()

将对象属性设置为 null。

不要直接调用此方法，因为它是一个 PHP 魔术方法，在执行 unset($object->property) 时会隐式调用。

注意，如果属性未定义，此方法将不执行任何操作。如果属性是只读的，它将抛出异常。

另请参阅 https://php.ac.cn/manual/en/function.unset.php.

public void __unset ( $name )
$name 字符串

属性名
抛出 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() public method

定义于: 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 method

public boolean beforeAction ( $event )
$event yii\base\ActionEvent
抛出 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() public method

定义于: yii\base\BaseObject::canGetProperty()

返回一个值，指示是否可以读取属性。

一个属性是可读的，如果

  • 类具有与指定名称关联的 getter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另请参阅 canSetProperty().

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

属性名
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

属性是否可读

 

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

定义于: yii\base\BaseObject::canSetProperty()

返回一个值，指示是否可以设置属性。

一个属性是可写的，如果

  • 类具有与指定名称关联的 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另请参阅 canGetProperty().

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

属性名
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

属性是否可写

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
自 2.0.14 起已弃用。在 PHP >=5.5 上，请使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名。

public static string className ( )
返回值 字符串

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
detach() public method

定义于: 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() public method

声明 $owner 事件的事件处理程序。

public array events ( )
返回值 数组

事件（数组键）和相应的事件处理程序方法（数组值）。

 

                public function events()
{
    return [Controller::EVENT_BEFORE_ACTION => 'beforeAction'];
}
hasMethod() public method

定义于: yii\base\BaseObject::hasMethod()

返回一个值，指示方法是否已定义。

默认实现是调用 php 函数 method_exists()。当您实现 php 魔术方法 __call() 时，您可能会覆盖此方法。

public boolean hasMethod ( $name )
$name 字符串

方法名
返回值 boolean

方法是否已定义

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public method

定义于: yii\base\BaseObject::hasProperty()

返回一个值，指示属性是否已定义。

一个属性是已定义的，如果

  • 类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另请参阅

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

属性名
$checkVars boolean

是否将成员变量视为属性
返回值 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()
{
}