CBaseUrlRule
| Пакет | system.web |
|---|---|
| Наследование | абстрактный класс CBaseUrlRule » CComponent |
| Подклассы | CUrlRule |
| С момента | 1.1.8 |
| Исходный код | framework/web/CUrlManager.php |
CBaseUrlRule — базовый класс для класса правила URL.
Пользовательские классы правил URL должны расширять этот класс и реализовывать два метода: createUrl и parseUrl.
Пользовательские классы правил URL должны расширять этот класс и реализовывать два метода: createUrl и parseUrl.
Свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| hasHostInfo | boolean | указывает, будет ли это правило также анализировать часть информации о хосте. | CBaseUrlRule |
Методы
| Метод | Описание | Определено |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | CComponent |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства нулевым. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в значение null. | CComponent |
| asa() | Возвращает объект поведения с указанным именем. | CComponent |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | CComponent |
| attachEventHandler() | Прикрепляет обработчик событий к событию. | CComponent |
| canGetProperty() | Определяет, можно ли считать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| createUrl() | Создает URL на основе этого правила. | CBaseUrlRule |
| detachBehavior() | Открепляет поведение от компонента. | CComponent |
| detachBehaviors() | Открепляет все поведения от компонента. | CComponent |
| detachEventHandler() | Открепляет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает прикрепленное поведение. | CComponent |
| disableBehaviors() | Отключает все прикрепленные поведения к этому компоненту. | CComponent |
| enableBehavior() | Включает прикрепленное поведение. | CComponent |
| enableBehaviors() | Включает все прикрепленные к этому компоненту поведения. | CComponent |
| evaluateExpression() | Вычисляет PHP выражение или обратный вызов в контексте этого компонента. | CComponent |
| getEventHandlers() | Возвращает список прикрепленных обработчиков событий для события. | CComponent |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли прикрепленные обработчики для указанного события. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| parseUrl() | Парсит URL на основе этого правила. | CBaseUrlRule |
| raiseEvent() | Вызывает событие. | CComponent |
Подробное описание свойств
hasHostInfo свойство
public boolean $hasHostInfo;
указывает, будет ли это правило также анализировать часть информации о хосте. По умолчанию false.
Подробное описание методов
createUrl() метод
abstract public mixed createUrl(CUrlManager $manager, string $route, array $params, string $ampersand) | ||
| $manager | CUrlManager | менеджер |
| $route | string | маршрут |
| $params | array | список параметров (имя=>значение), связанных с маршрутом |
| $ampersand | string | разделитель пар имя-значение в URL. |
| {return} | mixed | сформированный URL. False, если это правило не применяется. |
Исходный код: framework/web/CUrlManager.php#543 (показать)
abstract public function createUrl($manager,$route,$params,$ampersand);
Создает URL на основе этого правила.
parseUrl() метод
abstract public mixed parseUrl(CUrlManager $manager, CHttpRequest $request, string $pathInfo, string $rawPathInfo) | ||
| $manager | CUrlManager | менеджер URL |
| $request | CHttpRequest | объект запроса |
| $pathInfo | string | часть пути URL (суффикс URL уже удален на основе CUrlManager::urlSuffix) |
| $rawPathInfo | string | путь URL, который может содержать суффикс URL |
| {return} | mixed | маршрут, состоящий из идентификатора контроллера и идентификатора действия. False, если это правило не применяется. |
Исходный код: framework/web/CUrlManager.php#552 (показать)
abstract public function parseUrl($manager,$request,$pathInfo,$rawPathInfo);
Парсит URL на основе этого правила.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CBaseUrlRule
