Skip to content

Y
yii2
Commit 5a84b812 by Alexander Makarov
Options

More on URL Management

parent f882b384
Showing with 113 additions and 11 deletions
docs/guide/url.md
URL Management
==============
The concept of URL management in Yii fairly simple. URL management is based on the premise that the application uses internal routes and parameters
everywhere. The framework itself will then translates routes into URLs, and translate URLs into routes, according to the URL manager's configuration.
This approach allows you to change site-wide URLs merely by editing a single config file, without ever touching the application code.
The concept of URL management in Yii fairly simple. URL management is based on the premise that the application uses
internal routes and parameters everywhere. The framework itself will then translates routes into URLs, and translate URLs
into routes, according to the URL manager's configuration. This approach allows you to change site-wide URLs merely by
editing a single config file, without ever touching the application code.
Internal route
--------------
When implementing an application using Yii, you'll deal with internal routes and parameters. Each controller and controller action has a corresponding internal route, such as `site/index` or `user/create`. In the former, `site` is referred to as the *controller ID* while `index` is referred to as the *action ID*. In the second example, `user` is the controller ID and `create` is the action ID. If controller belongs to a *module*, the internal route is prefixed with the module ID, such as `blog/post/index` for a blog module (with `post` being the controller ID and `index` being the action ID).
When implementing an application using Yii, you'll deal with internal routes, often referred to as routes, and parameters.
Each controller and controller action has a corresponding internal route, such as `site/index` or `user/create`.
In the former, `site` is referred to as the *controller ID* while `index` is referred to as the *action ID*. In the
second example, `user` is the controller ID and `create` is the action ID. If controller belongs to a *module*, the
internal route is prefixed with the module ID, such as `blog/post/index` for a blog module (with `post` being the
controller ID and `index` being the action ID).
Creating URLs
-------------
......@@ -20,8 +26,10 @@ application component with the `urlManager` ID. This component is accessible bot
- `createUrl($route, $params = [])`
- `createAbsoluteUrl($route, $params = [])`
The `createUrl` method creates a URL relative to the application root, such as `/index.php/site/index/`. The `createAbsoluteUrl` method creates URL prefixed with the proper protocol and
hostname: `http://www.example.com/index.php/site/index`. The former is suitable for internal application URLs, while the latter is used when you need to create rules for outside the website, such as when sending emails or generating an RSS feed.
The `createUrl` method creates a URL relative to the application root, such as `/index.php/site/index/`.
The `createAbsoluteUrl` method creates URL prefixed with the proper protocol and hostname:
`http://www.example.com/index.php/site/index`. The former is suitable for internal application URLs, while the latter
is used when you need to create rules for outside the website, such as when sending emails or generating an RSS feed.
Some examples:
......@@ -34,7 +42,8 @@ echo \Yii::$app->urlManager->createAbsoluteUrl('blog/post/index');
// http://www.example.com/index.php/blog/post/index/
```
The exact format of the outputted URL will depend upon how the URL manager is configured (which is the point). The above examples may also output:
The exact format of the outputted URL will depend upon how the URL manager is configured (which is the point). The above
examples may also output:
* `/site/page/id/about/`
* `/index.php?r=site/page&id=about`
......@@ -43,7 +52,8 @@ The exact format of the outputted URL will depend upon how the URL manager is co
* `http://www.example.com/blog/post/index/`
* `http://www.example.com/index.php?r=blog/post/index`
Inside a web application controller, you can use the controller's own `createUrl` shortcut method. Unlike the global `createUrl` method, the controller version is context sensitive:
Inside a web application controller, you can use the controller's own `createUrl` shortcut method. Unlike the global
`createUrl` method, the controller version is context sensitive:
```php
echo $this->createUrl(''); // currently active route
......@@ -61,7 +71,10 @@ Customizing URLs
----------------
By default, Yii uses a query string format for URLs, such as `/index.php?r=news/view&id=100`. In order to make URLs
human-friendly (i.e., more readable), you need to configure the `urlManager` component in the application's configuration file. Enabling "pretty" URLs will convert the query string format to a directory-based format: `/index.php/news/view/id/100`. Disabling the `showScriptName` parameter means that `index.php` will not be part of the URLs. Here's the relevant part of the application's configuration file.
human-friendly (i.e., more readable), you need to configure the `urlManager` component in the application's configuration
file. Enabling "pretty" URLs will convert the query string format to a directory-based format: `/index.php/news/view?id=100`.
Disabling the `showScriptName` parameter means that `index.php` will not be part of the URLs. Here's the relevant part of
the application's configuration file:
```php
<?php
......@@ -76,11 +89,100 @@ return [
];
```
Note that this configuration will only work if the web server has been properly configured for Yii, see [installation](installation.md#recommended-apache-configuration).
Note that this configuration will only work if the web server has been properly configured for Yii, see
[installation](installation.md#recommended-apache-configuration).
### Named parameters
### Handling subdomains
A rule can be associated with a few GET parameters. These GET parameters appear in the rule's pattern as special tokens
in the following format:
```
<ParameterName:ParameterPattern>
```
`ParameterName` is a name of a GET parameter, and the optional `ParameterPattern` is the regular expression that should
be used to match the value of the GET parameter. In case when `ParameterPattern` is omitted, it means the parameter
should match any characters except `/`. When creating a URL, these parameter tokens will be replaced with the
corresponding parameter values; when parsing a URL, the corresponding GET parameters will be populated with the parsed results.
Let's use some examples to explain how URL rules work. We assume that our rule set consists of three rules:
```php
[
'posts'=>'post/list',
'post/<id:\d+>'=>'post/read',
'post/<year:\d{4}>/<title>'=>'post/read',
]
```
- Calling `$this->createUrl('post/list')` generates `/index.php/posts`. The first rule is applied.
- Calling `$this->createUrl('post/read', ['id' => 100])` generates `/index.php/post/100`. The second rule is applied.
- Calling `$this->createUrl('post/read', ['year' => 2008, 'title' => 'a sample post'])` generates
`/index.php/post/2008/a%20sample%20post`. The third rule is applied.
- Calling `$this->createUrl('post/read')` generates `/index.php/post/read`. None of the rules is applied, convention is used
instead.
In summary, when using `createUrl` to generate a URL, the route and the GET parameters passed to the method are used to
decide which URL rule to be applied. If every parameter associated with a rule can be found in the GET parameters passed
to `createUrl`, and if the route of the rule also matches the route parameter, the rule will be used to generate the URL.
If the GET parameters passed to `createUrl` are more than those required by a rule, the additional parameters will appear
in the query string. For example, if we call `$this->createUrl('post/read', ['id' => 100, 'year' => 2008])`, we would
obtain `/index.php/post/100?year=2008`.
As we mentioned, the other purpose of URL rules is to parse the requesting URLs. Naturally, this is an inverse process
of URL creation. For example, when a user requests for `/index.php/post/100`, the second rule in the above example will
apply, which resolves in the route `post/read` and the GET parameter `['id' => 100]` (accessible via
`Yii::$app->request->get`).
### Parameterizing Routes
We may reference named parameters in the route part of a rule. This allows a rule to be applied to multiple routes based
on matching criteria. It may also help reduce the number of rules needed for an application, and thus improve the overall
performance.
We use the following example rules to illustrate how to parameterize routes with named parameters:
```php
[
'<controller:(post|comment)>/<id:\d+>/<action:(create|update|delete)>' => '<controller>/<action>',
'<controller:(post|comment)>/<id:\d+>' => '<controller>/read',
'<controller:(post|comment)>s' => '<controller>/list',
]
```
In the above, we use two named parameters in the route part of the rules: `controller` and `action`. The former matches
a controller ID to be either post or comment, while the latter matches an action ID to be create, update or delete.
You may name the parameters differently as long as they do not conflict with GET parameters that may appear in URLs.
Using the above rules, the URL `/index.php/post/123/create` would be parsed as the route `post/create` with GET parameter
`id=123`. And given the route `comment/list` and GET parameter `page=2`, we can create a URL `/index.php/comments?page=2`.
### Parameterizing hostnames
It is also possible to include hostname into the rules for parsing and creating URLs. One may extract part of the hostname
to be a GET parameter that is especially useful for handling subdomains. For example, the URL
`http://admin.example.com/en/profile` may be parsed into GET parameters `user=admin` and `lang=en`. On the other hand,
rules with hostname may also be used to create URLs with parameterized hostnames.
In order to use parameterized hostnames, simply declare URL rules with host info, e.g.:
```php
[
'http://<user:\w+>.example.com/<lang:\w+>/profile' => 'user/profile',
]
```
The above example says that the first segment in the hostname should be treated as user parameter while the first segment
in the path info should be lang parameter. The rule corresponds to the `user/profile` route.
Note that [[UrlManager::showScriptName]] will not take effect when a URL is being created using a rule with parameterized
hostname.
Also note that the rule with parameterized hostname should NOT contain the sub-folder if the application is under
a sub-folder of the Web root. For example, if the application is under `http://www.example.com/sandbox/blog`, then we
should still use the same URL rule as described above without the sub-folder `sandbox/blog`.
### Faking URL Suffix
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment