HumHub Documentation (unofficial)

SafeBaseUrl extends BaseUrl
in package

Application

SafeBaseUrl Helper to use host from general setting "Base URL"

Properties

$urlManager : UrlManager

Methods

base() : string: Returns the base URL of the current request.
canonical() : string: Returns the canonical URL of the currently requested page.
current() : string: Creates a URL by using the current route and the GET parameters.
ensureScheme() : string: Normalize the URL by ensuring it uses specified scheme.
home() : string: Returns the home URL.
isRelative() : bool: Returns a value indicating whether a URL is relative.
previous() : string|null: Returns the URL previously [[remember()|remembered]].
remember() : mixed: Remembers the specified URL so that it can be later fetched back by [[previous()]].
to() : string: Creates a URL based on the given parameters.
toRoute() : string: Creates a URL for the given route.
getUrlManager() : UrlManager
normalizeRoute() : string: Normalizes route and makes it suitable for UrlManager. Absolute routes are staying as is while relative routes are converted to absolute ones.

$urlManager


    public
    static    UrlManager
    $urlManager

URL manager to use for creating URLs

base()

Returns the base URL of the current request.


    public
            static        base([bool|string $scheme = false ]) : string

Parameters

$scheme : bool|string = false

the URI scheme to use in the returned base URL:

false (default): returning the base URL without host info.
true: returning an absolute base URL whose scheme is the same as that in [[\yii\web\UrlManager::$hostInfo]].
string: returning an absolute base URL with the specified scheme (either http, https or empty string for protocol-relative URL).

Return values

string

canonical()

Returns the canonical URL of the currently requested page.


    public
            static        canonical() : string

The canonical URL is constructed using the current controller's [[\yii\web\Controller::route]] and [[\yii\web\Controller::actionParams]]. You may use the following code in the layout view to add a link tag about canonical URL:

$this->registerLinkTag(['rel' => 'canonical', 'href' => Url::canonical()]);

Return values

string —

the canonical URL of the currently requested page

current()

Creates a URL by using the current route and the GET parameters.


    public
            static        current([array<string|int, mixed> $params = [] ][, bool|string $scheme = false ]) : string

You may modify or remove some of the GET parameters, or add additional query parameters through the $params parameter. In particular, if you specify a parameter to be null, then this parameter will be removed from the existing GET parameters; all other parameters specified in $params will be merged with the existing GET parameters. For example,

// assume $_GET = ['id' => 123, 'src' => 'google'], current route is "post/view"

// /index.php?r=post%2Fview&id=123&src=google
echo Url::current();

// /index.php?r=post%2Fview&id=123
echo Url::current(['src' => null]);

// /index.php?r=post%2Fview&id=100&src=google
echo Url::current(['id' => 100]);

Note that if you're replacing array parameters with [] at the end you should specify $params as nested arrays. For a PostSearchForm model where parameter names are PostSearchForm[id] and PostSearchForm[src] the syntax would be the following:

// index.php?r=post%2Findex&PostSearchForm%5Bid%5D=100&PostSearchForm%5Bsrc%5D=google
echo Url::current([
    $postSearch->formName() => ['id' => 100, 'src' => 'google'],
]);

Parameters

$params : array<string|int, mixed> = []

an associative array of parameters that will be merged with the current GET parameters. If a parameter value is null, the corresponding GET parameter will be removed.

$scheme : bool|string = false

the URI scheme to use in the generated URL:

false (default): generating a relative URL.
true: returning an absolute base URL whose scheme is the same as that in [[\yii\web\UrlManager::$hostInfo]].
string: generating an absolute URL with the specified scheme (either http, https or empty string for protocol-relative URL).

Return values

string —

the generated URL

ensureScheme()

Normalize the URL by ensuring it uses specified scheme.


    public
            static        ensureScheme(string $url, string $scheme) : string

If the URL is relative or the scheme is not a string, normalization is skipped.

Parameters

$url : string: the URL to process
$scheme : string: the URI scheme used in the URL (e.g. http or https). Use an empty string to create protocol-relative URL (e.g. //example.com/path)

Return values

string —

the processed URL

home()

Returns the home URL.


    public
            static        home([bool|string $scheme = false ]) : string

Parameters

$scheme : bool|string = false

the URI scheme to use for the returned URL:

false (default): returning a relative URL.
true: returning an absolute base URL whose scheme is the same as that in [[\yii\web\UrlManager::$hostInfo]].
string: returning an absolute URL with the specified scheme (either http, https or empty string for protocol-relative URL).

Return values

string —

home URL

isRelative()

Returns a value indicating whether a URL is relative.


    public
            static        isRelative(string $url) : bool

A relative URL does not have host info part.

Parameters

$url : string: the URL to be checked

Return values

bool —

whether the URL is relative

previous()

Returns the URL previously [[remember()|remembered]].


    public
            static        previous([string|null $name = null ]) : string|null

Parameters

$name : string|null = null: the named associated with the URL that was remembered previously. If not set, [[\yii\web\User::getReturnUrl()]] will be used to obtain remembered URL.

Return values

string|null —

the URL previously remembered. Null is returned if no URL was remembered with the given name and $name is not specified.

remember()

Remembers the specified URL so that it can be later fetched back by [[previous()]].


    public
            static        remember([string|array<string|int, mixed> $url = '' ][, string|null $name = null ]) : mixed

Parameters

$url : string|array<string|int, mixed> = '': the URL to remember. Please refer to [[to()]] for acceptable formats. If this parameter is not specified, the currently requested URL will be used.
$name : string|null = null: the name associated with the URL to be remembered. This can be used later by [[previous()]]. If not set, [[\yii\web\User::setReturnUrl()]] will be used with passed URL.

to()

Creates a URL based on the given parameters.


    public
            static        to([array<string|int, mixed>|string $url = '' ][, bool|string $scheme = false ]) : string

This method is very similar to [[toRoute()]]. The only difference is that this method requires a route to be specified as an array only. If a string is given, it will be treated as a URL. In particular, if $url is

an array: [[toRoute()]] will be called to generate the URL. For example: ['site/index'], ['post/index', 'page' => 2]. Please refer to [[toRoute()]] for more details on how to specify a route.
a string with a leading @: it is treated as an alias, and the corresponding aliased string will be returned.
an empty string: the currently requested URL will be returned;
a normal string: it will be returned as is.

When $scheme is specified (either a string or true), an absolute URL with host info (obtained from [[\yii\web\UrlManager::$hostInfo]]) will be returned. If $url is already an absolute URL, its scheme will be replaced with the specified one.

Below are some examples of using this method:

// /index.php?r=site%2Findex
echo Url::to(['site/index']);

// /index.php?r=site%2Findex&src=ref1#name
echo Url::to(['site/index', 'src' => 'ref1', '#' => 'name']);

// /index.php?r=post%2Findex     assume the alias "@posts" is defined as "/post/index"
echo Url::to(['@posts']);

// the currently requested URL
echo Url::to();

// /images/logo.gif
echo Url::to('@web/images/logo.gif');

// images/logo.gif
echo Url::to('images/logo.gif');

// https://www.example.com/images/logo.gif
echo Url::to('@web/images/logo.gif', true);

// https://www.example.com/images/logo.gif
echo Url::to('@web/images/logo.gif', 'https');

// //www.example.com/images/logo.gif
echo Url::to('@web/images/logo.gif', '');

Parameters

$url : array<string|int, mixed>|string = ''

the parameter to be used to generate a valid URL

$scheme : bool|string = false

the URI scheme to use in the generated URL:

false (default): generating a relative URL.
true: returning an absolute base URL whose scheme is the same as that in [[\yii\web\UrlManager::$hostInfo]].
string: generating an absolute URL with the specified scheme (either http, https or empty string for protocol-relative URL).

Return values

string —

the generated URL

toRoute()

Creates a URL for the given route.


    public
            static        toRoute(string|array<string|int, mixed> $route[, bool|string $scheme = false ]) : string

This method will use [[\yii\web\UrlManager]] to create a URL.

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/index&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/index&param1=value1#name
['site/index', 'param1' => 'value1', '#' => 'name']

A route may be either absolute or relative. An absolute route has a leading slash (e.g. /site/index), while a relative route has none (e.g. site/index or index). A relative route will be converted into an absolute one by the following rules:

If the route is an empty string, the current [[\yii\web\Controller::route|route]] will be used;
If the route contains no slashes at all (e.g. index), it is considered to be an action ID of the current controller and will be prepended with [[\yii\web\Controller::uniqueId]];
If the route has no leading slash (e.g. site/index), it is considered to be a route relative to the current module and will be prepended with the module's [[\yii\base\Module::uniqueId|uniqueId]].

Starting from version 2.0.2, a route can also be specified as an alias. In this case, the alias will be converted into the actual route first before conducting the above transformation steps.

Below are some examples of using this method:

// /index.php?r=site%2Findex
echo Url::toRoute('site/index');

// /index.php?r=site%2Findex&src=ref1#name
echo Url::toRoute(['site/index', 'src' => 'ref1', '#' => 'name']);

// https://www.example.com/index.php?r=site%2Findex
echo Url::toRoute('site/index', true);

// https://www.example.com/index.php?r=site%2Findex
echo Url::toRoute('site/index', 'https');

// /index.php?r=post%2Findex     assume the alias "@posts" is defined as "post/index"
echo Url::toRoute('@posts');

Parameters

$route : string|array<string|int, mixed>

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

$scheme : bool|string = false

the URI scheme to use in the generated URL:

false (default): generating a relative URL.
true: returning an absolute base URL whose scheme is the same as that in [[\yii\web\UrlManager::$hostInfo]].
string: generating an absolute URL with the specified scheme (either http, https or empty string for protocol-relative URL).

Return values

string —

the generated URL

getUrlManager()


    protected
            static        getUrlManager() : UrlManager

Return values

UrlManager —

URL manager used to create URLs

normalizeRoute()

Normalizes route and makes it suitable for UrlManager. Absolute routes are staying as is while relative routes are converted to absolute ones.


    protected
            static        normalizeRoute(string $route) : string

A relative route is a route without a leading slash, such as "view", "post/view".

If the route is an empty string, the current [[\yii\web\Controller::route|route]] will be used;
If the route contains no slashes at all, it is considered to be an action ID of the current controller and will be prepended with [[\yii\web\Controller::uniqueId]];
If the route has no leading slash, it is considered to be a route relative to the current module and will be prepended with the module's uniqueId.

Starting from version 2.0.2, a route can also be specified as an alias. In this case, the alias will be converted into the actual route first before conducting the above transformation steps.

Parameters

$route : string: the route. This can be either an absolute route or a relative route.

Return values

string —

normalized route suitable for UrlManager

SafeBaseUrl extends BaseUrl in package Application

Tags

Table of Contents

Properties

Methods

Properties

$urlManager

Tags

Methods

base()

Parameters

Return values

canonical()

Return values

current()

Parameters

Tags

Return values

ensureScheme()

Parameters

Tags

Return values

home()

Parameters

Return values

isRelative()

Parameters

Return values

previous()

Parameters

Tags

Return values

remember()

Parameters

Tags

to()

Parameters

Tags

Return values

toRoute()

Parameters

Tags

Return values

getUrlManager()

Tags

Return values

normalizeRoute()

Parameters

Tags

Return values

SafeBaseUrl extends BaseUrl
in package

Application