0 follower

Class yii\web\UrlNormalizer

All Classes | Properties | Methods | Constants
Inheritanceyii\web\UrlNormalizer » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0.10
Source Code https://github.com/yiisoft/yii2/blob/master/framework/web/UrlNormalizer.php

UrlNormalizer normalizes URLs for yii\web\UrlManager and yii\web\UrlRule.

Public Properties

Hide inherited properties

Property Type Description Defined By
$action integer|callable|null Action to perform during route normalization. yii\web\UrlNormalizer
$collapseSlashes boolean Whether slashes should be collapsed, for example site///index will be converted into site/index yii\web\UrlNormalizer
$normalizeTrailingSlash boolean Whether trailing slash should be normalized according to the suffix settings of the rule yii\web\UrlNormalizer

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. 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() 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. yii\web\UrlNormalizer
normalizeRoute() Performs normalization action for the specified $route. yii\web\UrlNormalizer

Protected Methods

Hide inherited methods

Method Description Defined By
collapseSlashes() Collapse consecutive slashes in $pathInfo, for example converts site///index into site/index. yii\web\UrlNormalizer
normalizeTrailingSlash() Adds or removes trailing slashes from $pathInfo depending on whether the $suffix has a trailing slash or not. yii\web\UrlNormalizer

Constants

Hide inherited constants

Constant Value Description Defined By
ACTION_NOT_FOUND 404 Represents showing 404 error page during route normalization. yii\web\UrlNormalizer
ACTION_REDIRECT_PERMANENT 301 Represents permament redirection during route normalization. yii\web\UrlNormalizer
ACTION_REDIRECT_TEMPORARY 302 Represents temporary redirection during route normalization. yii\web\UrlNormalizer

Property Details

Hide inherited properties

$action public property

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 - yii\web\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;
}
public integer|callable|null $action = self::ACTION_REDIRECT_PERMANENT
$collapseSlashes public property

Whether slashes should be collapsed, for example site///index will be converted into site/index

public boolean $collapseSlashes = true
$normalizeTrailingSlash public property

Whether trailing slash should be normalized according to the suffix settings of the rule

public boolean $normalizeTrailingSlash = true

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

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

The method name
$params array

Method parameters
return mixed

The method return value
throws yii\base\UnknownMethodException

when calling unknown method

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

 

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

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name
return mixed

The property value
throws yii\base\UnknownPropertyException

if the property is not defined
throws yii\base\InvalidCallException

if the property is write-only

 

                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

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name
return boolean

Whether the named property is set (not null).

 

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

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

See also __get().

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

The property name or the event name
$value mixed

The property value
throws yii\base\UnknownPropertyException

if the property is not defined
throws yii\base\InvalidCallException

if the property is read-only

 

                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

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name
throws yii\base\InvalidCallException

if the property is read only.

 

                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() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canSetProperty().

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

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be read

 

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

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canGetProperty().

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

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be written

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

 

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

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

protected string collapseSlashes ( $pathInfo )
$pathInfo string

Raw path info.
return string

Normalized path info.

 

                protected function collapseSlashes($pathInfo)
{
    return ltrim(preg_replace('#/{2,}#', '/', $pathInfo), '/');
}
hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

public boolean hasMethod ( $name )
$name string

The method name
return boolean

Whether the method is defined

 

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

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also:

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

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property is defined

 

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

Defined in: yii\base\BaseObject::init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
}
normalizePathInfo() public method

Normalizes specified pathInfo.

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

PathInfo for normalization
$suffix string

Current rule suffix
$normalized boolean

If specified, this variable will be set to true if $pathInfo was changed during normalization
return string

Normalized 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() public method

Performs normalization action for the specified $route.

public array normalizeRoute ( $route )
$route array

Route for normalization
return array

Normalized route
throws yii\base\InvalidConfigException

if invalid normalization action is used.
throws yii\web\UrlNormalizerRedirectException

if normalization requires redirection.
throws yii\web\NotFoundHttpException

if normalization suggests action matching route does not exist.

 

                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() protected method

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

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

Raw path info.
$suffix string
return string

Normalized path info.

 

                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;
}