0 关注者

类 yii\web\UrlManager

继承关系yii\web\UrlManager » yii\base\Component » yii\base\BaseObject
实现接口yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/web/UrlManager.php

UrlManager 处理 HTTP 请求解析以及基于一组规则创建 URL。

UrlManager 默认情况下配置为 yii\base\Application 中的一个应用组件。您可以通过 Yii::$app->urlManager 访问该实例。

您可以通过在应用配置的 components 下添加一个数组来修改其配置,如下例所示

'urlManager' => [
    'enablePrettyUrl' => true,
    'rules' => [
        // your rules go here
    ],
    // ...
]

规则是实现 yii\web\UrlRuleInterface 接口的类,默认情况下为 yii\web\UrlRule。对于嵌套规则,还有一个 yii\web\GroupUrlRule 类。

有关 UrlManager 的更多详细信息和使用信息,请参阅 路由指南文章

公有属性

隐藏继承属性

属性 类型 描述 定义于
$baseUrl string createUrl() 用于追加到创建的 URL 的基本 URL。 yii\web\UrlManager
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$cache yii\caching\CacheInterface|数组|字符串|布尔值 缓存对象或缓存对象的应用组件 ID。 yii\web\UrlManager
$cacheKey string 缓存规则的缓存键 yii\web\UrlManager
$enablePrettyUrl boolean 是否启用美观的 URL。 yii\web\UrlManager
$enableStrictParsing boolean 是否启用严格解析。 yii\web\UrlManager
$hostInfo string 主机信息(例如 https://www.example.com),由 createAbsoluteUrl() 用于追加到创建的 URL。 yii\web\UrlManager
$normalizer yii\web\UrlNormalizer|数组|字符串|false 此 UrlManager 使用的 yii\web\UrlNormalizer 的配置。 yii\web\UrlManager
$routeParam string 路由的 GET 参数名称。 yii\web\UrlManager
$ruleConfig array URL 规则的默认配置。 yii\web\UrlManager
$rules array $enablePrettyUrltrue 时,用于创建和解析 URL 的规则。 yii\web\UrlManager
$scriptUrl string createUrl() 用于追加到创建的 URL 的入口脚本 URL。 yii\web\UrlManager
$showScriptName boolean 是否在构造的 URL 中显示入口脚本名称。 yii\web\UrlManager
$suffix string $enablePrettyUrltrue 时使用的 URL 后缀。 yii\web\UrlManager

受保护属性

隐藏继承属性

属性 类型 描述 定义于

公有方法

隐藏继承方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后调用。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即定义且不为 null。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
addRules() 添加额外的 URL 规则。 yii\web\UrlManager
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示属性是否可读。 yii\base\Component
canSetProperty() 返回一个值,指示属性是否可写。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
createAbsoluteUrl() 使用给定的路由和查询参数创建绝对 URL。 yii\web\UrlManager
createUrl() 使用给定的路由和查询参数创建 URL。 yii\web\UrlManager
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为附加到此组件。 yii\base\Component
getBaseUrl() 返回由 createUrl() 用于追加到创建的 URL 的基本 URL。 yii\web\UrlManager
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getHostInfo() 返回由 createAbsoluteUrl() 用于追加到创建的 URL 的主机信息。 yii\web\UrlManager
getScriptUrl() 返回由 createUrl() 用于追加到创建的 URL 的入口脚本 URL。 yii\web\UrlManager
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示此组件是否定义了属性。 yii\base\Component
init() 初始化 UrlManager。 yii\web\UrlManager
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
parseRequest() 解析用户请求。 yii\web\UrlManager
setBaseUrl() 设置由 createUrl() 用于追加到创建的 URL 的基本 URL。 yii\web\UrlManager
setHostInfo() 设置由 createAbsoluteUrl() 用于追加到创建的 URL 的主机信息。 yii\web\UrlManager
setScriptUrl() 设置由 createUrl() 用于追加到创建的 URL 的入口脚本 URL。 yii\web\UrlManager
trigger() 触发事件。 yii\base\Component

受保护方法

隐藏继承方法

方法 描述 定义于
buildRules() 从给定的规则声明构建 URL 规则对象。 yii\web\UrlManager
canBeCached() 返回一个值,指示规则的 createUrl() 结果是否应缓存在内部缓存中。 yii\web\UrlManager
getBuiltRulesFromCache() 提供与 $ruleDeclarations 关联的来自缓存的构建的 URL 规则。 yii\web\UrlManager
getUrlFromCache() 如果存在,则从内部缓存获取 URL。 yii\web\UrlManager
setBuiltRulesCache() 将 $builtRules 存储到缓存中,使用 $rulesDeclaration 作为缓存键的一部分。 yii\web\UrlManager
setRuleToCache() 将规则(例如 yii\web\UrlRule)存储到内部缓存中。 yii\web\UrlManager

属性详情

隐藏继承属性

$baseUrl 公有属性

createUrl() 用于追加到创建的 URL 的基本 URL。

public 字符串 $baseUrl null
$cache 公共属性

缓存对象或缓存对象的应用组件 ID。如果不想使用应用组件,它也可以是一个用于创建 yii\caching\CacheInterface 实例的数组。如果可用,编译后的 URL 规则将通过此缓存对象进行缓存。

在创建 UrlManager 对象后,如果要更改此属性,则应仅将其分配给缓存对象。如果不想缓存 URL 规则,请将此属性设置为 falsenull

缓存条目根据缓存配置中 $defaultDuration 设置的时间存储,默认情况下是无限的。如果您的 $rules 经常更改,您可能需要调整此值。

$cacheKey 受保护属性 (自版本 2.0.8 起可用)

缓存规则的缓存键

protected 字符串 $cacheKey __CLASS__
$enablePrettyUrl 公共属性

是否启用美观的 URL。美观的 URL 允许使用路径信息来表示某些参数,而不是将所有参数都放在 URL 的查询字符串部分,从而可以生成更友好的 URL,例如“/news/Yii-is-released”,而不是“/index.php?r=news%2Fview&id=100”。

public 布尔值 $enablePrettyUrl false
$enableStrictParsing 公共属性

是否启用严格解析。如果启用了严格解析,则传入的请求 URL 必须至少与 $rules 中的一个匹配,才能被视为有效请求。否则,请求的路径信息部分将被视为请求的路由。此属性仅在 $enablePrettyUrltrue 时使用。

$hostInfo 公共属性

主机信息(例如 https://www.example.com),由 createAbsoluteUrl() 用于追加到创建的 URL。

public 字符串 $hostInfo null
$normalizer 公共属性 (自版本 2.0.10 起可用)

此 UrlManager 使用的 yii\web\UrlNormalizer 的配置。默认值为 false,这意味着将跳过规范化。如果希望启用 URL 规范化,则应手动配置此属性。例如

[
    'class' => 'yii\web\UrlNormalizer',
    'collapseSlashes' => true,
    'normalizeTrailingSlash' => true,
]
$routeParam 公共属性

路由的 GET 参数名称。此属性仅在 $enablePrettyUrlfalse 时使用。

public 字符串 $routeParam 'r'
$ruleConfig 公共属性

URL 规则的默认配置。通过 $rules 指定的单个规则配置在配置规则的相同属性时将优先。

public 数组 $ruleConfig = [
    
'class' => 'yii\web\UrlRule',
]
$rules 公共属性

$enablePrettyUrltrue 时,用于创建和解析 URL 的规则。此属性仅在 $enablePrettyUrltrue 时使用。数组中的每个元素都是用于创建单个 URL 规则的配置数组。在用于创建规则对象之前,配置将首先与 $ruleConfig 合并。

如果规则仅指定 patternroute,则可以使用特殊的快捷方式格式:'pattern' => 'route'。也就是说,可以使用键来表示模式,使用值来表示相应的路由,而不是使用配置数组。例如,'post/<id:\d+>' => 'post/view'

对于 RESTful 路由,提到的快捷方式格式还允许您指定规则应适用的 HTTP 方法。可以通过在模式前加上空格来实现。例如,'PUT post/<id:\d+>' => 'post/update'。您可以通过逗号分隔来指定多个方法,例如:'POST,PUT post/index' => 'post/create'。快捷方式格式中支持的方法为:GET、HEAD、POST、PUT、PATCH 和 DELETE。请注意,当以这种方式指定方法时,mode 将设置为 PARSING_ONLY,因此通常不会为普通的 GET 请求指定方法。

以下是 RESTful CRUD 控制器的一个示例配置

[
    'dashboard' => 'site/index',

    'POST <controller:[\w-]+>' => '<controller>/create',
    '<controller:[\w-]+>s' => '<controller>/index',

    'PUT <controller:[\w-]+>/<id:\d+>'    => '<controller>/update',
    'DELETE <controller:[\w-]+>/<id:\d+>' => '<controller>/delete',
    '<controller:[\w-]+>/<id:\d+>'        => '<controller>/view',
];

请注意,如果在创建 UrlManager 对象后修改此属性,请确保使用规则对象而不是规则配置填充数组。

public 数组 $rules = []
$scriptUrl 公共属性

createUrl() 用于追加到创建的 URL 的入口脚本 URL。

public string $scriptUrl null
$showScriptName 公共属性

是否在生成的 URL 中显示入口脚本名称。默认为 true。此属性仅在 $enablePrettyUrltrue 时使用。

public boolean $showScriptName true
$suffix 公共属性

$enablePrettyUrltrue 时使用的 URL 后缀。例如,可以使用 ".html",使 URL 看起来像是指向一个静态 HTML 页面。此属性仅在 $enablePrettyUrltrue 时使用。

public string $suffix null

方法详情

隐藏继承方法

__call() 公共方法

定义于: yii\base\Component::__call()

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

此方法将检查任何附加的行为是否具有指定名称的方法,如果可用则执行该方法。

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

public mixed __call ( $name, $params )
$name string

方法名

$params array

方法参数

返回值 mixed

方法的返回值

抛出异常 yii\base\UnknownMethodException

调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

定义于: yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后调用。

它会移除所有行为,因为它们附加到旧对象上。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公共方法

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

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()

如果此方法在子类中被重写,建议

  • 构造函数的最后一个参数是一个配置数组,如这里的 $config
  • 在构造函数的末尾调用父类的实现。
public void __construct ( $config = [] )
$config array

将用于初始化对象属性的键值对

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

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按照以下顺序检查并相应地执行

  • 由 getter 定义的属性:返回 getter 的结果
  • 行为的属性:返回行为的属性值

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

另请参阅 __set()

public mixed __get ( $name )
$name string

属性名

返回值 mixed

属性值或行为属性的值

抛出异常 yii\base\UnknownPropertyException

如果未定义属性

抛出异常 yii\base\InvalidCallException

如果属性是只写属性。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (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\Component::__isset()

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

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性返回 false

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

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

public boolean __isset ( $name )
$name string

属性名或事件名

返回值 boolean

命名属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

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

设置组件属性的值。

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性:设置属性值
  • "on xyz" 格式的事件:将处理程序附加到事件 "xyz"
  • "as xyz" 格式的行为:附加名为 "xyz" 的行为
  • 行为的属性:设置行为的属性值

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

另请参阅 __get()

public void __set ( $name, $value )
$name string

属性名或事件名

$value mixed

属性值

抛出异常 yii\base\UnknownPropertyException

如果未定义属性

抛出异常 yii\base\InvalidCallException

如果属性是只读属性。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公共方法

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

将组件属性设置为 null。

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

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

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

public void __unset ( $name )
$name string

属性名

抛出异常 yii\base\InvalidCallException

如果属性是只读属性。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
addRules() 公共方法

添加额外的 URL 规则。

此方法将调用 buildRules() 来解析给定的规则声明,然后将它们附加或插入到现有的 $rules 中。

请注意,如果 $enablePrettyUrlfalse,则此方法将不执行任何操作。

public void addRules ( $rules, $append true )
$rules array

要添加的新规则。每个数组元素代表一个规则声明。请参考 $rules 获取可接受的规则格式。

$append boolean

是否通过将新规则附加到现有规则的末尾来添加它们。

                public function addRules($rules, $append = true)
{
    if (!$this->enablePrettyUrl) {
        return;
    }
    $rules = $this->buildRules($rules);
    if ($append) {
        $this->rules = array_merge($this->rules, $rules);
    } else {
        $this->rules = array_merge($rules, $this->rules);
    }
}

            
attachBehavior() 公共方法

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,将通过调用 yii\base\Behavior::attach() 方法将行为对象附加到此组件。

另请参阅 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。

$behavior 字符串|数组|yii\base\Behavior

行为配置。可以是以下之一:

返回值 yii\base\Behavior

行为对象

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公共方法

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都由其名称索引,并且应为 yii\base\Behavior 对象、指定行为类的字符串或用于创建行为的配置数组。

另请参阅 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到组件的行为列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
behaviors() 公共方法

定义于: yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以覆盖此方法以指定它们希望充当的行为。

此方法的返回值应为行为对象或配置的数组,这些对象或配置由行为名称索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意,行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当使用名称作为数组键时,使用此名称,稍后可以使用 getBehavior() 检索行为,或使用 detachBehavior() 分离行为。无法检索或分离匿名行为。

在此方法中声明的行为将自动(按需)附加到组件。

public 数组 behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
buildRules() 受保护方法

从给定的规则声明构建 URL 规则对象。

protected yii\web\UrlRuleInterface[] buildRules ( $ruleDeclarations )
$ruleDeclarations array

规则声明。每个数组元素代表一个规则声明。有关可接受的规则格式,请参阅 $rules

返回值 yii\web\UrlRuleInterface[]

根据给定的规则声明构建的规则对象

抛出异常 yii\base\InvalidConfigException

如果规则声明无效

                protected function buildRules($ruleDeclarations)
{
    $builtRules = $this->getBuiltRulesFromCache($ruleDeclarations);
    if ($builtRules !== false) {
        return $builtRules;
    }
    $builtRules = [];
    $verbs = 'GET|HEAD|POST|PUT|PATCH|DELETE|OPTIONS';
    foreach ($ruleDeclarations as $key => $rule) {
        if (is_string($rule)) {
            $rule = ['route' => $rule];
            if (preg_match("/^((?:($verbs),)*($verbs))\\s+(.*)$/", $key, $matches)) {
                $rule['verb'] = explode(',', $matches[1]);
                $key = $matches[4];
            }
            $rule['pattern'] = $key;
        }
        if (is_array($rule)) {
            $rule = Yii::createObject(array_merge($this->ruleConfig, $rule));
        }
        if (!$rule instanceof UrlRuleInterface) {
            throw new InvalidConfigException('URL rule class must implement UrlRuleInterface.');
        }
        $builtRules[] = $rule;
    }
    $this->setBuiltRulesCache($ruleDeclarations, $builtRules);
    return $builtRules;
}

            
canBeCached() 受保护方法 (自版本 2.0.12 起可用)

返回一个值,指示规则的 createUrl() 结果是否应缓存在内部缓存中。

另请参阅

protected 布尔值 canBeCached ( yii\web\UrlRuleInterface $rule )
$rule yii\web\UrlRuleInterface
返回值 boolean

如果结果应被缓存,则为 true,否则为 false

                protected function canBeCached(UrlRuleInterface $rule)
{
    return
        // if rule does not provide info about create status, we cache it every time to prevent bugs like #13350
        // @see https://github.com/yiisoft/yii2/pull/13350#discussion_r114873476
        !method_exists($rule, 'getCreateUrlStatus') || ($status = $rule->getCreateUrlStatus()) === null
        || $status === UrlRule::CREATE_STATUS_SUCCESS
        || $status & UrlRule::CREATE_STATUS_PARAMS_MISMATCH;
}

            
canGetProperty() 公共方法

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

返回一个值,指示属性是否可读。

如果可以读取属性:

  • 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 canSetProperty()

public 布尔值 canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可读

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公共方法

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

返回一个值,指示属性是否可写。

如果可以写入属性:

  • 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有可写的给定名称的属性(当 $checkBehaviors 为 true 时)。

另请参阅 canGetProperty()

public 布尔值 canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可写

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公共静态方法
自 2.0.14 版起已弃用。在 PHP >=5.5 中,请改用 ::class

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

返回此类的完全限定名称。

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

此类的完全限定名称。

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

            
createAbsoluteUrl() 公共方法

使用给定的路由和查询参数创建绝对 URL。

此方法将 createUrl() 创建的 URL 的前面加上 $hostInfo

请注意,与 yii\helpers\Url::toRoute() 不同,此方法始终将给定的路由视为绝对路由。

另请参阅 createUrl()

public 字符串 createAbsoluteUrl ( $params, $scheme null )
$params 字符串|数组

使用字符串表示路由(例如 site/index),或使用数组表示带有查询参数的路由(例如 ['site/index', 'param1' => 'value1'])。

$scheme 字符串|

用于 URL 的方案(httphttps 或空字符串表示协议相对 URL)。如果未指定,则将使用当前请求的方案。

返回值 string

生成的 URL

                public function createAbsoluteUrl($params, $scheme = null)
{
    $params = (array) $params;
    $url = $this->createUrl($params);
    if (strpos($url, '://') === false) {
        $hostInfo = $this->getHostInfo();
        if (strncmp($url, '//', 2) === 0) {
            $url = substr($hostInfo, 0, strpos($hostInfo, '://')) . ':' . $url;
        } else {
            $url = $hostInfo . $url;
        }
    }
    return Url::ensureScheme($url, $scheme);
}

            
createUrl() 公共方法

使用给定的路由和查询参数创建 URL。

您可以将路由指定为字符串,例如 site/index。如果要为正在创建的 URL 指定其他查询参数,也可以使用数组。数组格式必须为

// generates: /index.php?r=site%2Findex&param1=value1&param2=value2
['site/index', 'param1' => 'value1', 'param2' => 'value2']

如果要创建带有锚点的 URL,可以使用带有 # 参数的数组格式。例如,

// generates: /index.php?r=site%2Findex&param1=value1#name
['site/index', 'param1' => 'value1', '#' => 'name']

创建的 URL 是相对 URL。使用 createAbsoluteUrl() 创建绝对 URL。

请注意,与 yii\helpers\Url::toRoute() 不同,此方法始终将给定的路由视为绝对路由。

public 字符串 createUrl ( $params )
$params 字符串|数组

使用字符串表示路由(例如 site/index),或使用数组表示带有查询参数的路由(例如 ['site/index', 'param1' => 'value1'])。

返回值 string

生成的 URL

                public function createUrl($params)
{
    $params = (array) $params;
    $anchor = isset($params['#']) ? '#' . $params['#'] : '';
    unset($params['#'], $params[$this->routeParam]);
    $route = trim(isset($params[0]) ? $params[0] : '', '/');
    unset($params[0]);
    $baseUrl = $this->showScriptName || !$this->enablePrettyUrl ? $this->getScriptUrl() : $this->getBaseUrl();
    if ($this->enablePrettyUrl) {
        $cacheKey = $route . '?';
        foreach ($params as $key => $value) {
            if ($value !== null) {
                $cacheKey .= $key . '&';
            }
        }
        $url = $this->getUrlFromCache($cacheKey, $route, $params);
        if ($url === false) {
            /* @var $rule UrlRule */
            foreach ($this->rules as $rule) {
                if (in_array($rule, $this->_ruleCache[$cacheKey], true)) {
                    // avoid redundant calls of `UrlRule::createUrl()` for rules checked in `getUrlFromCache()`
                    // @see https://github.com/yiisoft/yii2/issues/14094
                    continue;
                }
                $url = $rule->createUrl($this, $route, $params);
                if ($this->canBeCached($rule)) {
                    $this->setRuleToCache($cacheKey, $rule);
                }
                if ($url !== false) {
                    break;
                }
            }
        }
        if ($url !== false) {
            if (strpos($url, '://') !== false) {
                if ($baseUrl !== '' && ($pos = strpos($url, '/', 8)) !== false) {
                    return substr($url, 0, $pos) . $baseUrl . substr($url, $pos) . $anchor;
                }
                return $url . $baseUrl . $anchor;
            } elseif (strncmp($url, '//', 2) === 0) {
                if ($baseUrl !== '' && ($pos = strpos($url, '/', 2)) !== false) {
                    return substr($url, 0, $pos) . $baseUrl . substr($url, $pos) . $anchor;
                }
                return $url . $baseUrl . $anchor;
            }
            $url = ltrim($url, '/');
            return "$baseUrl/{$url}{$anchor}";
        }
        if ($this->suffix !== null) {
            $route .= $this->suffix;
        }
        if (!empty($params) && ($query = http_build_query($params)) !== '') {
            $route .= '?' . $query;
        }
        $route = ltrim($route, '/');
        return "$baseUrl/{$route}{$anchor}";
    }
    $url = "$baseUrl?{$this->routeParam}=" . urlencode($route);
    if (!empty($params) && ($query = http_build_query($params)) !== '') {
        $url .= '&' . $query;
    }
    return $url . $anchor;
}

            
detachBehavior() 公共方法

定义于: yii\base\Component::detachBehavior()

从组件中分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior| detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|

分离的行为。如果行为不存在,则为 null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公共方法

定义于: yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() 公共方法

定义于: yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBaseUrl() 公共方法

返回由 createUrl() 用于追加到创建的 URL 的基本 URL。

它默认为 yii\web\Request::$baseUrl。这主要用于 $enablePrettyUrltrue$showScriptNamefalse 时。

public 字符串 getBaseUrl ( )
返回值 string

createUrl() 用于追加到创建的 URL 的基本 URL。

抛出异常 yii\base\InvalidConfigException

如果在控制台应用程序中运行且未配置 $baseUrl

                public function getBaseUrl()
{
    if ($this->_baseUrl === null) {
        $request = Yii::$app->getRequest();
        if ($request instanceof Request) {
            $this->_baseUrl = $request->getBaseUrl();
        } else {
            throw new InvalidConfigException('Please configure UrlManager::baseUrl correctly as you are running a console application.');
        }
    }
    return $this->_baseUrl;
}

            
getBehavior() 公共方法

定义于: yii\base\Component::getBehavior()

返回命名的行为对象。

public yii\base\Behavior| getBehavior ( $name )
$name string

行为名称

返回值 yii\base\Behavior|

行为对象,如果行为不存在则为 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() 公共方法

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getBuiltRulesFromCache() 受保护方法 (自版本 2.0.14 起可用)

提供与 $ruleDeclarations 关联的来自缓存的构建的 URL 规则。

protected yii\web\UrlRuleInterface[]|布尔值 getBuiltRulesFromCache ( $ruleDeclarations )
$ruleDeclarations array

规则声明。每个数组元素代表一个规则声明。有关可接受的规则格式,请参阅 $rules

返回值 yii\web\UrlRuleInterface[]|布尔值

根据给定的规则声明构建的规则对象,或者当此定义不存在缓存项时为布尔值 false

                protected function getBuiltRulesFromCache($ruleDeclarations)
{
    $cache = $this->ensureCache();
    if (!$cache) {
        return false;
    }
    return $cache->get([$this->cacheKey, $this->ruleConfig, $ruleDeclarations]);
}

            
getHostInfo() 公共方法

返回由 createAbsoluteUrl() 用于追加到创建的 URL 的主机信息。

public 字符串 getHostInfo ( )
返回值 string

主机信息(例如 https://www.example.com),由 createAbsoluteUrl() 用于追加到创建的 URL。

抛出异常 yii\base\InvalidConfigException

如果在控制台应用程序中运行且未配置 $hostInfo

                public function getHostInfo()
{
    if ($this->_hostInfo === null) {
        $request = Yii::$app->getRequest();
        if ($request instanceof \yii\web\Request) {
            $this->_hostInfo = $request->getHostInfo();
        } else {
            throw new InvalidConfigException('Please configure UrlManager::hostInfo correctly as you are running a console application.');
        }
    }
    return $this->_hostInfo;
}

            
getScriptUrl() 公共方法

返回由 createUrl() 用于追加到创建的 URL 的入口脚本 URL。

它默认为 yii\web\Request::$scriptUrl。这主要用于 $enablePrettyUrlfalse$showScriptNametrue 时。

public 字符串 getScriptUrl ( )
返回值 string

createUrl() 用于追加到创建的 URL 的入口脚本 URL。

抛出异常 yii\base\InvalidConfigException

如果在控制台应用程序中运行且未配置 $scriptUrl

                public function getScriptUrl()
{
    if ($this->_scriptUrl === null) {
        $request = Yii::$app->getRequest();
        if ($request instanceof Request) {
            $this->_scriptUrl = $request->getScriptUrl();
        } else {
            throw new InvalidConfigException('Please configure UrlManager::scriptUrl correctly as you are running a console application.');
        }
    }
    return $this->_scriptUrl;
}

            
getUrlFromCache() 受保护方法 (自版本 2.0.8 起可用)

如果存在,则从内部缓存获取 URL。

另请参阅 createUrl()

protected 布尔值|字符串 getUrlFromCache ( $cacheKey, $route, $params )
$cacheKey string

生成的用于存储数据的缓存键。

$route string

路由(例如 site/index)。

$params array

规则参数。

返回值 布尔值|字符串

生成的 URL

                protected function getUrlFromCache($cacheKey, $route, $params)
{
    if (!empty($this->_ruleCache[$cacheKey])) {
        foreach ($this->_ruleCache[$cacheKey] as $rule) {
            /* @var $rule UrlRule */
            if (($url = $rule->createUrl($this, $route, $params)) !== false) {
                return $url;
            }
        }
    } else {
        $this->_ruleCache[$cacheKey] = [];
    }
    return false;
}

            
hasEventHandlers() 公共方法

定义于: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有任何处理程序附加到命名的事件。

public 布尔型 hasEventHandlers ( $name )
$name string

事件名称

返回值 boolean

是否存在任何附加到事件的处理程序。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() 公共方法

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

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

如果定义了方法

  • 类具有指定名称的方法
  • 附加的行为具有给定名称的方法(当 $checkBehaviors 为 true 时)。
public 布尔型 hasMethod ( $name, $checkBehaviors true )
$name string

属性名

$checkBehaviors boolean

是否将行为的方法视为此组件的方法

返回值 boolean

方法是否已定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() 公共方法

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

返回一个值,指示此组件是否定义了属性。

如果定义了属性

  • 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当 $checkBehaviors 为 true 时)。

另请参阅

public 布尔型 hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否已定义

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() 公共方法

初始化 UrlManager。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->normalizer !== false) {
        $this->normalizer = Yii::createObject($this->normalizer);
        if (!$this->normalizer instanceof UrlNormalizer) {
            throw new InvalidConfigException('`' . get_class($this) . '::normalizer` should be an instance of `' . UrlNormalizer::className() . '` or its DI compatible configuration.');
        }
    }
    if (!$this->enablePrettyUrl) {
        return;
    }
    if (!empty($this->rules)) {
        $this->rules = $this->buildRules($this->rules);
    }
}

            
off() 公共方法

定义于: yii\base\Component::off()

从此组件中分离现有的事件处理程序。

此方法与 on() 相反。

注意:如果为事件名称传递通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()

public 布尔型 off ( $name, $handler null )
$name string

事件名称

$handler 可调用|

要删除的事件处理程序。如果为 null,则将删除附加到命名事件的所有处理程序。

返回值 boolean

如果找到并分离了处理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() 公共方法

定义于: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义,

function ($event)

其中 $event 是一个 yii\base\Event 对象,其中包含与事件关联的参数。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参阅 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler 可调用

事件处理程序

$data mixed

触发事件时要传递给事件处理程序的数据。当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append boolean

是否将新的事件处理程序附加到现有处理程序列表的末尾。如果为 false,则新的处理程序将插入到现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
parseRequest() 公共方法

解析用户请求。

public 数组|布尔型 parseRequest ( $request )
$request yii\web\Request

请求组件

返回值 数组|布尔型

路由和关联的参数。如果 $enablePrettyUrlfalse,则后者始终为空。如果无法成功解析当前请求,则返回 false

                public function parseRequest($request)
{
    if ($this->enablePrettyUrl) {
        /* @var $rule UrlRule */
        foreach ($this->rules as $rule) {
            $result = $rule->parseRequest($this, $request);
            if (YII_DEBUG) {
                Yii::debug([
                    'rule' => method_exists($rule, '__toString') ? $rule->__toString() : get_class($rule),
                    'match' => $result !== false,
                    'parent' => null,
                ], __METHOD__);
            }
            if ($result !== false) {
                return $result;
            }
        }
        if ($this->enableStrictParsing) {
            return false;
        }
        Yii::debug('No matching URL rules. Using default URL parsing logic.', __METHOD__);
        $suffix = (string) $this->suffix;
        $pathInfo = $request->getPathInfo();
        $normalized = false;
        if ($this->normalizer !== false) {
            $pathInfo = $this->normalizer->normalizePathInfo($pathInfo, $suffix, $normalized);
        }
        if ($suffix !== '' && $pathInfo !== '') {
            $n = strlen($this->suffix);
            if (substr_compare($pathInfo, $this->suffix, -$n, $n) === 0) {
                $pathInfo = substr($pathInfo, 0, -$n);
                if ($pathInfo === '') {
                    // suffix alone is not allowed
                    return false;
                }
            } else {
                // suffix doesn't match
                return false;
            }
        }
        if ($normalized) {
            // pathInfo was changed by normalizer - we need also normalize route
            return $this->normalizer->normalizeRoute([$pathInfo, []]);
        }
        return [$pathInfo, []];
    }
    Yii::debug('Pretty URL not enabled. Using default URL parsing logic.', __METHOD__);
    $route = $request->getQueryParam($this->routeParam, '');
    if (is_array($route)) {
        $route = '';
    }
    return [(string) $route, []];
}

            
setBaseUrl() 公共方法

设置由 createUrl() 用于追加到创建的 URL 的基本 URL。

这主要用于 $enablePrettyUrltrue$showScriptNamefalse 时。

public void setBaseUrl ( $value )
$value string

createUrl() 用于追加到创建的 URL 的基本 URL。

                public function setBaseUrl($value)
{
    $this->_baseUrl = $value === null ? null : rtrim(Yii::getAlias($value), '/');
}

            
setBuiltRulesCache() 受保护的方法 (自版本 2.0.14 起可用)

将 $builtRules 存储到缓存中,使用 $rulesDeclaration 作为缓存键的一部分。

protected 布尔型 setBuiltRulesCache ( $ruleDeclarations, $builtRules )
$ruleDeclarations array

规则声明。每个数组元素代表一个规则声明。有关可接受的规则格式,请参阅 $rules

$builtRules yii\web\UrlRuleInterface[]

根据给定的规则声明构建的规则对象。

返回值 boolean

值是否已成功存储到缓存中

                protected function setBuiltRulesCache($ruleDeclarations, $builtRules)
{
    $cache = $this->ensureCache();
    if (!$cache) {
        return false;
    }
    return $cache->set([$this->cacheKey, $this->ruleConfig, $ruleDeclarations], $builtRules);
}

            
setHostInfo() 公共方法

设置由 createAbsoluteUrl() 用于追加到创建的 URL 的主机信息。

public void setHostInfo ( $value )
$value string

主机信息(例如,“https://www.example.com”),createAbsoluteUrl() 使用它来添加到创建的 URL 的前面。

                public function setHostInfo($value)
{
    $this->_hostInfo = $value === null ? null : rtrim($value, '/');
}

            
setRuleToCache() 受保护的方法 (自版本 2.0.8 起可用)

将规则(例如 yii\web\UrlRule)存储到内部缓存中。

protected void setRuleToCache ( $cacheKey, yii\web\UrlRuleInterface $rule )
$cacheKey
$rule yii\web\UrlRuleInterface

                protected function setRuleToCache($cacheKey, UrlRuleInterface $rule)
{
    $this->_ruleCache[$cacheKey][] = $rule;
}

            
setScriptUrl() 公共方法

设置由 createUrl() 用于追加到创建的 URL 的入口脚本 URL。

$enablePrettyUrlfalse$showScriptNametrue 时,主要使用此方法。

public void setScriptUrl ( $value )
$value string

createUrl() 用于追加到创建的 URL 的入口脚本 URL。

                public function setScriptUrl($value)
{
    $this->_scriptUrl = $value;
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它会调用事件的所有附加处理程序,包括类级别处理程序。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名称

$event yii\base\Event|null

事件实例。如果未设置,将创建一个默认的 yii\base\Event 对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}