UrlRule

API reference › yii › web › UrlRule

class	yii\web\UrlRule
Extends	yii\base\BaseObject
Implements	UrlRuleInterface, yii\base\Configurable
Since	2.0
Source	framework/web/UrlRule.php

UrlRule represents a rule used by UrlManager for parsing and generating URLs.

To define your own URL parsing and creation logic you can extend from this class and add it to UrlManager::$rules like this:

'rules' => [
    ['class' => 'MyUrlRule', 'pattern' => '...', 'route' => 'site/index', ...],
    // ...
]

Properties

Property	Type	Description	Defined by
$createUrlStatus read-only	int|null	Status of the URL creation after the last createUrl() call. null if rule does not provide info about create status.	UrlRule
$defaults	array	The default GET parameters (name => value) that this rule provides. Default: [].	UrlRule
$encodeParams	bool	A value indicating if parameters should be url encoded. Default: true.	UrlRule
$host	string|null	The pattern used to parse and create the host info part of a URL (e.g. https://example.com). Default: null.	UrlRule
$mode	int|null	A value indicating if this rule should be used for both request parsing and URL creation, parsing only, or creation only. Default: null.	UrlRule
$name	string|null	The name of this rule. Default: null.	UrlRule
$normalizer	UrlNormalizer|array|false|null	The configuration for UrlNormalizer used by this rule. Default: null. Available since 2.0.10.	UrlRule
$pattern	string	The pattern used to parse and create the path info part of a URL. Default: null.	UrlRule
$route	string	The route to the controller action Default: null.	UrlRule
$suffix	string|null	The URL suffix used for this rule. Default: null.	UrlRule
$verb	string|array|null	The HTTP verb (e.g. Default: null.	UrlRule
$createStatus protected	int|null	Status of the URL creation after the last createUrl() call. Default: null. Available since 2.0.12.	UrlRule
$placeholders protected	array	List of placeholders for matching parameters names. Default: []. Available since 2.0.7.	UrlRule

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
__toString()		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() static	Returns the fully qualified name of this class.	yii\base\BaseObject
createUrl()	Creates a URL according to the given route and parameters.	UrlRule
getCreateUrlStatus()	Returns status of the URL creation after the last createUrl() call.	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.	UrlRule
parseRequest()	Parses the given request and returns the corresponding route and parameters.	UrlRule
getNormalizer() protected		UrlRule
getParamRules() protected	Returns list of regex for matching parameter.	UrlRule
hasNormalizer() protected		UrlRule
substitutePlaceholderNames() protected	Iterates over $placeholders and checks whether each placeholder exists as a key in $matches array.	UrlRule

Constants

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

Property details

$defaults

public array $defaults = []

The default GET parameters (name => value) that this rule provides.

When this rule is used to parse the incoming request, the values declared in this property will be injected into $_GET.

$mode

public int|null $mode = null

A value indicating if this rule should be used for both request parsing and URL creation, parsing only, or creation only.

If not set or 0, it means the rule is both request parsing and URL creation. If it is PARSING_ONLY, the rule is for request parsing only. If it is CREATION_ONLY, the rule is for URL creation only.

$name

public string|null $name = null

The name of this rule.

If not set, it will use $pattern as the name.

$normalizer

public yii\web\UrlNormalizer|array|false|null $normalizer = null

The configuration for UrlNormalizer used by this rule.

If null, UrlManager::$normalizer will be used, if false, normalization will be skipped for this rule.

Since

2.0.10

$suffix

public string|null $suffix = null

The URL suffix used for this rule.

For example, “.html” can be used so that the URL looks like pointing to a static HTML page. If not set, the value of UrlManager::$suffix will be used. Default values should be strings. Non-string values will be automatically converted to strings for comparison with URL parameters.

$verb

public string|array|null $verb = null

The HTTP verb (e.g.

GET, POST, DELETE) that this rule should match. Use array to represent multiple verbs that this rule may match. If this property is not set, the rule can match any verb. Note that this property is only used when parsing a request. It is ignored for URL creation.

$placeholders

protected array $placeholders = []

List of placeholders for matching parameters names.

Used in parseRequest(), createUrl(). On the rule initialization, the $pattern parameters names will be replaced with placeholders. This array contains relations between the original parameters names and their placeholders. The array keys are the placeholders and the values are the original names.

Since

2.0.7

Method details

__toString()

public function __toString(): string

Returns

string

Since

2.0.11

createUrl()

public function createUrl(yii\web\UrlManager $manager, string $route, array $params): string|bool

Creates a URL according to the given route and parameters.

Parameters

Parameter	Type	Description
$manager	UrlManager	The URL manager
$route	string	The route. It should not have slashes at the beginning or the end.
$params	array	The parameters

Returns

string|bool: The created URL, or false if this rule cannot be used for creating this URL.

getCreateUrlStatus()

public function getCreateUrlStatus(): int|null

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

Returns

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

Since

2.0.12

See also

• $createStatus

init()

public function init(): mixed

Initializes this rule.

Returns

mixed

parseRequest()

public function parseRequest(yii\web\UrlManager $manager, yii\web\Request $request): array|bool

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

Parameters

Parameter	Type	Description
$manager	UrlManager	The URL manager
$request	Request	The request component

Returns

array|bool: 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.

getNormalizer()

protected function getNormalizer(yii\web\UrlManager $manager): yii\web\UrlNormalizer|null

Parameters

Parameter	Type	Description
$manager	UrlManager	The URL manager

Returns

UrlNormalizer|null

Since

2.0.10

getParamRules()

protected function getParamRules(): array

Returns list of regex for matching parameter.

Returns

array: Parameter keys and regexp rules.

Since

2.0.6

hasNormalizer()

protected function hasNormalizer(yii\web\UrlManager $manager): bool

Parameters

Parameter	Type	Description
$manager	UrlManager	The URL manager

Returns

bool

Since

2.0.10

substitutePlaceholderNames()

protected function substitutePlaceholderNames(array $matches): array

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().

Parameters

Parameter	Type	Description
$matches	array	Result of preg_match() call

Returns

array: Input array with replaced placeholder keys

Since

2.0.7

See also

• $placeholders