Class Mage_Core_Model_Url

URL

Properties:

request
relative_url: true, false
type: 'link', 'skin', 'js', 'media'
store: instanceof Mage_Core_Model_Store
secure: true, false
scheme: 'http', 'https'
user: 'user'
password: 'password'
host: 'localhost'
port: 80, 443
base_path: '/dev/magento/'
base_script: 'index.php'
storeview_path: 'storeview/'
route_path: 'module/controller/action/param1/value1/param2/value2'
route_name: 'module'
controller_name: 'controller'
action_name: 'action'
route_params: array('param1'=>'value1', 'param2'=>'value2')
query: (?)'param1=value1&param2=value2'
query_array: array('param1'=>'value1', 'param2'=>'value2')
fragment: (#)'fragment-anchor'

URL structure:

https://user:password@host:443/base_path/[base_script][storeview_path]route_name/controller_name/action_name/param1/value1?query_param=query_value#fragment \__________A___________/\____________________________________B_____________________________________/ \__________________C___________________/ \__________________D_________________/ \_____E_____/ \_____________F______________/ \___________________________G______________________/ \___________________________________________________H____________________________________________________/

A: authority
B: path
C: absolute_base_url
D: action_path
E: route_params
F: host_url
G: route_path
H: route_url

Varien_Object

Mage_Core_Model_Url

Direct known subclasses

Mage_Adminhtml_Model_Url

Package: Mage\Core
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Core/Model/Url.php

Methods summary
`protected`	# `_construct( )` Initialize object Initialize object
`public Mage_Core_Model_Url`	# `parseUrl( string $url )` Initialize object data from retrieved url Initialize object data from retrieved url Parameters `$url` `string` $url Returns `Mage_Core_Model_Url`
`public string`	# `getDefaultControllerName( )` Retrieve default controller name Retrieve default controller name Returns `string`
`public Mage_Core_Model_Url`	# `setUseUrlCache( boolean $flag )` Set use_url_cache flag Set use_url_cache flag Parameters `$flag` `boolean` $flag Returns `Mage_Core_Model_Url`
`public Mage_Core_Model_Url`	# `setUseSession( boolean $useSession )` Set use session rule Set use session rule Parameters `$useSession` `boolean` $useSession Returns `Mage_Core_Model_Url`
`public Mage_Core_Model_Url`	# `setRouteFrontName( string $name )` Set route front name Set route front name Parameters `$name` `string` $name Returns `Mage_Core_Model_Url`
`public boolean`	# `getUseSession( )` Retrieve use session rule Retrieve use session rule Returns `boolean`
`public string`	# `getDefaultActionName( )` Retrieve default action name Retrieve default action name Returns `string`
`public string`	# `getConfigData( string $key, string\|null $prefix = null )` Retrieve configuration data Retrieve configuration data Parameters `$key` `string` $key `$prefix` `string\|null` $prefix Returns `string`
`public Mage_Core_Model_Url`	# `setRequest( Zend_Controller_Request_Http $request )` Set request Set request Parameters `$request` `Zend_Controller_Request_Http` $request Returns `Mage_Core_Model_Url`
`public Zend_Controller_Request_Http`	# `getRequest( )` Zend request object Zend request object Returns `Zend_Controller_Request_Http`
`public string`	# `getType( )` Retrieve URL type Retrieve URL type Returns `string`
`public boolean`	# `getSecure( )` Retrieve is secure mode URL Retrieve is secure mode URL Returns `boolean`
`public Mage_Core_Model_Url`	# `setStore( mixed $data )` Set store entity Set store entity Parameters `$data` `mixed` $data Returns `Mage_Core_Model_Url`
`public Mage_Core_Model_Store`	# `getStore( )` Get current store for the url instance Get current store for the url instance Returns `Mage_Core_Model_Store`
`public string`	# `getBaseUrl( array $params = array() )` Retrieve Base URL Retrieve Base URL Parameters `$params` `array` $params Returns `string`
`public Mage_Core_Model_Url`	# `setRoutePath( array $data )` Set Route Parameters Set Route Parameters Parameters `$data` `array` $data Returns `Mage_Core_Model_Url`
`public string`	# `getActionPath( )` Retrieve action path Retrieve action path Returns `string`
`public string`	# `getRoutePath( array $routeParams = array() )` Retrieve route path Retrieve route path Parameters `$routeParams` `array` $routParams Returns `string`
`public Mage_Core_Model_Url`	# `setRouteName( string $data )` Set route name Set route name Parameters `$data` `string` $data Returns `Mage_Core_Model_Url`
`public string`	# `getRouteFrontName( )` Retrieve route front name Retrieve route front name Returns `string`
`public string\|null`	# `getRouteName( )` Retrieve route name Retrieve route name Returns `string\|null`
`public Mage_Core_Model_Url`	# `setControllerName( string $data )` Set Controller Name Set Controller Name Reset action name and route path if has change Parameters `$data` `string` $data Returns `Mage_Core_Model_Url`
`public string\|null`	# `getControllerName( )` Retrieve controller name Retrieve controller name Returns `string\|null`
`public Mage_Core_Model_Url`	# `setActionName( string $data )` Set Action name Reseted route path if action name has change Set Action name Reseted route path if action name has change Parameters `$data` `string` $data Returns `Mage_Core_Model_Url`
`public string\|null`	# `getActionName( )` Retrieve action name Retrieve action name Returns `string\|null`
`public Mage_Core_Model_Url`	# `setRouteParams( array $data, boolean $unsetOldParams = true )` Set route params Set route params Parameters `$data` `array` $data `$unsetOldParams` `boolean` $unsetOldParams Returns `Mage_Core_Model_Url`
`public array`	# `getRouteParams( )` Retrieve route params Retrieve route params Returns `array`
`public Mage_Core_Model_Url`	# `setRouteParam( string $key, mixed $data )` Set route param Set route param Parameters `$key` `string` $key `$data` `mixed` $data Returns `Mage_Core_Model_Url`
`public mixed`	# `getRouteParam( string $key )` Retrieve route params Retrieve route params Parameters `$key` `string` $key Returns `mixed`
`public string`	# `getRouteUrl( string $routePath = null, array $routeParams = null )` Retrieve route URL Retrieve route URL Parameters `$routePath` `string` $routePath `$routeParams` `array` $routeParams Returns `string`
`public Mage_Core_Model_Url`	# `checkCookieDomains( )` If the host was switched but session cookie won't recognize it - add session id to query If the host was switched but session cookie won't recognize it - add session id to query Returns `Mage_Core_Model_Url`
`public Mage_Core_Model_Url`	# `addSessionParam( )` Add session param Add session param Returns `Mage_Core_Model_Url`
`public Mage_Core_Model_Url`	# `setQuery( mixed $data )` Set URL query param(s) Set URL query param(s) Parameters `$data` `mixed` $data Returns `Mage_Core_Model_Url`
`public string`	# `getQuery( boolean $escape = false )` Get query params part of url Get query params part of url Parameters `$escape` `boolean` $escape "&" escape flag Returns `string`
`public Mage_Core_Model_Url`	# `setQueryParams( array $data )` Set query Params as array Set query Params as array Parameters `$data` `array` $data Returns `Mage_Core_Model_Url`
`public Mage_Core_Model_Url`	# `purgeQueryParams( )` Purge Query params array Purge Query params array Returns `Mage_Core_Model_Url`
`public array`	# `getQueryParams( )` Return Query Params Return Query Params Returns `array`
`public Mage_Core_Model_Url`	# `setQueryParam( string $key, mixed $data )` Set query param Set query param Parameters `$key` `string` $key `$data` `mixed` $data Returns `Mage_Core_Model_Url`
`public mixed`	# `getQueryParam( string $key )` Retrieve query param Retrieve query param Parameters `$key` `string` $key Returns `mixed`
`public Mage_Core_Model_Url`	# `setFragment( string $data )` Set fragment to URL Set fragment to URL Parameters `$data` `string` $data Returns `Mage_Core_Model_Url`
`public string\|null`	# `getFragment( )` Retrieve URL fragment Retrieve URL fragment Returns `string\|null`
`public string`	# `getUrl( string\|null $routePath = null, array\|null $routeParams = null )` Build url by requested path and parameters Build url by requested path and parameters Parameters `$routePath` `string\|null` $routePath `$routeParams` `array\|null` $routeParams Returns `string`
`protected Mage_Core_Model_Url`	# `_prepareSessionUrl( string $url )` Check and add session id to URL Check and add session id to URL Parameters `$url` `string` $url Returns `Mage_Core_Model_Url`
`protected Mage_Core_Model_Url`	# `_prepareSessionUrlWithParams( string $url, array $params )` Check and add session id to URL, session is obtained with parameters Check and add session id to URL, session is obtained with parameters Parameters `$url` `string` $url `$params` `array` $params Returns `Mage_Core_Model_Url`
`public string`	# `getRebuiltUrl( string $url )` Rebuild URL to handle the case when session ID was changed Rebuild URL to handle the case when session ID was changed Parameters `$url` `string` $url Returns `string`
`public string`	# `escape( string $value )` Escape (enclosure) URL string Escape (enclosure) URL string Parameters `$value` `string` $value Returns `string`
`public string`	# `getDirectUrl( string $url, array $params = array() )` Build url by direct url and parameters Build url by direct url and parameters Parameters `$url` `string` $url `$params` `array` $params Returns `string`
`public string`	# `sessionUrlVar( string $html )` Replace Session ID value in URL Replace Session ID value in URL Parameters `$html` `string` $html Returns `string`
`public boolean`	# `useSessionIdForUrl( boolean $secure = false )` Check and return use SID for URL Check and return use SID for URL Parameters `$secure` `boolean` $secure Returns `boolean`
`public string`	# `sessionVarCallback( array $match )` Callback function for session replace Callback function for session replace Parameters `$match` `array` $match Returns `string`
`public boolean`	# `isOwnOriginUrl( )` Check if users originated URL is one of the domain URLs assigned to stores Check if users originated URL is one of the domain URLs assigned to stores Returns `boolean`
`public string`	# `getRedirectUrl( string $url )` Return frontend redirect URL with SID and other session parameters if any Return frontend redirect URL with SID and other session parameters if any Parameters `$url` `string` $url Returns `string`

Constants summary
`string`	`DEFAULT_CONTROLLER_NAME`	`'index'`	# Default controller name Default controller name
`string`	`DEFAULT_ACTION_NAME`	`'index'`	# Default action name Default action name
`string`	`XML_PATH_UNSECURE_URL`	`'web/unsecure/base_url'`	# Configuration paths Configuration paths
`string`	`XML_PATH_SECURE_URL`	`'web/secure/base_url'`	#
`string`	`XML_PATH_SECURE_IN_ADMIN`	`'default/web/secure/use_in_adminhtml'`	#
`string`	`XML_PATH_SECURE_IN_FRONT`	`'web/secure/use_in_frontend'`	#

Properties summary
`protected static array`	`$_configDataCache`		# Configuration data cache Configuration data cache
`protected static string\|null`	`$_encryptedSessionId`		# Encrypted session identifier Encrypted session identifier
`protected array`	`$_reservedRouteParams`	`array( '_store', '_type', '_secure', '_forced_secure', '_use_rewrite', '_nosid', '_absolute', '_current', '_direct', '_fragment', '_escape', '_query', '_store_to_url' )`	# Reserved Route parameter keys Reserved Route parameter keys
`protected Zend_Controller_Request_Http`	`$_request`		# Controller request object Controller request object
`protected boolean`	`$_useSession`		# Use Session ID for generate URL Use Session ID for generate URL

Packages

Classes

Exceptions

Functions

Class Mage_Core_Model_Url

Direct known subclasses

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns