0 关注者

类 yii\filters\HostControl

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

HostControl 提供对请求主机名的简单控制。

此过滤器可防止 '主机头' 攻击，仅允许指定主机名的操作执行。

应用配置示例

return [
    'as hostControl' => [
        'class' => 'yii\filters\HostControl',
        'allowedHosts' => [
            'example.com',
            '*.example.com',
        ],
    ],
    // ...
];

控制器配置示例

use yii\web\Controller;
use yii\filters\HostControl;

class SiteController extends Controller
{
    public function behaviors()
    {
        return [
            'hostControl' => [
                'class' => HostControl::class,
                'allowedHosts' => [
                    'example.com',
                    '*.example.com',
                ],
            ],
        ];
    }

    // ...
}

注意：限制允许主机名的最佳方法是使用 Web 服务器的“虚拟主机”配置。仅当此配置不可用或已损坏时，才应使用此过滤器。

公共属性

隐藏继承的属性

属性	类型	描述	定义于
$allowedHosts	数组\|闭包\|null	允许的主机名列表。	yii\filters\HostControl
$denyCallback	可调用\|null	如果当前主机与 $allowedHosts 不匹配，则将调用此回调。	yii\filters\HostControl
$except	数组	此过滤器不应应用于的操作 ID 列表。	yii\base\ActionFilter
$fallbackHostInfo	字符串\|null	当 Request::$hostInfo 无效时使用的回退主机信息（例如 `https://yiiframework.cn`）。	yii\filters\HostControl
$only	数组	此过滤器应应用于的操作 ID 列表。	yii\base\ActionFilter
$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
afterAction()	此方法在操作执行后立即调用。	yii\base\ActionFilter
afterFilter()		yii\base\ActionFilter
attach()	将行为对象附加到组件。	yii\base\ActionFilter
beforeAction()	此方法在要执行操作之前立即调用（在所有可能的过滤器之后）。您可以覆盖此方法来对操作进行最后一刻的准备。	yii\filters\HostControl
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
hasMethod()	返回一个值，指示方法是否已定义。	yii\base\BaseObject
hasProperty()	返回一个值，指示属性是否已定义。	yii\base\BaseObject
init()	初始化对象。	yii\base\BaseObject

受保护的方法

隐藏继承的方法

方法	描述	定义于
denyAccess()	拒绝访问。	yii\filters\HostControl
getActionId()	通过将 yii\base\Action::$uniqueId 转换为相对于模块的 ID 来返回操作 ID。	yii\base\ActionFilter
isActive()	返回一个值，指示过滤器对于给定操作是否处于活动状态。	yii\base\ActionFilter

属性详细信息

隐藏继承的属性

$allowedHosts 公共属性

允许的主机名列表。每个主机都可以指定为通配符模式。例如

[
    'example.com',
    '*.example.com',
]

此字段可以指定为以下签名的 PHP 回调

function (\yii\base\Action $action) {
    //return array of strings
}

其中 $action 是当前操作对象。

如果未设置此字段 - 则不会执行主机名检查。

public 数组|闭包|null $allowedHosts = null

$denyCallback 公共属性

如果当前主机与 $allowedHosts 不匹配，则将调用此回调。如果未设置，则将调用 denyAccess()。

回调的签名应如下所示

function (\yii\base\Action $action)

其中 $action 是当前操作对象。

注意：在实现您自己的主机拒绝处理时，请确保避免使用当前请求的主机名、创建绝对 URL 链接、缓存页面部分等。

public 可调用|null $denyCallback = null

$fallbackHostInfo 公共属性

当 Request::$hostInfo 无效时使用的回退主机信息（例如 https://yiiframework.cn）。此值将在调用 $denyCallback 之前替换 Request::$hostInfo，以确保无效的主机不会用于进一步处理。您可以将其设置为 null 以保持 Request::$hostInfo 不变。默认值为空字符串（这将导致创建相对 URL 而不是绝对 URL）。

另请参阅 yii\web\Request::getHostInfo()。

public 字符串|null $fallbackHostInfo = ''

方法详细信息

隐藏继承的方法

__call() 公共方法

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

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

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

public 混合 __call ( $name, $params )
$name	字符串	方法名
$params	数组	方法参数
返回值	混合	方法的返回值
抛出	yii\base\UnknownMethodException	调用未知方法时

public void __construct ( $config = [] )
$config	数组	将用于初始化对象属性的键值对

public 混合 __get ( $name )
$name	字符串	属性名
返回值	混合	属性值
抛出	yii\base\UnknownPropertyException	如果属性未定义
抛出	yii\base\InvalidCallException	如果属性是只写属性

public 布尔值 __isset ( $name )
$name	字符串	属性名或事件名
返回值	布尔值	命名的属性是否已设置（非空）。

public void __set ( $name, $value )
$name	字符串	属性名或事件名
$value	混合	属性值
抛出	yii\base\UnknownPropertyException	如果属性未定义
抛出	yii\base\InvalidCallException	如果属性是只读属性

public void __unset ( $name )
$name	字符串	属性名
抛出	yii\base\InvalidCallException	如果属性是只读属性。

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

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

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

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

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

protected 布尔型 isActive ( $action )
$action	yii\base\Action	正在过滤的操作
返回值	布尔值	过滤器对于给定操作是否处于活动状态。

public 布尔型 canGetProperty ( $name, $checkVars = true )
$name	字符串	属性名
$checkVars	布尔值	是否将成员变量视为属性
返回值	布尔值	该属性是否可读

public 布尔型 canSetProperty ( $name, $checkVars = true )
$name	字符串	属性名
$checkVars	布尔值	是否将成员变量视为属性
返回值	布尔值	该属性是否可写

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

protected void denyAccess ( $action )
$action	yii\base\Action	要执行的操作。
抛出	yii\web\NotFoundHttpException

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

protected 字符串 getActionId ( $action )
$action	yii\base\Action

public 布尔型 hasMethod ( $name )
$name	字符串	方法名
返回值	布尔值	该方法是否已定义

public 布尔型 hasProperty ( $name, $checkVars = true )
$name	字符串	属性名
$checkVars	布尔值	是否将成员变量视为属性
返回值	布尔值	该属性是否已定义