UrlNormalizer

API reference › yii › web › UrlNormalizer

class	`yii\web\UrlNormalizer`
Extends	`yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0.10
Source	`framework/web/UrlNormalizer.php`

UrlNormalizer normalizes URLs for UrlManager and UrlRule.

Properties

Property	Type	Description	Defined by
`$action`	`int\|callable\|null`	Action to perform during route normalization. Default: `self::ACTION_REDIRECT_PERMANENT`.	`UrlNormalizer`
`$collapseSlashes`	`bool`	Whether slashes should be collapsed, for example `site///index` will be converted into `site/index` Default: `true`.	`UrlNormalizer`
`$normalizeTrailingSlash`	`bool`	Whether trailing slash should be normalized according to the suffix settings of the rule Default: `true`.	`UrlNormalizer`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`yii\base\BaseObject`
`normalizePathInfo()`	Normalizes specified pathInfo.	`UrlNormalizer`
`normalizeRoute()`	Performs normalization action for the specified $route.	`UrlNormalizer`
`collapseSlashes()` protected	Collapse consecutive slashes in $pathInfo, for example converts `site///index` into `site/index`.	`UrlNormalizer`
`normalizeTrailingSlash()` protected	Adds or removes trailing slashes from $pathInfo depending on whether the $suffix has a trailing slash or not.	`UrlNormalizer`

Constants

Constant	Value	Description	Defined by
`ACTION_REDIRECT_PERMANENT`	`301`	Represents permament redirection during route normalization.	`UrlNormalizer`
`ACTION_REDIRECT_TEMPORARY`	`302`	Represents temporary redirection during route normalization.	`UrlNormalizer`
`ACTION_NOT_FOUND`	`404`	Represents showing 404 error page during route normalization.	`UrlNormalizer`

Property details

$action

public int|callable|null $action = self::ACTION_REDIRECT_PERMANENT

Action to perform during route normalization.

Available options are:

null - no special action will be performed
301 - the request should be redirected to the normalized URL using permanent redirection
302 - the request should be redirected to the normalized URL using temporary redirection
404 - NotFoundHttpException will be thrown

callable - custom user callback, for example:

function ($route, $normalizer) {
    // use custom action for redirections
    $route[1]['oldRoute'] = $route[0];
    $route[0] = 'site/redirect';
    return $route;
}

Method details

normalizePathInfo()

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

Normalizes specified pathInfo.

Parameters

Parameter	Type	Description
`$pathInfo`	`string`	PathInfo for normalization
`$suffix`	`string`	Current rule suffix
`$normalized`	`bool`	If specified, this variable will be set to `true` if $pathInfo was changed during normalization

Returns

string: Normalized pathInfo

normalizeRoute()

public function normalizeRoute(array $route): array

Performs normalization action for the specified $route.

Parameters

Parameter	Type	Description
`$route`	`array`	Route for normalization

Returns

array: Normalized route

Throws

yii\base\InvalidConfigException: if invalid normalization action is used.
UrlNormalizerRedirectException: if normalization requires redirection.
NotFoundHttpException: if normalization suggests action matching route does not exist.

collapseSlashes()

protected function collapseSlashes(string $pathInfo): string

Collapse consecutive slashes in $pathInfo, for example converts site///index into site/index.

Parameters

Parameter	Type	Description
`$pathInfo`	`string`	Raw path info.

Returns

string: Normalized path info.

normalizeTrailingSlash()

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

Adds or removes trailing slashes from $pathInfo depending on whether the $suffix has a trailing slash or not.

Parameters

Parameter	Type	Description
`$pathInfo`	`string`	Raw path info.
`$suffix`	`string`

Returns

string: Normalized path info.