@api
- Since
- 100.0.2
Definition at line 12 of file UrlInterface.php.
◆ addQueryParams()
addQueryParams |
( |
array |
$data | ) |
|
Add query parameters
- Parameters
-
- Returns
- \Magento\Framework\UrlInterface
Implemented in Url.
◆ addSessionParam()
Add session param
- Returns
- \Magento\Framework\UrlInterface
Implemented in Url.
◆ escape()
Escape (enclosure) URL string
- Parameters
-
- Returns
- string
Implemented in Url.
◆ getBaseUrl()
getBaseUrl |
( |
|
$params = [] | ) |
|
Retrieve Base URL
- Parameters
-
- Returns
- string
Implemented in Url.
◆ getCurrentUrl()
Retrieve current url with port number (if not default used)
- Returns
- string
Implemented in Url.
◆ getDirectUrl()
getDirectUrl |
( |
|
$url, |
|
|
|
$params = [] |
|
) |
| |
Build url by direct url and parameters
- Parameters
-
- Returns
- string
Implemented in Url.
◆ getRedirectUrl()
Return frontend redirect URL with SID and other session parameters if any
- Parameters
-
- Returns
- string
Implemented in Url.
◆ getRouteUrl()
getRouteUrl |
( |
|
$routePath = null , |
|
|
|
$routeParams = null |
|
) |
| |
Retrieve route URL
- Parameters
-
string | $routePath | |
array | $routeParams | |
- Returns
- string
Implemented in Url.
◆ getUrl()
getUrl |
( |
|
$routePath = null , |
|
|
|
$routeParams = null |
|
) |
| |
Build url by requested path and parameters
- Parameters
-
string | null | $routePath | |
array | null | $routeParams | |
- Returns
- string
Implemented in Url, and Url.
◆ getUseSession()
Retrieve use session rule
- Returns
- bool @SuppressWarnings(PHPMD.BooleanGetMethodName)
Implemented in Url.
◆ isOwnOriginUrl()
Check if users originated URL is one of the domain URLs assigned to stores
- Returns
- boolean
Implemented in Url.
◆ sessionUrlVar()
Replace Session ID value in URL
- Parameters
-
- Returns
- string
Implemented in Url.
◆ setQueryParam()
setQueryParam |
( |
|
$key, |
|
|
|
$data |
|
) |
| |
Set query param
- Parameters
-
- Returns
- \Magento\Framework\UrlInterface
Implemented in Url.
◆ setScope()
Set scope entity
- Parameters
-
- Returns
- \Magento\Framework\UrlInterface
Implemented in Url.
◆ DEFAULT_ACTION_NAME
const DEFAULT_ACTION_NAME = 'index' |
◆ DEFAULT_CONTROLLER_NAME
const DEFAULT_CONTROLLER_NAME = 'index' |
◆ DEFAULT_URL_TYPE
const DEFAULT_URL_TYPE = 'link' |
#- Default url type
Equals to self::URL_TYPE_LINK
Definition at line 30 of file UrlInterface.php.
◆ REWRITE_REQUEST_PATH_ALIAS
const REWRITE_REQUEST_PATH_ALIAS = 'rewrite_request_path' |
◆ SESSION_NAMESPACE
const SESSION_NAMESPACE = 'frontend' |
◆ URL_TYPE_DIRECT_LINK
const URL_TYPE_DIRECT_LINK = 'direct_link' |
◆ URL_TYPE_JS
◆ URL_TYPE_LINK
const URL_TYPE_LINK = 'link' |
◆ URL_TYPE_MEDIA
const URL_TYPE_MEDIA = 'media' |
◆ URL_TYPE_STATIC
const URL_TYPE_STATIC = 'static' |
◆ URL_TYPE_WEB
const URL_TYPE_WEB = 'web' |
The documentation for this interface was generated from the following file: