HumHub Documentation (unofficial)

UrlManager extends Component
in package

Application

UrlManager handles HTTP request parsing and creation of URLs based on a set of rules.

UrlManager is configured as an application component in [[\yii\base\Application]] by default. You can access that instance via Yii::$app->urlManager.

You can modify its configuration by adding an array to your application config under components as it is shown in the following example:

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

Rules are classes implementing the [[UrlRuleInterface]], by default that is [[UrlRule]]. For nesting rules, there is also a [[GroupUrlRule]] class.

For more details and usage information on UrlManager, see the guide article on routing.

Properties

$baseUrl : string
$behaviors : array<string|int, Behavior>
$cache : CacheInterface|array<string|int, mixed>|string|bool
$enablePrettyUrl : bool
$enableStrictParsing : bool
$hostInfo : string
$normalizer : UrlNormalizer|array<string|int, mixed>|string|false
$routeParam : string
$ruleConfig : array<string|int, mixed>
$rules : array<string|int, mixed>
$scriptUrl : string
$showScriptName : bool
$suffix : string
$cacheKey : string
$_baseUrl : mixed
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_hostInfo : mixed
$_ruleCache : mixed
$_scriptUrl : mixed

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
addRules() : mixed: Adds additional URL rules.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
createAbsoluteUrl() : string: Creates an absolute URL using the given route and query parameters.
createUrl() : string: Creates a URL using the given route and query parameters.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
getBaseUrl() : string: Returns the base URL that is used by [[createUrl()]] to prepend to created URLs.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getHostInfo() : string: Returns the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs.
getScriptUrl() : string: Returns the entry script URL that is used by [[createUrl()]] to prepend to created URLs.
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes UrlManager.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
parseRequest() : array<string|int, mixed>|bool: Parses the user request.
setBaseUrl() : mixed: Sets the base URL that is used by [[createUrl()]] to prepend to created URLs.
setHostInfo() : mixed: Sets the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs.
setScriptUrl() : mixed: Sets the entry script URL that is used by [[createUrl()]] to prepend to created URLs.
trigger() : mixed: Triggers an event.
buildRules() : array<string|int, UrlRuleInterface>: Builds URL rule objects from the given rule declarations.
canBeCached() : bool: Returns the value indicating whether result of [[createUrl()]] of rule should be cached in internal cache.
getBuiltRulesFromCache() : array<string|int, UrlRuleInterface>|false: Provides the built URL rules that are associated with the $ruleDeclarations from cache.
getUrlFromCache() : bool|string: Get URL from internal cache if exists.
setBuiltRulesCache() : bool: Stores $builtRules to cache, using $rulesDeclaration as a part of cache key.
setRuleToCache() : mixed: Store rule (e.g. [[UrlRule]]) to internal cache.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.
ensureCache() : CacheInterface|null|bool

$baseUrl


    public
        string
    $baseUrl

The base URL that is used by [[createUrl()]] to prepend to created URLs.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$cache


    public
        CacheInterface|array<string|int, mixed>|string|bool
    $cache
     = 'cache'

the cache object or the application component ID of the cache object. This can also be an array that is used to create a [[CacheInterface]] instance in case you do not want to use an application component. Compiled URL rules will be cached through this cache object, if it is available.

After the UrlManager object is created, if you want to change this property, you should only assign it with a cache object. Set this property to false or null if you do not want to cache the URL rules.

Cache entries are stored for the time set by [[\yii\caching\Cache::$defaultDuration|$defaultDuration]] in the cache configuration, which is unlimited by default. You may want to tune this value if your [[rules]] change frequently.

$enablePrettyUrl


    public
        bool
    $enablePrettyUrl
     = false

whether to enable pretty URLs. Instead of putting all parameters in the query string part of a URL, pretty URLs allow using path info to represent some of the parameters and can thus produce more user-friendly URLs, such as "/news/Yii-is-released", instead of "/index.php?r=news%2Fview&id=100".

$enableStrictParsing


    public
        bool
    $enableStrictParsing
     = false

whether to enable strict parsing. If strict parsing is enabled, the incoming requested URL must match at least one of the [[rules]] in order to be treated as a valid request. Otherwise, the path info part of the request will be treated as the requested route. This property is used only when [[enablePrettyUrl]] is true.

$hostInfo


    public
        string
    $hostInfo

The host info (e.g. https://www.example.com) that is used by [[createAbsoluteUrl()]] to prepend to created URLs.

$normalizer


    public
        UrlNormalizer|array<string|int, mixed>|string|false
    $normalizer
     = false

the configuration for [[UrlNormalizer]] used by this UrlManager. The default value is false, which means normalization will be skipped. If you wish to enable URL normalization, you should configure this property manually. For example:

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

$routeParam


    public
        string
    $routeParam
     = 'r'

the GET parameter name for route. This property is used only if [[enablePrettyUrl]] is false.

$ruleConfig


    public
        array<string|int, mixed>
    $ruleConfig
     = ['class' => 'yii\web\UrlRule']

the default configuration of URL rules. Individual rule configurations specified via [[rules]] will take precedence when the same property of the rule is configured.

$rules


    public
        array<string|int, mixed>
    $rules
     = []

the rules for creating and parsing URLs when [[enablePrettyUrl]] is true. This property is used only if [[enablePrettyUrl]] is true. Each element in the array is the configuration array for creating a single URL rule. The configuration will be merged with [[ruleConfig]] first before it is used for creating the rule object.

A special shortcut format can be used if a rule only specifies [[UrlRule::pattern|pattern]] and [[UrlRule::route|route]]: 'pattern' => 'route'. That is, instead of using a configuration array, one can use the key to represent the pattern and the value the corresponding route. For example, 'post/<id:\d+>' => 'post/view'.

For RESTful routing the mentioned shortcut format also allows you to specify the [[UrlRule::verb|HTTP verb]] that the rule should apply for. You can do that by prepending it to the pattern, separated by space. For example, 'PUT post/<id:\d+>' => 'post/update'. You may specify multiple verbs by separating them with comma like this: 'POST,PUT post/index' => 'post/create'. The supported verbs in the shortcut format are: GET, HEAD, POST, PUT, PATCH and DELETE. Note that [[UrlRule::mode|mode]] will be set to PARSING_ONLY when specifying verb in this way so you normally would not specify a verb for normal GET request.

Here is an example configuration for RESTful CRUD controller:

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

    'POST <controller:[\w-]+>' => '<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',
];

Note that if you modify this property after the UrlManager object is created, make sure you populate the array with rule objects instead of rule configurations.

$scriptUrl


    public
        string
    $scriptUrl

The entry script URL that is used by [[createUrl()]] to prepend to created URLs.

$showScriptName


    public
        bool
    $showScriptName
     = true

whether to show entry script name in the constructed URL. Defaults to true. This property is used only if [[enablePrettyUrl]] is true.

$suffix


    public
        string
    $suffix

the URL suffix used when [[enablePrettyUrl]] is true. For example, ".html" can be used so that the URL looks like pointing to a static HTML page. This property is used only if [[enablePrettyUrl]] is true.

$cacheKey


    protected
        string
    $cacheKey
     = __CLASS__

the cache key for cached rules

$_baseUrl


    private
        mixed
    $_baseUrl

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

$_hostInfo


    private
        mixed
    $_hostInfo

$_ruleCache


    private
        mixed
    $_ruleCache

$_scriptUrl


    private
        mixed
    $_scriptUrl

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.


    public
                    __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

Initializes the object with the given configuration $config.
Call [[init()]].

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.


    public
                    __isset(string $name) : bool

This method will check in the following order and act accordingly:

a property defined by a setter: return whether the property is set
a property of a behavior: return whether the property is set
return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value to be null
a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters

$name : string: the property name

addRules()

Adds additional URL rules.


    public
                    addRules(array<string|int, mixed> $rules[, bool $append = true ]) : mixed

This method will call [[buildRules()]] to parse the given rule declarations and then append or insert them to the existing [[rules]].

Note that if [[enablePrettyUrl]] is false, this method will do nothing.

Parameters

$rules : array<string|int, mixed>: the new rules to be added. Each array element represents a single rule declaration. Please refer to [[rules]] for the acceptable rule format.
$append : bool = true: whether to add the new rules by appending them to the end of the existing rules.

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values

array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

createAbsoluteUrl()

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


    public
                    createAbsoluteUrl(string|array<string|int, mixed> $params[, string|null $scheme = null ]) : string

This method prepends the URL created by [[createUrl()]] with the [[hostInfo]].

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

Parameters

$params : string|array<string|int, mixed>: use a string to represent a route (e.g. site/index), or an array to represent a route with query parameters (e.g. ['site/index', 'param1' => 'value1']).
$scheme : string|null = null: the scheme to use for the URL (either http, https or empty string for protocol-relative URL). If not specified the scheme of the current request will be used.

Return values

string —

the created URL

createUrl()

Creates a URL using the given route and query parameters.


    public
                    createUrl(string|array<string|int, mixed> $params) : string

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.

Parameters

$params : string|array<string|int, mixed>: use a string to represent a route (e.g. site/index), or an array to represent a route with query parameters (e.g. ['site/index', 'param1' => 'value1']).

Return values

string —

the created URL

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.


    public
                    ensureBehaviors() : mixed

getBaseUrl()

Returns the base URL that is used by [[createUrl()]] to prepend to created URLs.


    public
                    getBaseUrl() : string

It defaults to [[Request::baseUrl]]. This is mainly used when [[enablePrettyUrl]] is true and [[showScriptName]] is false.

Return values

string —

the base URL that is used by [[createUrl()]] to prepend to created URLs.

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getHostInfo()

Returns the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs.


    public
                    getHostInfo() : string

Return values

string —

the host info (e.g. https://www.example.com) that is used by [[createAbsoluteUrl()]] to prepend to created URLs.

getScriptUrl()

Returns the entry script URL that is used by [[createUrl()]] to prepend to created URLs.


    public
                    getScriptUrl() : string

It defaults to [[Request::scriptUrl]]. This is mainly used when [[enablePrettyUrl]] is false or [[showScriptName]] is true.

Return values

string —

the entry script URL that is used by [[createUrl()]] to prepend to created URLs.

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

the class has a method with the specified name
an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes UrlManager.


    public
                    init() : mixed

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].
$append : bool = true: whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

parseRequest()

Parses the user request.


    public
                    parseRequest(Request $request) : array<string|int, mixed>|bool

Parameters

$request : Request: the request component

Return values

array<string|int, mixed>|bool —

the route and the associated parameters. The latter is always empty if [[enablePrettyUrl]] is false. false is returned if the current request cannot be successfully parsed.

setBaseUrl()

Sets the base URL that is used by [[createUrl()]] to prepend to created URLs.


    public
                    setBaseUrl(string $value) : mixed

This is mainly used when [[enablePrettyUrl]] is true and [[showScriptName]] is false.

Parameters

$value : string: the base URL that is used by [[createUrl()]] to prepend to created URLs.

setHostInfo()

Sets the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs.


    public
                    setHostInfo(string $value) : mixed

Parameters

$value : string: the host info (e.g. "https://www.example.com") that is used by [[createAbsoluteUrl()]] to prepend to created URLs.

setScriptUrl()

Sets the entry script URL that is used by [[createUrl()]] to prepend to created URLs.


    public
                    setScriptUrl(string $value) : mixed

This is mainly used when [[enablePrettyUrl]] is false or [[showScriptName]] is true.

Parameters

$value : string: the entry script URL that is used by [[createUrl()]] to prepend to created URLs.

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

buildRules()

Builds URL rule objects from the given rule declarations.


    protected
                    buildRules(array<string|int, mixed> $ruleDeclarations) : array<string|int, UrlRuleInterface>

Parameters

$ruleDeclarations : array<string|int, mixed>: the rule declarations. Each array element represents a single rule declaration. Please refer to [[rules]] for the acceptable rule formats.

Return values

array<string|int, UrlRuleInterface> —

the rule objects built from the given rule declarations

canBeCached()

Returns the value indicating whether result of [[createUrl()]] of rule should be cached in internal cache.


    protected
                    canBeCached(UrlRuleInterface $rule) : bool

Parameters

$rule : UrlRuleInterface

Return values

bool —

true if result should be cached, false if not.

getBuiltRulesFromCache()

Provides the built URL rules that are associated with the $ruleDeclarations from cache.


    protected
                    getBuiltRulesFromCache(array<string|int, mixed> $ruleDeclarations) : array<string|int, UrlRuleInterface>|false

Parameters

$ruleDeclarations : array<string|int, mixed>: the rule declarations. Each array element represents a single rule declaration. Please refer to [[rules]] for the acceptable rule formats.

Return values

array<string|int, UrlRuleInterface>|false —

the rule objects built from the given rule declarations or boolean false when there are no cache items for this definition exists.

getUrlFromCache()

Get URL from internal cache if exists.


    protected
                    getUrlFromCache(string $cacheKey, string $route, array<string|int, mixed> $params) : bool|string

Parameters

$cacheKey : string: generated cache key to store data.
$route : string: the route (e.g. site/index).
$params : array<string|int, mixed>: rule params.

Return values

bool|string —

the created URL

setBuiltRulesCache()

Stores $builtRules to cache, using $rulesDeclaration as a part of cache key.


    protected
                    setBuiltRulesCache(array<string|int, mixed> $ruleDeclarations, array<string|int, UrlRuleInterface> $builtRules) : bool

Parameters

$ruleDeclarations : array<string|int, mixed>: the rule declarations. Each array element represents a single rule declaration. Please refer to [[rules]] for the acceptable rule formats.
$builtRules : array<string|int, UrlRuleInterface>: the rule objects built from the given rule declarations.

Return values

bool —

whether the value is successfully stored into cache

setRuleToCache()

Store rule (e.g. [[UrlRule]]) to internal cache.


    protected
                    setRuleToCache(mixed $cacheKey, UrlRuleInterface $rule) : mixed

Parameters

$cacheKey : mixed
$rule : UrlRuleInterface

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

ensureCache()


    private
                    ensureCache() : CacheInterface|null|bool

Return values

CacheInterface|null|bool

UrlManager extends Component in package Application

Tags

Table of Contents

Properties

Methods

Properties

$baseUrl

$behaviors read-only

$cache

$enablePrettyUrl

$enableStrictParsing

$hostInfo

$normalizer

Tags

$routeParam

$ruleConfig

$rules

$scriptUrl

$showScriptName

$suffix

$cacheKey

Tags

$_baseUrl

$_behaviors

$_events

$_eventWildcards

Tags

$_hostInfo

$_ruleCache

$_scriptUrl

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

addRules()

Parameters

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

behaviors()

Return values

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

UrlManager extends Component
in package

Application