Mage::getBaseUrl('media') //可获得 media 带 http 的url 地址。
//同理也可以获得skin 和js 目录的地址：
Mage::getBaseUrl('skin');
Mage::getBaseUrl('js');
//而获取带http 的网站根地址为：
Mage::getBaseUrl('web');
//在cms中调用的URL的方法（content 中）：
{{store direct_url="Home"}} //跳网id 是Home 的cms页面。
{{skin url='images/media/main_page_banner.jpg'}} //定位一副图片的位置。
$this->getUrl('catalogsearch/advanced/result');
//在block 可以获得一页页面的URL.
$this->getSkinUrl('/images/logo.jpg')
//可以直接获取图片地址
$this->getSkinUrl('css/style.css');
//$this->getSkinUrl();一看应该就知道得到的是skin下面的路径。
$this->getUrl('contacts');
//要是要获得的是具体页面的url, 如果$this不能用就可以用Mage:: 来调用函数
/获取 magento js 路径
Mage::getBaseUrl(Mage_Core_Model_Store::URL_TYPE_JS);
//http://你网站地址/index.php/
Mage::getBaseUrl(Mage_Core_Model_Store::URL_TYPE_LINK);
//获取 magento media 目录
Mage::getBaseUrl(Mage_Core_Model_Store::URL_TYPE_MEDIA);
//magento中 获取skin目录
Mage::getBaseUrl(Mage_Core_Model_Store::URL_TYPE_SKIN);
//http://你网站地址/
Mage::getBaseUrl(Mage_Core_Model_Store::URL_TYPE_WEB);
//magento获取当前路径
Mage::helper('core/url')->getCurrentUrl();
//To Retrieve URL path in STATIC BLOCK
//To get SKIN URL
{{skin url='images/sampleimage.jpg '}}
//To get Media URL
{{media url='/sampleimage.jpg'}}
//To get Store URL
{{store url='mypage.html'}}
//To get Base URL
{{base url='yourstore/mypage.html'}}
//TO Retrieve URL path in PHTML
//Note: In editing PHTML don’t forget to enclode the following code With PHP tag
//Not secure Skin URL:
<?php echo $this->getSkinUrl('images/sampleimage.jpg') ?>
//Secure Skin URL
<?php echo $this->getSkinUrl('images/ sampleimage.gif',array('_secure'=>true)) ?>
//Get Current URL
$current_url = Mage::helper('core/url')->getCurrentUrl();
//Get Home URL
$home_url = Mage::helper('core/url')->getHomeUrl();
//Get Magento Media Url
Mage::getBaseUrl(Mage_Core_Model_Store::URL_TYPE_LINK);
//Get Magento Media Url
Mage::getBaseUrl(Mage_Core_Model_Store::URL_TYPE_MEDIA);
//Get Magento Skin Url
Mage::getBaseUrl(Mage_Core_Model_Store::URL_TYPE_SKIN);
//Get Magento Store Url
Mage::getBaseUrl(Mage_Core_Model_Store::URL_TYPE_WEB);
//Get Magento Js Url
Mage::getBaseUrl(Mage_Core_Model_Store::URL_TYPE_JS);
Get Directory paths
Mage::getBaseDir()
//output : /var/www/html/magento
Mage::getBaseDir('app')
//output : /var/www/html/magento/app
Mage::getBaseDir('media')
//output : /var/www/html/magento/media
Same way you can get more directory path,
Mage::getBaseDir(‘design’) => Get design directory path Mage::getBaseDir(‘code’) => Gives code directory file path Mage::getBaseDir(‘lib’) => Gives lib directory file path Mage::getBaseDir(‘skin’) => Gives skin directory file path Mage::getBaseDir(‘var’) => Gives var directory file path Mage::getBaseDir(‘cache’) => Gives cache directory file path Mage::getBaseDir(‘log’) => Gives log directory file path
Magento Base Directories
Add the following code an empty controller action or other area of Magento where you can run arbitrary code.
$base_path = Mage::getBaseDir('base');
var_dump($base_path);
$etc_path = Mage::getBaseDir('etc');
var_dump($etc_path);
You should see output something like the following
string '/Users/username/Sites/magento1point4.1.dev' (length=43) string '/Users/username/Sites/magento1point4.1.dev/app/etc' (length=51)
The first folder is the base directory for the entire Magento installation. The second folder is the base directory for Magento’s etc folder, which holds configuration files.
In the latest Community Edition release of Magento there are 14 different directories that are considered important enough to be retrievable by this method. The static calls to Mage::getBaseDir are a wrapper/public-api to the getDir method on a Mage_Core_Model_Config_Options object. If you take a look at the Magento Model pseudo-constructor in
#File: app/code/core/Mage/Core/Model/Config/Options.php
class Mage_Core_Model_Config_Options extends Varien_Object
{
/* ... */
protected function _construct()
{
$appRoot= Mage::getRoot();
$root = dirname($appRoot);
$this->_data['app_dir'] = $appRoot;
$this->_data['base_dir'] = $root;
$this->_data['code_dir'] = $appRoot.DS.'code';
$this->_data['design_dir'] = $appRoot.DS.'design';
$this->_data['etc_dir'] = $appRoot.DS.'etc';
$this->_data['lib_dir'] = $root.DS.'lib';
$this->_data['locale_dir'] = $appRoot.DS.'locale';
$this->_data['media_dir'] = $root.DS.'media';
$this->_data['skin_dir'] = $root.DS.'skin';
$this->_data['var_dir'] = $this->getVarDir();
$this->_data['tmp_dir'] = $this->_data['var_dir'].DS.'tmp';
$this->_data['cache_dir'] = $this->_data['var_dir'].DS.'cache';
$this->_data['log_dir'] = $this->_data['var_dir'].DS.'log';
$this->_data['session_dir'] = $this->_data['var_dir'].DS.'session';
$this->_data['upload_dir'] = $this->_data['media_dir'].DS.'upload';
$this->_data['export_dir'] = $this->_data['var_dir'].DS.'export';
}
you can see where these directory paths are stored.
Let’s quickly review each one
Mage::getBaseDir(‘base’);
This is your main Magento directory. In a default root level application instal, this is the equivalent of the document root.
Mage::getBaseDir(‘app’);
This is your Magento application directory. This is the directory where the final class Mage… application file (Mage.php) is stored.
The default directory (from the Magento base folder) is
/app/
Mage::getBaseDir(‘code’);
This is your Magento code directory. This is base directory for the three Magento code pools (core, community, local).
The default directory (from the Magento base folder) is
/app/code
Mage::getBaseDir(‘design’);
This is your Magento design package directory. This is the base folder that contains the “design packages” for each Area of Magento, (frontend, adminhtml, and install)
The default directory (from the Magento base folder) is
/app/design
Mage::getBaseDir(‘etc’);
The etc folder is where Magento stores system level (as opposed to module level) configuration files. The name etc is borrowed from the *nix family of operating systems, and Magento’s configuration files are all XML based.
The default directory (from the Magento base folder) is
/app/etc
Mage::getBaseDir(‘lib’);
Magento’s library folder is where non-module based Magento code lives. This include a large amount of the system code which allows Magento to run, as well as a number of third party libraries (including the Zend Framework). The library is also the last code pool Magento will search when attempting to autoload a file.
The default directory (from the Magento base folder) is
/lib
Mage::getBaseDir(‘locale’);
The locale folder contains the translation files for the core Magento modules. Magento uses a system similar to GNU gettext to provide translated text. Unique strings are stored as key value pairs in the translation files. They “key” is used to lookup which text should actually be displayed. This means for the english locale you’ll see redundant looking strings like
“Add Option”,”Add Option”
It’s only when you look at the non-english speaking translation files that the system become obvious
The default directory (from the Magento base folder) is
/app/locale
Mage::getBaseDir(‘media’);
Magento’s media folder is where media files (images, movies, etc.) related to data (products) is stored.
The default directory (from the Magento base folder) is
/media
Mage::getBaseDir(‘skin’);
If the word module is the most used yet least well defined programming term, then the words skin and theme are the most abused in the designer’s world. In Magento, the skin folder contains images, CSS and Javascript files used by your themes.
This is not the only folder where you’ll find images, CSS or javascript though. This folder is meant for files that are customized per theme.
The default directory (from the Magento base folder) is
/skin
Mage::getBaseDir(‘var’);
The var folder is another one borrowed from the *nix world. The var stands for Variable files, and is intended to store files which are expected to change during normal system operations.
The default directory (from the Magento base folder) is
/var
Mage::getBaseDir(‘tmp’);
The tmp dir is a temporary directory for safely outputting files into for immediate processing. The operating assumption of the tmp folder is that any developer can write to it and expect their file to stay around for a few minutes, without any expectation that it will be there tomorrow.
The default directory (from the Magento base folder) is
/var/tmp
Mage::getBaseDir(‘cache’);
Magento, rather famously, makes heavy use of caching for activities that might bog down the system if they had to be performed every-time a page loads. For example, Layout XML files are merged once, and then the tree is cached so they don’t need to be merged again. The cache folder is one place where Magento will store these cached results.
The default directory (from the Magento base folder) is
/var/cache
Mage::getBaseDir(‘log’);
Magento’s log folder is where is stores the system and exception logs. These logs can be turned on from the Admin Panel’s
System -> Configuration -> Developer -> Log Settings
section. The apache/web-server user will need write permission on this folder and the files therein.
The default directory (from the Magento base folder) is
/var/log
Mage::getBaseDir(‘session’);
During installation you have the option of storing user sessions on disk, or in the database. The session folder is where the user sessions are written out to and read from if you choose to store them in the filesystem
The default directory (from the Magento base folder) is
/var/session
Mage::getBaseDir(‘upload’);
There are a number of Admin Panel features which allow you to upload media files (default logos, etc.). The upload folder is where Magento stores these files.
The default directory (from the Magento base folder) is
/media/upload
Mage::getBaseDir(‘export’);
The export folder is where Magento will write out files meant to be viewed and used by system owners. For example, the Data Flow section of the Admin uses this folder to write out its export files.
The default directory (from the Magento base folder) is
/var/export
Module Base Directories
So, that covers the system folders that Magento gives you access to. There is, however, one other important static method on the Mage application class class that we should discuss. Give the following a try
var_dump( Mage::getModuleDir('', 'Mage_Core') );
var_dump( Mage::getModuleDir('etc', 'Mage_Core') );
var_dump( Mage::getModuleDir('controllers', 'Mage_Core') );
var_dump( Mage::getModuleDir('sql', 'Mage_Core') );
var_dump( Mage::getModuleDir('locale', 'Mage_Core') );
That static method Mage::getModuleDir method allows you to retrieve directory path information that’s specific to any module loaded into the system. Like the getBaseDir method, this call is a public-api to code deeper in the Magento system
#File: app/code/core/Mage/Core/Model/Config.php
class Mage_Core_Model_Config extends Mage_Core_Model_Config_Base
{
/* ... */
public function getModuleDir($type, $moduleName)
{
$codePool = (string)$this->getModuleConfig($moduleName)->codePool;
$dir = $this->getOptions()->getCodeDir().DS.$codePool.DS.uc_words($moduleName, DS);
switch ($type) {
case 'etc':
$dir .= DS.'etc';
break;
case 'controllers':
$dir .= DS.'controllers';
break;
case 'sql':
$dir .= DS.'sql';
break;
case 'locale':
$dir .= DS.'locale';
break;
}
$dir = str_replace('/', DS, $dir);
return $dir;
}
Let’s quickly cover these four folders.
Mage::getModuleDir(‘etc’, ‘Packagename_Modulename’);
Your module’s etc folder. The etc folder is a concept borrowed from the *nix, and contains you’re module’s XML configuration files.
Mage::getModuleDir(‘controllers’, ‘Packagename_Modulename’);
Your module’s controllers folder. Magento’s controllers are not included in the __autoload implementation. If you ever need to manually include or require a controller, use this method to ensure you get the right path.
Mage::getModuleDir(‘sql’, ‘Packagename_Modulename’);
Your module’s sql folder. The sql folder contains installer and upgrade files for your Model resources, which are used to install entities and migrate database information during installations.
Mage::getModuleDir(‘locale’, ‘Packagename_Modulename’);
Your module’s locale folder. The locale folder contains translation files that are used by Magento when your module is viewed under a different locales.
参考及引用
<?php
//app\code\core\Mage\Core\Model/Url.php
/**
* Magento
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@magento.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade Magento to newer
* versions in the future. If you wish to customize Magento for your
* needs please refer to http://www.magento.com for more information.
*
* @category Mage
* @package Mage_Core
* @copyright Copyright (c) 2006-2014 X.commerce, Inc. (http://www.magento.com)
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
*/
/**
* 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¶m2=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
*
* @category Mage
* @package Mage_Core
* @author Magento Core Team <core@magentocommerce.com>
*/
class Mage_Core_Model_Url extends Varien_Object
{
/**
* Default controller name
*/
const DEFAULT_CONTROLLER_NAME = 'index';
/**
* Default action name
*/
const DEFAULT_ACTION_NAME = 'index';
/**
* XML base url path unsecure
*/
const XML_PATH_UNSECURE_URL = 'web/unsecure/base_url';
/**
* XML base url path secure
*/
const XML_PATH_SECURE_URL = 'web/secure/base_url';
/**
* XML path for using in adminhtml
*/
const XML_PATH_SECURE_IN_ADMIN = 'default/web/secure/use_in_adminhtml';
/**
* XML path for using in frontend
*/
const XML_PATH_SECURE_IN_FRONT = 'web/secure/use_in_frontend';
/**
* Param name for form key functionality
*/
const FORM_KEY = 'form_key';
/**
* Configuration data cache
*
* @var array
*/
static protected $_configDataCache;
/**
* Encrypted session identifier
*
* @var string|null
*/
static protected $_encryptedSessionId;
/**
* Reserved Route parameter keys
*
* @var array
*/
protected $_reservedRouteParams = array(
'_store', '_type', '_secure', '_forced_secure', '_use_rewrite', '_nosid',
'_absolute', '_current', '_direct', '_fragment', '_escape', '_query',
'_store_to_url'
);
/**
* Controller request object
*
* @var Zend_Controller_Request_Http
*/
protected $_request;
/**
* Use Session ID for generate URL
*
* @var bool
*/
protected $_useSession;
/**
* Initialize object
*/
protected function _construct()
{
$this->setStore(null);
}
/**
* Initialize object data from retrieved url
*
* @param string $url
* @return Mage_Core_Model_Url
*/
public function parseUrl($url)
{
$data = parse_url($url);
$parts = array(
'scheme' => 'setScheme',
'host' => 'setHost',
'port' => 'setPort',
'user' => 'setUser',
'pass' => 'setPassword',
'path' => 'setPath',
'query' => 'setQuery',
'fragment' => 'setFragment');
foreach ($parts as $component => $method) {
if (isset($data[$component])) {
$this->$method($data[$component]);
}
}
return $this;
}
/**
* Retrieve default controller name
*
* @return string
*/
public function getDefaultControllerName()
{
return self::DEFAULT_CONTROLLER_NAME;
}
/**
* Set use_url_cache flag
*
* @param boolean $flag
* @return Mage_Core_Model_Url
*/
public function setUseUrlCache($flag)
{
$this->setData('use_url_cache', $flag);
return $this;
}
/**
* Set use session rule
*
* @param bool $useSession
* @return Mage_Core_Model_Url
*/
public function setUseSession($useSession)
{
$this->_useSession = (bool) $useSession;
return $this;
}
/**
* Set route front name
*
* @param string $name
* @return Mage_Core_Model_Url
*/
public function setRouteFrontName($name)
{
$this->setData('route_front_name', $name);
return $this;
}
/**
* Retrieve use session rule
*
* @return bool
*/
public function getUseSession()
{
if (is_null($this->_useSession)) {
$this->_useSession = Mage::app()->getUseSessionInUrl();
}
return $this->_useSession;
}
/**
* Retrieve default action name
*
* @return string
*/
public function getDefaultActionName()
{
return self::DEFAULT_ACTION_NAME;
}
/**
* Retrieve configuration data
*
* @param string $key
* @param string|null $prefix
* @return string
*/
public function getConfigData($key, $prefix = null)
{
if (is_null($prefix)) {
$prefix = 'web/' . ($this->getSecure() ? 'secure' : 'unsecure').'/';
}
$path = $prefix . $key;
$cacheId = $this->getStore()->getCode() . '/' . $path;
if (!isset(self::$_configDataCache[$cacheId])) {
$data = $this->getStore()->getConfig($path);
self::$_configDataCache[$cacheId] = $data;
}
return self::$_configDataCache[$cacheId];
}
/**
* Set request
*
* @param Zend_Controller_Request_Http $request
* @return Mage_Core_Model_Url
*/
public function setRequest(Zend_Controller_Request_Http $request)
{
$this->_request = $request;
return $this;
}
/**
* Zend request object
*
* @return Zend_Controller_Request_Http
*/
public function getRequest()
{
if (!$this->_request) {
$this->_request = Mage::app()->getRequest();
}
return $this->_request;
}
/**
* Retrieve URL type
*
* @return string
*/
public function getType()
{
if (!$this->hasData('type')) {
$this->setData('type', Mage_Core_Model_Store::URL_TYPE_LINK);
}
return $this->_getData('type');
}
/**
* Retrieve is secure mode URL
*
* @return bool
*/
public function getSecure()
{
if ($this->hasData('secure_is_forced')) {
return (bool)$this->getData('secure');
}
$store = $this->getStore();
if ($store->isAdmin() && !$store->isAdminUrlSecure()) {
return false;
}
if (!$store->isAdmin() && !$store->isFrontUrlSecure()) {
return false;
}
if (!$this->hasData('secure')) {
if ($this->getType() == Mage_Core_Model_Store::URL_TYPE_LINK && !$store->isAdmin()) {
$pathSecure = Mage::getConfig()->shouldUrlBeSecure('/' . $this->getActionPath());
$this->setData('secure', $pathSecure);
} else {
$this->setData('secure', true);
}
}
return $this->getData('secure');
}
/**
* Set store entity
*
* @param mixed $data
* @return Mage_Core_Model_Url
*/
public function setStore($data)
{
$this->setData('store', Mage::app()->getStore($data));
return $this;
}
/**
* Get current store for the url instance
*
* @return Mage_Core_Model_Store
*/
public function getStore()
{
if (!$this->hasData('store')) {
$this->setStore(null);
}
return $this->_getData('store');
}
/**
* Retrieve Base URL
*
* @param array $params
* @return string
*/
public function getBaseUrl($params = array())
{
if (isset($params['_store'])) {
$this->setStore($params['_store']);
}
if (isset($params['_type'])) {
$this->setType($params['_type']);
}
if (isset($params['_secure'])) {
$this->setSecure($params['_secure']);
}
/**
* Add availability support urls without store code
*/
if ($this->getType() == Mage_Core_Model_Store::URL_TYPE_LINK
&& Mage::app()->getRequest()->isDirectAccessFrontendName($this->getRouteFrontName())) {
$this->setType(Mage_Core_Model_Store::URL_TYPE_DIRECT_LINK);
}
return $this->getStore()->getBaseUrl($this->getType(), $this->getSecure());
}
/**
* Set Route Parameters
*
* @param array $data
* @return Mage_Core_Model_Url
*/
public function setRoutePath($data)
{
if ($this->_getData('route_path') == $data) {
return $this;
}
$a = explode('/', $data);
$route = array_shift($a);
if ('*' === $route) {
$route = $this->getRequest()->getRequestedRouteName();
}
$this->setRouteName($route);
$routePath = $route . '/';
if (!empty($a)) {
$controller = array_shift($a);
if ('*' === $controller) {
$controller = $this->getRequest()->getRequestedControllerName();
}
$this->setControllerName($controller);
$routePath .= $controller . '/';
}
if (!empty($a)) {
$action = array_shift($a);
if ('*' === $action) {
$action = $this->getRequest()->getRequestedActionName();
}
$this->setActionName($action);
$routePath .= $action . '/';
}
if (!empty($a)) {
$this->unsetData('route_params');
while (!empty($a)) {
$key = array_shift($a);
if (!empty($a)) {
$value = array_shift($a);
$this->setRouteParam($key, $value);
$routePath .= $key . '/' . $value . '/';
}
}
}
return $this;
}
/**
* Retrieve action path
*
* @return string
*/
public function getActionPath()
{
if (!$this->getRouteName()) {
return '';
}
$hasParams = (bool) $this->getRouteParams();
$path = $this->getRouteFrontName() . '/';
if ($this->getControllerName()) {
$path .= $this->getControllerName() . '/';
} elseif ($hasParams) {
$path .= $this->getDefaultControllerName() . '/';
}
if ($this->getActionName()) {
$path .= $this->getActionName() . '/';
} elseif ($hasParams) {
$path .= $this->getDefaultActionName() . '/';
}
return $path;
}
/**
* Retrieve route path
*
* @param array $routParams
* @return string
*/
public function getRoutePath($routeParams = array())
{
if (!$this->hasData('route_path')) {
$routePath = $this->getRequest()->getAlias(Mage_Core_Model_Url_Rewrite::REWRITE_REQUEST_PATH_ALIAS);
if (!empty($routeParams['_use_rewrite']) && ($routePath !== null)) {
$this->setData('route_path', $routePath);
return $routePath;
}
$routePath = $this->getActionPath();
if ($this->getRouteParams()) {
foreach ($this->getRouteParams() as $key => $value) {
if (is_null($value) || false === $value || '' === $value || !is_scalar($value)) {
continue;
}
$routePath .= $key . '/' . $value . '/';
}
}
if ($routePath != '' && substr($routePath, -1, 1) !== '/') {
$routePath .= '/';
}
$this->setData('route_path', $routePath);
}
return $this->_getData('route_path');
}
/**
* Set route name
*
* @param string $data
* @return Mage_Core_Model_Url
*/
public function setRouteName($data)
{
if ($this->_getData('route_name') == $data) {
return $this;
}
$this->unsetData('route_front_name')
->unsetData('route_path')
->unsetData('controller_name')
->unsetData('action_name')
->unsetData('secure');
return $this->setData('route_name', $data);
}
/**
* Retrieve route front name
*
* @return string
*/
public function getRouteFrontName()
{
if (!$this->hasData('route_front_name')) {
$routeName = $this->getRouteName();
$route = Mage::app()->getFrontController()->getRouterByRoute($routeName);
$frontName = $route->getFrontNameByRoute($routeName);
$this->setRouteFrontName($frontName);
}
return $this->_getData('route_front_name');
}
/**
* Retrieve route name
*
* @return string|null
*/
public function getRouteName()
{
return $this->_getData('route_name');
}
/**
* Set Controller Name
*
* Reset action name and route path if has change
*
* @param string $data
* @return Mage_Core_Model_Url
*/
public function setControllerName($data)
{
if ($this->_getData('controller_name') == $data) {
return $this;
}
$this->unsetData('route_path')->unsetData('action_name')->unsetData('secure');
return $this->setData('controller_name', $data);
}
/**
* Retrieve controller name
*
* @return string|null
*/
public function getControllerName()
{
return $this->_getData('controller_name');
}
/**
* Set Action name
* Reseted route path if action name has change
*
* @param string $data
* @return Mage_Core_Model_Url
*/
public function setActionName($data)
{
if ($this->_getData('action_name') == $data) {
return $this;
}
$this->unsetData('route_path');
return $this->setData('action_name', $data)->unsetData('secure');
}
/**
* Retrieve action name
*
* @return string|null
*/
public function getActionName()
{
return $this->_getData('action_name');
}
/**
* Set route params
*
* @param array $data
* @param boolean $unsetOldParams
* @return Mage_Core_Model_Url
*/
public function setRouteParams(array $data, $unsetOldParams = true)
{
if (isset($data['_type'])) {
$this->setType($data['_type']);
unset($data['_type']);
}
if (isset($data['_store'])) {
$this->setStore($data['_store']);
unset($data['_store']);
}
if (isset($data['_forced_secure'])) {
$this->setSecure((bool)$data['_forced_secure']);
$this->setSecureIsForced(true);
unset($data['_forced_secure']);
} elseif (isset($data['_secure'])) {
$this->setSecure((bool)$data['_secure']);
unset($data['_secure']);
}
if (isset($data['_absolute'])) {
unset($data['_absolute']);
}
if ($unsetOldParams) {
$this->unsetData('route_params');
}
$this->setUseUrlCache(true);
if (isset($data['_current'])) {
if (is_array($data['_current'])) {
foreach ($data['_current'] as $key) {
if (array_key_exists($key, $data) || !$this->getRequest()->getUserParam($key)) {
continue;
}
$data[$key] = $this->getRequest()->getUserParam($key);
}
} elseif ($data['_current']) {
foreach ($this->getRequest()->getUserParams() as $key => $value) {
if (array_key_exists($key, $data) || $this->getRouteParam($key)) {
continue;
}
$data[$key] = $value;
}
foreach ($this->getRequest()->getQuery() as $key => $value) {
$this->setQueryParam($key, $value);
}
$this->setUseUrlCache(false);
}
unset($data['_current']);
}
if (isset($data['_use_rewrite'])) {
unset($data['_use_rewrite']);
}
if (isset($data['_store_to_url']) && (bool)$data['_store_to_url'] === true) {
if (!Mage::getStoreConfig(Mage_Core_Model_Store::XML_PATH_STORE_IN_URL, $this->getStore())
&& !Mage::app()->isSingleStoreMode()
) {
$this->setQueryParam('___store', $this->getStore()->getCode());
}
}
unset($data['_store_to_url']);
foreach ($data as $k => $v) {
$this->setRouteParam($k, $v);
}
return $this;
}
/**
* Retrieve route params
*
* @return array
*/
public function getRouteParams()
{
return $this->_getData('route_params');
}
/**
* Set route param
*
* @param string $key
* @param mixed $data
* @return Mage_Core_Model_Url
*/
public function setRouteParam($key, $data)
{
$params = $this->_getData('route_params');
if (isset($params[$key]) && $params[$key] == $data) {
return $this;
}
$params[$key] = $data;
$this->unsetData('route_path');
return $this->setData('route_params', $params);
}
/**
* Retrieve route params
*
* @param string $key
* @return mixed
*/
public function getRouteParam($key)
{
return $this->getData('route_params', $key);
}
/**
* Retrieve route URL
*
* @param string $routePath
* @param array $routeParams
*
* @return string
*/
public function getRouteUrl($routePath = null, $routeParams = null)
{
$this->unsetData('route_params');
if (isset($routeParams['_direct'])) {
if (is_array($routeParams)) {
$this->setRouteParams($routeParams, false);
}
return $this->getBaseUrl() . $routeParams['_direct'];
}
if (!is_null($routePath)) {
$this->setRoutePath($routePath);
}
if (is_array($routeParams)) {
$this->setRouteParams($routeParams, false);
}
$url = $this->getBaseUrl() . $this->getRoutePath($routeParams);
return $url;
}
/**
* If the host was switched but session cookie won't recognize it - add session id to query
*
* @return Mage_Core_Model_Url
*/
public function checkCookieDomains()
{
$hostArr = explode(':', $this->getRequest()->getServer('HTTP_HOST'));
if ($hostArr[0] !== $this->getHost()) {
$session = Mage::getSingleton('core/session');
if (!$session->isValidForHost($this->getHost())) {
if (!self::$_encryptedSessionId) {
$helper = Mage::helper('core');
if (!$helper) {
return $this;
}
self::$_encryptedSessionId = $session->getEncryptedSessionId();
}
$this->setQueryParam($session->getSessionIdQueryParam(), self::$_encryptedSessionId);
}
}
return $this;
}
/**
* Add session param
*
* @return Mage_Core_Model_Url
*/
public function addSessionParam()
{
$session = Mage::getSingleton('core/session');
if (!self::$_encryptedSessionId) {
$helper = Mage::helper('core');
if (!$helper) {
return $this;
}
self::$_encryptedSessionId = $session->getEncryptedSessionId();
}
$this->setQueryParam($session->getSessionIdQueryParam(), self::$_encryptedSessionId);
return $this;
}
/**
* Set URL query param(s)
*
* @param mixed $data
* @return Mage_Core_Model_Url
*/
public function setQuery($data)
{
if ($this->_getData('query') == $data) {
return $this;
}
$this->unsetData('query_params');
return $this->setData('query', $data);
}
/**
* Get query params part of url
*
* @param bool $escape "&" escape flag
* @return string
*/
public function getQuery($escape = false)
{
if (!$this->hasData('query')) {
$query = '';
$params = $this->getQueryParams();
if (is_array($params)) {
ksort($params);
$query = http_build_query($params, '', $escape ? '&' : '&');
}
$this->setData('query', $query);
}
return $this->_getData('query');
}
/**
* Set query Params as array
*
* @param array $data
* @return Mage_Core_Model_Url
*/
public function setQueryParams(array $data)
{
$this->unsetData('query');
if ($this->_getData('query_params') == $data) {
return $this;
}
$params = $this->_getData('query_params');
if (!is_array($params)) {
$params = array();
}
foreach ($data as $param => $value) {
$params[$param] = $value;
}
$this->setData('query_params', $params);
return $this;
}
/**
* Purge Query params array
*
* @return Mage_Core_Model_Url
*/
public function purgeQueryParams()
{
$this->setData('query_params', array());
return $this;
}
/**
* Return Query Params
*
* @return array
*/
public function getQueryParams()
{
if (!$this->hasData('query_params')) {
$params = array();
if ($this->_getData('query')) {
foreach (explode('&', $this->_getData('query')) as $param) {
$paramArr = explode('=', $param);
$params[$paramArr[0]] = urldecode($paramArr[1]);
}
}
$this->setData('query_params', $params);
}
return $this->_getData('query_params');
}
/**
* Set query param
*
* @param string $key
* @param mixed $data
* @return Mage_Core_Model_Url
*/
public function setQueryParam($key, $data)
{
$params = $this->getQueryParams();
if (isset($params[$key]) && $params[$key] == $data) {
return $this;
}
$params[$key] = $data;
$this->unsetData('query');
return $this->setData('query_params', $params);
}
/**
* Retrieve query param
*
* @param string $key
* @return mixed
*/
public function getQueryParam($key)
{
if (!$this->hasData('query_params')) {
$this->getQueryParams();
}
return $this->getData('query_params', $key);
}
/**
* Set fragment to URL
*
* @param string $data
* @return Mage_Core_Model_Url
*/
public function setFragment($data)
{
return $this->setData('fragment', $data);
}
/**
* Retrieve URL fragment
*
* @return string|null
*/
public function getFragment()
{
return $this->_getData('fragment');
}
/**
* Build url by requested path and parameters
*
* @param string|null $routePath
* @param array|null $routeParams
* @return string
*/
public function getUrl($routePath = null, $routeParams = null)
{
$escapeQuery = false;
/**
* All system params should be unset before we call getRouteUrl
* this method has condition for adding default controller and action names
* in case when we have params
*/
if (isset($routeParams['_fragment'])) {
$this->setFragment($routeParams['_fragment']);
unset($routeParams['_fragment']);
}
if (isset($routeParams['_escape'])) {
$escapeQuery = $routeParams['_escape'];
unset($routeParams['_escape']);
}
$query = null;
if (isset($routeParams['_query'])) {
$this->purgeQueryParams();
$query = $routeParams['_query'];
unset($routeParams['_query']);
}
$noSid = null;
if (isset($routeParams['_nosid'])) {
$noSid = (bool)$routeParams['_nosid'];
unset($routeParams['_nosid']);
}
$url = $this->getRouteUrl($routePath, $routeParams);
/**
* Apply query params, need call after getRouteUrl for rewrite _current values
*/
if ($query !== null) {
if (is_string($query)) {
$this->setQuery($query);
} elseif (is_array($query)) {
$this->setQueryParams($query, !empty($routeParams['_current']));
}
if ($query === false) {
$this->setQueryParams(array());
}
}
if ($noSid !== true) {
$this->_prepareSessionUrl($url);
}
$query = $this->getQuery($escapeQuery);
if ($query) {
$mark = (strpos($url, '?') === false) ? '?' : ($escapeQuery ? '&' : '&');
$url .= $mark . $query;
}
if ($this->getFragment()) {
$url .= '#' . $this->getFragment();
}
return $this->escape($url);
}
/**
* Return singleton model instance
*
* @param string $name
* @param array $arguments
* @return Mage_Core_Model_Abstract
*/
protected function _getSingletonModel($name, $arguments = array())
{
return Mage::getSingleton($name, $arguments);
}
/**
* Check and add session id to URL
*
* @param string $url
*
* @return Mage_Core_Model_Url
*/
protected function _prepareSessionUrl($url)
{
return $this->_prepareSessionUrlWithParams($url, array());
}
/**
* Check and add session id to URL, session is obtained with parameters
*
* @param string $url
* @param array $params
*
* @return Mage_Core_Model_Url
*/
protected function _prepareSessionUrlWithParams($url, array $params)
{
if (!$this->getUseSession()) {
return $this;
}
/** @var $session Mage_Core_Model_Session */
$session = Mage::getSingleton('core/session', $params);
$sessionId = $session->getSessionIdForHost($url);
if (Mage::app()->getUseSessionVar() && !$sessionId) {
$this->setQueryParam('___SID', $this->getSecure() ? 'S' : 'U'); // Secure/Unsecure
} else if ($sessionId) {
$this->setQueryParam($session->getSessionIdQueryParam(), $sessionId);
}
return $this;
}
/**
* Rebuild URL to handle the case when session ID was changed
*
* @param string $url
* @return string
*/
public function getRebuiltUrl($url)
{
$this->parseUrl($url);
$port = $this->getPort();
if ($port) {
$port = ':' . $port;
} else {
$port = '';
}
$url = $this->getScheme() . '://' . $this->getHost() . $port . $this->getPath();
$this->_prepareSessionUrl($url);
$query = $this->getQuery();
if ($query) {
$url .= '?' . $query;
}
$fragment = $this->getFragment();
if ($fragment) {
$url .= '#' . $fragment;
}
return $this->escape($url);
}
/**
* Escape (enclosure) URL string
*
* @param string $value
* @return string
*/
public function escape($value)
{
$value = str_replace('"', '%22', $value);
$value = str_replace("'", '%27', $value);
$value = str_replace('>', '%3E', $value);
$value = str_replace('<', '%3C', $value);
return $value;
}
/**
* Build url by direct url and parameters
*
* @param string $url
* @param array $params
* @return string
*/
public function getDirectUrl($url, $params = array()) {
$params['_direct'] = $url;
return $this->getUrl('', $params);
}
/**
* Replace Session ID value in URL
*
* @param string $html
* @return string
*/
public function sessionUrlVar($html)
{
return preg_replace_callback('#(\?|&|&)___SID=([SU])(&|&)?#',
array($this, "sessionVarCallback"), $html);
}
/**
* Check and return use SID for URL
*
* @param bool $secure
* @return bool
*/
public function useSessionIdForUrl($secure = false)
{
$key = 'use_session_id_for_url_' . (int) $secure;
if (is_null($this->getData($key))) {
$httpHost = Mage::app()->getFrontController()->getRequest()->getHttpHost();
$urlHost = parse_url(Mage::app()->getStore()->getBaseUrl(Mage_Core_Model_Store::URL_TYPE_LINK, $secure),
PHP_URL_HOST);
if ($httpHost != $urlHost) {
$this->setData($key, true);
} else {
$this->setData($key, false);
}
}
return $this->getData($key);
}
/**
* Callback function for session replace
*
* @param array $match
* @return string
*/
public function sessionVarCallback($match)
{
if ($this->useSessionIdForUrl($match[2] == 'S' ? true : false)) {
$session = Mage::getSingleton('core/session');
/* @var $session Mage_Core_Model_Session */
return $match[1]
. $session->getSessionIdQueryParam()
. '=' . $session->getEncryptedSessionId()
. (isset($match[3]) ? $match[3] : '');
} else {
if ($match[1] == '?' && isset($match[3])) {
return '?';
} elseif ($match[1] == '?' && !isset($match[3])) {
return '';
} elseif (($match[1] == '&' || $match[1] == '&') && !isset($match[3])) {
return '';
} elseif (($match[1] == '&' || $match[1] == '&') && isset($match[3])) {
return $match[3];
}
}
return '';
}
/**
* Check if users originated URL is one of the domain URLs assigned to stores
*
* @return boolean
*/
public function isOwnOriginUrl()
{
$storeDomains = array();
$referer = parse_url(Mage::app()->getFrontController()->getRequest()->getServer('HTTP_REFERER'), PHP_URL_HOST);
foreach (Mage::app()->getStores() as $store) {
$storeDomains[] = parse_url($store->getBaseUrl(), PHP_URL_HOST);
$storeDomains[] = parse_url($store->getBaseUrl(Mage_Core_Model_Store::URL_TYPE_LINK, true), PHP_URL_HOST);
}
$storeDomains = array_unique($storeDomains);
if (empty($referer) || in_array($referer, $storeDomains)) {
return true;
}
return false;
}
/**
* Return frontend redirect URL with SID and other session parameters if any
*
* @param string $url
*
* @return string
*/
public function getRedirectUrl($url)
{
$this->_prepareSessionUrlWithParams($url, array(
'name' => Mage_Core_Controller_Front_Action::SESSION_NAMESPACE
));
$query = $this->getQuery(false);
if ($query) {
$url .= (strpos($url, '?') === false ? '?' : '&') . $query;
}
return $url;
}
}