Method Details

__construct() public method #

Constructor.

public void __construct ( array $config = [] )

buildRules() protected method #

Builds URL rule objects from the given rule declarations.

protected yii\web\UrlRuleInterface buildRules ( $rules )

createAbsoluteUrl() public method #

Creates an absolute URL using the given route and query parameters.

This method prepends the URL created by createUrl() with the \craft\web\hostInfo.

Note that unlike yii\helpers\Url::toRoute(), this method always treats the given route as an absolute route.

public string createAbsoluteUrl ( $params, $scheme = null )

createUrl() public method #

Creates a URL using the given route and query parameters.

You may specify the route as a string, e.g., site/index. You may also use an array if you want to specify additional query parameters for the URL being created. The array format must be:

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

If you want to create a URL with an anchor, you can use the array format with a # parameter. For example,

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

The URL created is a relative one. Use createAbsoluteUrl() to create an absolute URL.

Note that unlike yii\helpers\Url::toRoute(), this method always treats the given route as an absolute route.

public string createUrl ( $params )

getMatchedElement() public method #

Returns the element that was matched by the URI.

public craft\base\ElementInterface, false getMatchedElement ( )

getRouteParams() public method #

Returns the route params, or null if we haven't parsed the URL yet.

public array, null getRouteParams ( )

parseRequest() public method #

Parses the user request.

public array, boolean parseRequest ( $request )

setRouteParams() public method #

Sets params to be passed to the routed controller action.

public void setRouteParams ( array $params )

Event Details

EVENT_REGISTER_CP_URL_RULES event of type craft\events\RegisterUrlRulesEvent #

The event that is triggered when registering URL rules for the Control Panel.

This event gets called during class initialization, so you should always use a class-level event handler.

use craft\events\RegisterUrlRulesEvent;
use craft\web\UrlManager;
use yii\base\Event;
Event::on(UrlManager::class, UrlManager::EVENT_REGISTER_CP_URL_RULES, function(RegisterUrlRulesEvent $e) {
    $e->rules['foo'] => 'bar/baz';
});

EVENT_REGISTER_SITE_URL_RULES event of type craft\events\RegisterUrlRulesEvent #

The event that is triggered when registering URL rules for the front-end site.

This event gets called during class initialization, so you should always use a class-level event handler.

use craft\events\RegisterUrlRulesEvent;
use craft\web\UrlManager;
use yii\base\Event;
Event::on(UrlManager::class, UrlManager::EVENT_REGISTER_SITE_URL_RULES, function(RegisterUrlRulesEvent $e) {
    $e->rules['foo'] => 'bar/baz';
});