Интерфейс yii\web\UrlRuleInterface
| Реализовано в | yii\rest\UrlRule, yii\web\CompositeUrlRule, yii\web\GroupUrlRule, yii\web\UrlRule |
|---|---|
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/web/UrlRuleInterface.php |
UrlRuleInterface — это интерфейс, который должны реализовывать классы правил URL.
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| createUrl() | Создаёт URL по заданному маршруту и параметрам. | yii\web\UrlRuleInterface |
| parseRequest() | Парсит заданный запрос и возвращает соответствующий маршрут и параметры. | yii\web\UrlRuleInterface |
Подробное описание методов
createUrl() public абстрактный метод
Создаёт URL по заданному маршруту и параметрам.
| public abstract string|boolean createUrl ( $manager, $route, $params ) | ||
|---|---|---|
| $manager | yii\web\UrlManager |
Менеджер URL |
| $route | string |
Маршрут. Не должен содержать слешей в начале или конце. |
| $params | array |
Параметры |
| return | string|boolean |
Созданный URL или false, если это правило не может быть использовано для создания этого URL. |
parseRequest() public абстрактный метод
Парсит заданный запрос и возвращает соответствующий маршрут и параметры.
| public abstract array|boolean parseRequest ( $manager, $request ) | ||
|---|---|---|
| $manager | yii\web\UrlManager |
Менеджер URL |
| $request | yii\web\Request |
Компонент запроса |
| return | array|boolean |
Результат парсинга. Маршрут и параметры возвращаются в виде массива. Если false, значит это правило не может быть использовано для парсинга этого пути. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-urlruleinterface.html
