<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework;

/**
* @api
* @since 100.0.2
*/
interface UrlInterface
{
/**#@+
* Possible URL types
*/
const URL_TYPE_LINK = 'link';
const URL_TYPE_DIRECT_LINK = 'direct_link';
const URL_TYPE_WEB = 'web';
const URL_TYPE_MEDIA = 'media';
const URL_TYPE_STATIC = 'static';
const URL_TYPE_JS = 'js';
/**#@-*/

/**
* Default url type
*
* Equals to self::URL_TYPE_LINK
*/
const DEFAULT_URL_TYPE = 'link';

const DEFAULT_CONTROLLER_NAME = 'index';

const DEFAULT_ACTION_NAME = 'index';

const REWRITE_REQUEST_PATH_ALIAS = 'rewrite_request_path';

/**
* Session namespace to refer in other places
*/
const SESSION_NAMESPACE = 'frontend';

/**
* Retrieve use session rule
*
* @return bool
* @deprecated SID is not being passed in URLs anymore.
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
*/
public function getUseSession();

/**
* Retrieve Base URL
*
* @param array $params
* @return string
*/
public function getBaseUrl($params = []);

/**
* Retrieve current url with port number (if not default used)
*
* @return string
*/
public function getCurrentUrl();

/**
* Retrieve route URL
*
* @param string $routePath
* @param array $routeParams
* @return string
*/
public function getRouteUrl($routePath = null, $routeParams = null);

/**
* Add session param
*
* @return \Magento\Framework\UrlInterface
* @deprecated SID is not being passed in URLs anymore.
*/
public function addSessionParam();

/**
* Add query parameters
*
* @param array $data
* @return \Magento\Framework\UrlInterface
*/
public function addQueryParams(array $data);

/**
* Set query param
*
* @param string $key
* @param mixed $data
* @return \Magento\Framework\UrlInterface
*/
public function setQueryParam($key, $data);

/**
* Build url by requested path and parameters
*
* @param string|null $routePath
* @param array|null $routeParams
* @return string
*/
public function getUrl($routePath = null, $routeParams = null);

/**
* Escape (enclosure) URL string
*
* @param string $value
* @return string
*/
public function escape($value);

/**
* Build url by direct url and parameters
*
* @param string $url
* @param array $params
* @return string
*/
public function getDirectUrl($url, $params = []);

/**
* Replace Session ID value in URL
*
* @param string $html
* @return string
*/
public function sessionUrlVar($html);

/**
* Check if users originated URL is one of the domain URLs assigned to stores
*
* @return boolean
*/
public function isOwnOriginUrl();

/**
* Return frontend redirect URL with SID and other session parameters if any
*
* @param string $url
*
* @return string
*/
public function getRedirectUrl($url);

/**
* Set scope entity
*
* @param mixed $params
* @return \Magento\Framework\UrlInterface
*/
public function setScope($params);
}