0 追蹤者

類別 yii\web\UrlNormalizer

所有類別 | 屬性 | 方法 | 常數
繼承關係yii\web\UrlNormalizer » yii\base\BaseObject
實作介面yii\base\Configurable
可用版本自2.0.10
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/web/UrlNormalizer.php

UrlNormalizer 為 yii\web\UrlManager 和 yii\web\UrlRule 正規化 URL。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$action integer|callable|null 在路由正規化期間執行的動作。 yii\web\UrlNormalizer
$collapseSlashes boolean 是否應摺疊斜線，例如 site///index 將轉換為 site/index yii\web\UrlNormalizer
$normalizeTrailingSlash boolean 是否應根據規則的後綴設定來正規化尾部斜線 yii\web\UrlNormalizer

公開方法

隱藏繼承的方法

方法 描述 定義於
__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
canGetProperty() 傳回一個值，指示屬性是否可讀取。 yii\base\BaseObject
canSetProperty() 傳回一個值，指示屬性是否可設定。 yii\base\BaseObject
className() 傳回此類別的完整命名空間名稱。 yii\base\BaseObject
hasMethod() 傳回一個值，指示方法是否已定義。 yii\base\BaseObject
hasProperty() 傳回一個值，指示屬性是否已定義。 yii\base\BaseObject
init() 初始化物件。 yii\base\BaseObject
normalizePathInfo() 正規化指定的 pathInfo。 yii\web\UrlNormalizer
normalizeRoute() 為指定的 $route 執行正規化動作。 yii\web\UrlNormalizer

保護方法

隱藏繼承的方法

方法 描述 定義於
collapseSlashes() 摺疊 $pathInfo 中連續的斜線，例如將 site///index 轉換為 site/index。 yii\web\UrlNormalizer
normalizeTrailingSlash() 根據 $suffix 是否有尾部斜線，在 $pathInfo 中新增或移除尾部斜線。 yii\web\UrlNormalizer

常數

隱藏繼承的常數

常數 值 描述 定義於
ACTION_NOT_FOUND 404 表示在路由正規化期間顯示 404 錯誤頁面。 yii\web\UrlNormalizer
ACTION_REDIRECT_PERMANENT 301 表示在路由正規化期間永久重定向。 yii\web\UrlNormalizer
ACTION_REDIRECT_TEMPORARY 302 表示在路由正規化期間暫時重定向。 yii\web\UrlNormalizer

屬性詳情

隱藏繼承的屬性

$action 公開屬性

在路由正規化期間執行的動作。可用選項為

  • null - 不執行特殊動作
  • 301 - 請求應使用永久重定向重新導向至正規化的 URL
  • 302 - 請求應使用暫時重定向重新導向至正規化的 URL
  • 404 - 將拋出 yii\web\NotFoundHttpException

  • callable - 自訂使用者回呼，例如

    function ($route, $normalizer) {
    // use custom action for redirections
    $route[1]['oldRoute'] = $route[0];
    $route[0] = 'site/redirect';
    return $route;
}
public integer|callable|null $action = self::ACTION_REDIRECT_PERMANENT
$collapseSlashes 公開屬性

是否應摺疊斜線，例如 site///index 將轉換為 site/index

public boolean $collapseSlashes = true
$normalizeTrailingSlash 公開屬性

是否應根據規則的後綴設定來正規化尾部斜線

public boolean $normalizeTrailingSlash = true

方法詳情

隱藏繼承的方法

__call() 公開方法

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

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

請勿直接呼叫此方法，因為當呼叫未知的方法時，PHP 會隱含地呼叫此魔術方法。

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

方法名稱
$params array

方法參數
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 array

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

 

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

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

傳回物件屬性的值。

請勿直接呼叫此方法，因為當執行 $value = $object->property; 時，PHP 會隱含地呼叫此魔術方法。

另請參閱 __set()。

public mixed __get ( $name )
$name string

屬性名稱
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。

請勿直接呼叫此方法，因為當執行 isset($object->property) 時，PHP 會隱含地呼叫此魔術方法。

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

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

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱
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()

設定物件屬性的值。

請勿直接呼叫此方法，因為當執行 $object->property = $value; 時，PHP 會隱含地呼叫此魔術方法。

另請參閱 __get()。

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

屬性名稱或事件名稱
$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。

請勿直接呼叫此方法，因為當執行 unset($object->property) 時，PHP 會隱含地呼叫此魔術方法。

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

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

public void __unset ( $name )
$name string

屬性名稱
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);
    }
}
canGetProperty() 公開方法

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

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

如果符合以下條件，屬性是可讀取的

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

另請參閱 canSetProperty()。

public boolean canGetProperty ( $name, $checkVars = true )
$name string

屬性名稱
$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 string

屬性名稱
$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 string

此類別的完整命名空間名稱。

 

                public static function className()
{
    return get_called_class();
}
collapseSlashes() 保護方法

摺疊 $pathInfo 中連續的斜線，例如將 site///index 轉換為 site/index。

protected string collapseSlashes ( $pathInfo )
$pathInfo string

原始路徑資訊。
return string

正規化路徑資訊。

 

                protected function collapseSlashes($pathInfo)
{
    return ltrim(preg_replace('#/{2,}#', '/', $pathInfo), '/');
}
hasMethod() 公開方法

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

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

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

public boolean hasMethod ( $name )
$name string

方法名稱
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 string

屬性名稱
$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()
{
}
normalizePathInfo() 公開方法

正規化指定的 pathInfo。

public string normalizePathInfo ( $pathInfo, $suffix, &$normalized = false )
$pathInfo string

用於正規化的 PathInfo
$suffix string

目前的規則後綴
$normalized boolean

如果指定，如果 $pathInfo 在正規化期間被更改，此變數將設定為 true
return string

正規化的 pathInfo

 

                public function normalizePathInfo($pathInfo, $suffix, &$normalized = false)
{
    if (empty($pathInfo)) {
        return $pathInfo;
    }
    $sourcePathInfo = $pathInfo;
    if ($this->collapseSlashes) {
        $pathInfo = $this->collapseSlashes($pathInfo);
    }
    if ($this->normalizeTrailingSlash === true) {
        $pathInfo = $this->normalizeTrailingSlash($pathInfo, $suffix);
    }
    $normalized = $sourcePathInfo !== $pathInfo;
    return $pathInfo;
}
normalizeRoute() 公開方法

為指定的 $route 執行正規化動作。

public array normalizeRoute ( $route )
$route array

用於正規化的路由
return array

正規化的路由
throws yii\base\InvalidConfigException

如果使用了無效的正規化動作。
throws yii\web\UrlNormalizerRedirectException

如果正規化需要重定向。
throws yii\web\NotFoundHttpException

如果正規化建議的動作與路由不符。

 

                public function normalizeRoute($route)
{
    if ($this->action === null) {
        return $route;
    } elseif ($this->action === static::ACTION_REDIRECT_PERMANENT || $this->action === static::ACTION_REDIRECT_TEMPORARY) {
        throw new UrlNormalizerRedirectException([$route[0]] + $route[1], $this->action);
    } elseif ($this->action === static::ACTION_NOT_FOUND) {
        throw new NotFoundHttpException(Yii::t('yii', 'Page not found.'));
    } elseif (is_callable($this->action)) {
        return call_user_func($this->action, $route, $this);
    }
    throw new InvalidConfigException('Invalid normalizer action.');
}
normalizeTrailingSlash() 保護方法

根據 $suffix 是否有尾部斜線，在 $pathInfo 中新增或移除尾部斜線。

protected string normalizeTrailingSlash ( $pathInfo, $suffix )
$pathInfo string

原始路徑資訊。
$suffix string
return string

正規化路徑資訊。

 

                protected function normalizeTrailingSlash($pathInfo, $suffix)
{
    if (substr($suffix, -1) === '/' && substr($pathInfo, -1) !== '/') {
        $pathInfo .= '/';
    } elseif (substr($suffix, -1) !== '/' && substr($pathInfo, -1) === '/') {
        $pathInfo = rtrim($pathInfo, '/');
    }
    return $pathInfo;
}