Класс yii\web\UrlManager

UrlManager обрабатывает парсинг HTTP-запросов и создание URL-адресов на основе набора правил.

UrlManager настраивается как компонент приложения в yii\base\Application по умолчанию. Вы можете получить доступ к этому экземпляру через Yii::$app->urlManager.

Вы можете изменить его конфигурацию, добавив массив в вашу конфигурацию приложения в components, как показано в следующем примере:

'urlManager' => [
    'enablePrettyUrl' => true,
    'rules' => [
        // your rules go here
    ],
    // ...
]

Правила — это классы, реализующие интерфейс yii\web\UrlRuleInterface, по умолчанию это yii\web\UrlRule. Для вложенных правил также есть класс yii\web\GroupUrlRule.

Для получения более подробной информации и использования UrlManager, см. статью руководства по маршрутизации.

Открытые свойства

Защищённые свойства

Открытые методы

Защищённые методы

Подробное описание свойств

$baseUrl открытое свойство

Базовый URL, используемый createUrl() для добавления в созданные URL.

public string getBaseUrl ( )
public void setBaseUrl ( $value )

$cache открытое свойство

Объект кэша или идентификатор компонента приложения объекта кэша. Компилированные правила URL будут кэшироваться через этот объект кэша, если он доступен.

После создания объекта UrlManager, если вы хотите изменить это свойство, вы должны присвоить ему только объект кэша. Установите это свойство в false если вы не хотите кешировать правила URL.

public yii\caching\CacheInterface|string $cache = 'cache'

$cacheKey защищённое свойство (доступно с версии 2.0.8)

Ключ кэша для кэшированных правил

protected string $cacheKey = __CLASS__

$enablePrettyUrl открытое свойство

Включить красивые URL. Вместо того, чтобы помещать все параметры в часть строки запроса URL, красивые URL позволяют использовать путь информации для представления некоторых параметров и, таким образом, могут создавать более удобные для пользователя URL, такие как "/news/Yii-is-released", вместо "/index.php?r=news%2Fview&id=100".

public boolean $enablePrettyUrl = false

$enableStrictParsing открытое свойство

Включить строгий разбор. Если строгий разбор включён, запрашиваемый URL должен соответствовать хотя бы одному из правил $rules, чтобы быть обработан как допустимый запрос. В противном случае, часть пути запроса будет обработана как запрашиваемый маршрут. Это свойство используется только когда $enablePrettyUrl равно true.

public boolean $enableStrictParsing = false

$hostInfo общественное свойство

Информация о хосте (например, http://www.example.com), используемая createAbsoluteUrl() для добавления в создаваемые URL-адреса.

public string getHostInfo ( )
public void setHostInfo ( $value )

$normalizer общественное свойство (доступно с версии 2.0.10)

Настройка yii\web\UrlNormalizer, используемая этим UrlManager. Значение по умолчанию false, что означает, что нормализация URL будет пропущена. Если вы хотите включить нормализацию URL, вы должны настроить это свойство вручную. Например:

[
    'class' => 'yii\web\UrlNormalizer',
    'collapseSlashes' => true,
    'normalizeTrailingSlash' => true,
]

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

$routeParam общественное свойство

Имя параметра GET для маршрута. Это свойство используется только если $enablePrettyUrl false.

public string $routeParam = 'r'

$ruleConfig общественное свойство

Настройка правил URL по умолчанию. Индивидуальные настройки правил, указанные через $rules, будут иметь приоритет, когда одно и то же свойство правила настроено.

public array $ruleConfig = ['class' => 'yii\web\UrlRule']

$rules общественное свойство

Правила создания и анализа URL-адресов, когда $enablePrettyUrl true. Это свойство используется только если $enablePrettyUrl true. Каждый элемент массива — это массив настроек для создания одного правила URL. Настройки будут сначала объединены с $ruleConfig, прежде чем будут использоваться для создания объекта правила.

Можно использовать специальный сокращенный формат, если правило указывает только шаблон и маршрут: 'pattern' => 'route'. То есть, вместо использования массива конфигурации, можно использовать ключ для представления шаблона, а значение — соответствующего маршрута. Например, 'post/<id:\d+>' => 'post/view'.

Для RESTful маршрутизации указанный сокращенный формат также позволяет указать HTTP-глагол, для которого правило должно применяться. Можно сделать это, добавив его перед шаблоном, разделенным пробелом. Например, 'PUT post/<id:\d+>' => 'post/update'. Вы можете указать несколько глаголов, разделив их запятыми, например: 'POST,PUT post/index' => 'post/create'. Поддерживаемые глаголы в сокращенном формате: GET, HEAD, POST, PUT, PATCH и DELETE. Обратите внимание, что режим будет установлен в PARSING_ONLY при указании глагола таким образом, поэтому обычно вы не укажете глагол для обычного запроса GET.

Вот пример конфигурации для RESTful контроллера CRUD:

[
    'dashboard' => 'site/index',

    'POST <controller:[\w-]+>s' => '<controller>/create',
    '<controller:[\w-]+>s' => '<controller>/index',

    'PUT <controller:[\w-]+>/<id:\d+>'    => '<controller>/update',
    'DELETE <controller:[\w-]+>/<id:\d+>' => '<controller>/delete',
    '<controller:[\w-]+>/<id:\d+>'        => '<controller>/view',
];

Обратите внимание, что если вы измените это свойство после создания объекта UrlManager, убедитесь, что вы заполняете массив объектами правила, а не конфигурациями правил.

public array $rules = []

$scriptUrl общественное свойство

URL-адрес скрипта входа, используемый createUrl() для добавления в создаваемые URL-адреса.

public string getScriptUrl ( )
public void setScriptUrl ( $value )

$showScriptName общественное свойство

Показывать ли имя скрипта входа в созданном URL. По умолчанию true. Это свойство используется только если $enablePrettyUrl true.

public boolean $showScriptName = true

$suffix общественное свойство

Суффикс URL, используемый, когда $enablePrettyUrl true. Например, ".html" может быть использован, чтобы URL выглядел, как указывающий на статическую HTML-страницу. Это свойство используется только если $enablePrettyUrl true.

public string $suffix = null

Подробное описание методов

// generates: /index.php?r=site%2Findex&param1=value1&param2=value2
['site/index', 'param1' => 'value1', 'param2' => 'value2']

// generates: /index.php?r=site%2Findex&param1=value1#name
['site/index', 'param1' => 'value1', '#' => 'name']