Class luya\web\UrlRule

Inheritanceluya\web\UrlRule » yii\web\UrlRule » yii\base\BaseObject
Implementsyii\base\Configurable, yii\web\UrlRuleInterface
Subclassesluya\cms\frontend\components\CatchAllUrlRule, luya\cms\frontend\components\RouteBehaviorUrlRule, luya\cms\frontend\components\WebsiteBehaviorUrlRule
Available since version1.0.0
Source Code https://github.com/luyadev/luya/blob/master/core/web/UrlRule.php

Base urlRule class used as ruleConfig in UrlManager Componenet.

Can't set the UrlRule as abstract cause its used as base class for all UrlRules, this is a behavior of the UrlManger where is set like this:.

public $ruleConfig = ['class' => '\luya\web\UrlRule'];

Public Properties

Hide inherited properties

Property Type Description Defined By
$composition array Composition rules are multi lingual rule definitions match against different languages from composition component. luya\web\UrlRule
$createUrlStatus integer|null Status of the URL creation after the last createUrl() call. yii\web\UrlRule
$defaults array The default GET parameters (name => value) that this rule provides. yii\web\UrlRule
$encodeParams boolean A value indicating if parameters should be url encoded. yii\web\UrlRule
$host string|null The pattern used to parse and create the host info part of a URL (e.g. https://example.com). yii\web\UrlRule
$mode integer|null A value indicating if this rule should be used for both request parsing and URL creation, parsing only, or creation only. yii\web\UrlRule
$name string|null The name of this rule. yii\web\UrlRule
$normalizer yii\web\UrlNormalizer|array|false|null The configuration for yii\web\UrlNormalizer used by this rule. yii\web\UrlRule
$pattern string The pattern used to parse and create the path info part of a URL. yii\web\UrlRule
$route string The route to the controller action yii\web\UrlRule
$suffix string|null The URL suffix used for this rule. yii\web\UrlRule
$verb string|array|null The HTTP verb (e.g. GET, POST, DELETE) that this rule should match. yii\web\UrlRule

Protected Properties

Hide inherited properties

Property Type Description Defined By
$createStatus integer|null Status of the URL creation after the last createUrl() call. yii\web\UrlRule
$placeholders array List of placeholders for matching parameters names. yii\web\UrlRule

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
__toString() yii\web\UrlRule
__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
createUrl() Creates a URL according to the given route and parameters. yii\web\UrlRule
getCreateUrlStatus() Returns status of the URL creation after the last createUrl() call. yii\web\UrlRule
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 this rule. yii\web\UrlRule
parseRequest() Parses the given request and returns the corresponding route and parameters. yii\web\UrlRule

Protected Methods

Hide inherited methods

Method Description Defined By
getNormalizer() yii\web\UrlRule
getParamRules() Returns list of regex for matching parameter. yii\web\UrlRule
hasNormalizer() yii\web\UrlRule
substitutePlaceholderNames() Iterates over $placeholders and checks whether each placeholder exists as a key in $matches array. yii\web\UrlRule

Constants

Hide inherited constants

Constant Value Description Defined By
CREATE_STATUS_PARAMS_MISMATCH 4 Represents the unsuccessful URL generation by last createUrl() call, because of mismatched or missing parameters. yii\web\UrlRule
CREATE_STATUS_PARSING_ONLY 1 Represents the unsuccessful URL generation by last createUrl() call, because rule does not support creating URLs. yii\web\UrlRule
CREATE_STATUS_ROUTE_MISMATCH 2 Represents the unsuccessful URL generation by last createUrl() call, because of mismatched route. yii\web\UrlRule
CREATE_STATUS_SUCCESS 0 Represents the successful URL generation by last createUrl() call. yii\web\UrlRule
CREATION_ONLY 2 Set $mode with this value to mark that this rule is for URL creation only. yii\web\UrlRule
PARSING_ONLY 1 Set $mode with this value to mark that this rule is for URL parsing only. yii\web\UrlRule

Property Details

Hide inherited properties

$composition public property

Composition rules are multi lingual rule definitions match against different languages from composition component. This variable will be assigned from the modules urlRule variable and while foreaching the urlRules the composition values for each rule will be stored in this variable to retrieve the informations later on.

public array $composition = []

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

            
__toString() public method (available since version 2.0.11)
public string __toString ( )

                public function __toString()
{
    $str = '';
    if ($this->verb !== null) {
        $str .= implode(',', $this->verb) . ' ';
    }
    if ($this->host !== null && strrpos($this->name, $this->host) === false) {
        $str .= $this->host . '/';
    }
    $str .= $this->name;
    if ($str === '') {
        return '/';
    }
    return $str;
}

            
__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();
}

            
createUrl() public method

Defined in: yii\web\UrlRule::createUrl()

Creates a URL according to the given route and parameters.

public string|boolean createUrl ( $manager, $route, $params )
$manager yii\web\UrlManager

The URL manager

$route string

The route. It should not have slashes at the beginning or the end.

$params array

The parameters

return string|boolean

The created URL, or false if this rule cannot be used for creating this URL.

                public function createUrl($manager, $route, $params)
{
    if ($this->mode === self::PARSING_ONLY) {
        $this->createStatus = self::CREATE_STATUS_PARSING_ONLY;
        return false;
    }
    $tr = [];
    // match the route part first
    if ($route !== $this->route) {
        if ($this->_routeRule !== null && preg_match($this->_routeRule, $route, $matches)) {
            $matches = $this->substitutePlaceholderNames($matches);
            foreach ($this->_routeParams as $name => $token) {
                if (isset($this->defaults[$name]) && strcmp($this->defaults[$name], $matches[$name]) === 0) {
                    $tr[$token] = '';
                } else {
                    $tr[$token] = $matches[$name];
                }
            }
        } else {
            $this->createStatus = self::CREATE_STATUS_ROUTE_MISMATCH;
            return false;
        }
    }
    // match default params
    // if a default param is not in the route pattern, its value must also be matched
    foreach ($this->defaults as $name => $value) {
        if (isset($this->_routeParams[$name])) {
            continue;
        }
        if (!isset($params[$name])) {
            // allow omit empty optional params
            // @see https://github.com/yiisoft/yii2/issues/10970
            if (in_array($name, $this->placeholders) && strcmp($value, '') === 0) {
                $params[$name] = '';
            } else {
                $this->createStatus = self::CREATE_STATUS_PARAMS_MISMATCH;
                return false;
            }
        }
        if (strcmp($params[$name], $value) === 0) { // strcmp will do string conversion automatically
            unset($params[$name]);
            if (isset($this->_paramRules[$name])) {
                $tr["<$name>"] = '';
            }
        } elseif (!isset($this->_paramRules[$name])) {
            $this->createStatus = self::CREATE_STATUS_PARAMS_MISMATCH;
            return false;
        }
    }
    // match params in the pattern
    foreach ($this->_paramRules as $name => $rule) {
        if (isset($params[$name]) && !is_array($params[$name]) && ($rule === '' || preg_match($rule, $params[$name]))) {
            $tr["<$name>"] = $this->encodeParams ? urlencode($params[$name]) : $params[$name];
            unset($params[$name]);
        } elseif (!isset($this->defaults[$name]) || isset($params[$name])) {
            $this->createStatus = self::CREATE_STATUS_PARAMS_MISMATCH;
            return false;
        }
    }
    $url = $this->trimSlashes(strtr($this->_template, $tr));
    if ($this->host !== null) {
        $pos = strpos($url, '/', 8);
        if ($pos !== false) {
            $url = substr($url, 0, $pos) . preg_replace('#/+#', '/', substr($url, $pos));
        }
    } elseif (strpos($url, '//') !== false) {
        $url = preg_replace('#/+#', '/', trim($url, '/'));
    }
    if ($url !== '') {
        $url .= ($this->suffix === null ? $manager->suffix : $this->suffix);
    }
    if (!empty($params) && ($query = http_build_query($params)) !== '') {
        $url .= '?' . $query;
    }
    $this->createStatus = self::CREATE_STATUS_SUCCESS;
    return $url;
}

            
getCreateUrlStatus() public method (available since version 2.0.12)

Defined in: yii\web\UrlRule::getCreateUrlStatus()

Returns status of the URL creation after the last createUrl() call.

See also $createStatus.

public integer|null getCreateUrlStatus ( )
return integer|null

Status of the URL creation after the last createUrl() call. null if rule does not provide info about create status.

                public function getCreateUrlStatus()
{
    return $this->createStatus;
}

            
getNormalizer() protected method (available since version 2.0.10)
protected yii\web\UrlNormalizer|null getNormalizer ( $manager )
$manager yii\web\UrlManager

The URL manager

                protected function getNormalizer($manager)
{
    if ($this->normalizer === null) {
        return $manager->normalizer;
    }
    return $this->normalizer;
}

            
getParamRules() protected method (available since version 2.0.6)

Defined in: yii\web\UrlRule::getParamRules()

Returns list of regex for matching parameter.

protected array getParamRules ( )
return array

Parameter keys and regexp rules.

                protected function getParamRules()
{
    return $this->_paramRules;
}

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

            
hasNormalizer() protected method (available since version 2.0.10)
protected boolean hasNormalizer ( $manager )
$manager yii\web\UrlManager

The URL manager

                protected function hasNormalizer($manager)
{
    return $this->getNormalizer($manager) instanceof UrlNormalizer;
}

            
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\web\UrlRule::init()

Initializes this rule.

public void init ( )

                public function init()
{
    if ($this->pattern === null) {
        throw new InvalidConfigException('UrlRule::pattern must be set.');
    }
    if ($this->route === null) {
        throw new InvalidConfigException('UrlRule::route must be set.');
    }
    if (is_array($this->normalizer)) {
        $normalizerConfig = array_merge(['class' => UrlNormalizer::className()], $this->normalizer);
        $this->normalizer = Yii::createObject($normalizerConfig);
    }
    if ($this->normalizer !== null && $this->normalizer !== false && !$this->normalizer instanceof UrlNormalizer) {
        throw new InvalidConfigException('Invalid config for UrlRule::normalizer.');
    }
    if ($this->verb !== null) {
        if (is_array($this->verb)) {
            foreach ($this->verb as $i => $verb) {
                $this->verb[$i] = strtoupper($verb);
            }
        } else {
            $this->verb = [strtoupper($this->verb)];
        }
    }
    if ($this->name === null) {
        $this->name = $this->pattern;
    }
    $this->preparePattern();
}

            
parseRequest() public method

Defined in: yii\web\UrlRule::parseRequest()

Parses the given request and returns the corresponding route and parameters.

public array|boolean parseRequest ( $manager, $request )
$manager yii\web\UrlManager

The URL manager

$request yii\web\Request

The request component

return array|boolean

The parsing result. The route and the parameters are returned as an array. If false, it means this rule cannot be used to parse this path info.

                public function parseRequest($manager, $request)
{
    if ($this->mode === self::CREATION_ONLY) {
        return false;
    }
    if (!empty($this->verb) && !in_array($request->getMethod(), $this->verb, true)) {
        return false;
    }
    $suffix = (string) ($this->suffix === null ? $manager->suffix : $this->suffix);
    $pathInfo = $request->getPathInfo();
    $normalized = false;
    if ($this->hasNormalizer($manager)) {
        $pathInfo = $this->getNormalizer($manager)->normalizePathInfo($pathInfo, $suffix, $normalized);
    }
    if ($suffix !== '' && $pathInfo !== '') {
        $n = strlen($suffix);
        if (substr_compare($pathInfo, $suffix, -$n, $n) === 0) {
            $pathInfo = substr($pathInfo, 0, -$n);
            if ($pathInfo === '') {
                // suffix alone is not allowed
                return false;
            }
        } else {
            return false;
        }
    }
    if ($this->host !== null) {
        $pathInfo = strtolower($request->getHostInfo()) . ($pathInfo === '' ? '' : '/' . $pathInfo);
    }
    if (!preg_match($this->pattern, $pathInfo, $matches)) {
        return false;
    }
    $matches = $this->substitutePlaceholderNames($matches);
    foreach ($this->defaults as $name => $value) {
        if (!isset($matches[$name]) || $matches[$name] === '') {
            $matches[$name] = $value;
        }
    }
    $params = $this->defaults;
    $tr = [];
    foreach ($matches as $name => $value) {
        if (isset($this->_routeParams[$name])) {
            $tr[$this->_routeParams[$name]] = $value;
            unset($params[$name]);
        } elseif (isset($this->_paramRules[$name])) {
            $params[$name] = $value;
        }
    }
    if ($this->_routeRule !== null) {
        $route = strtr($this->route, $tr);
    } else {
        $route = $this->route;
    }
    Yii::debug("Request parsed with URL rule: {$this->name}", __METHOD__);
    if ($normalized) {
        // pathInfo was changed by normalizer - we need also normalize route
        return $this->getNormalizer($manager)->normalizeRoute([$route, $params]);
    }
    return [$route, $params];
}

            
substitutePlaceholderNames() protected method (available since version 2.0.7)

Defined in: yii\web\UrlRule::substitutePlaceholderNames()

Iterates over $placeholders and checks whether each placeholder exists as a key in $matches array.

When found - replaces this placeholder key with a appropriate name of matching parameter. Used in parseRequest(), createUrl().

See also $placeholders.

protected array substitutePlaceholderNames ( array $matches )
$matches array

Result of preg_match() call

return array

Input array with replaced placeholder keys

                protected function substitutePlaceholderNames(array $matches)
{
    foreach ($this->placeholders as $placeholder => $name) {
        if (isset($matches[$placeholder])) {
            $matches[$name] = $matches[$placeholder];
            unset($matches[$placeholder]);
        }
    }
    return $matches;
}