Class Mage_Adminhtml_Model_Url

Description

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 [email protected] 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.magentocommerce.com for more information.

Located in /Adminhtml/Model/Url.php (line 26)

Varien_Object
   |
   --Mage_Core_Model_Url
      |
      --Mage_Adminhtml_Model_Url
Class Constant Summary
Method Summary
string getSecretKey ([string $controller = null], [string $action = null])
bool getSecure ()
string getUrl ([string $routePath = null], [array $routeParams = null])
Mage_Core_Model_Url setRouteParams ( $data, [ $unsetOldParams = true])
boolean useSecretKey ()
Variables
Methods
getSecretKey (line 112)

Generate secret key for controller and action based on form key

  • access: public
string getSecretKey ([string $controller = null], [string $action = null])
  • string $controller: Controller name
  • string $action: Action name
getSecure (line 38)

Retrieve is secure mode for ULR logic

  • access: public
bool getSecure ()

Redefinition of:
Mage_Core_Model_Url::getSecure()
Retrieve is secure mode URL
getUrl (line 70)

Custom logic to retrieve Urls

  • access: public
string getUrl ([string $routePath = null], [array $routeParams = null])
  • string $routePath
  • array $routeParams

Redefinition of:
Mage_Core_Model_Url::getUrl()
Build url by requested path and parameters
renewSecretUrls (line 165)

Refresh admin menu cache etc.

  • access: public
Mage_Adminhtml_Model_Url renewSecretUrls ()
setRouteParams (line 51)

Force strip secret key param if _nosecret param specified

  • access: public
Mage_Core_Model_Url setRouteParams ( $data, [ $unsetOldParams = true])
  • array $data
  • $unsetOldParams

Redefinition of:
Mage_Core_Model_Url::setRouteParams()
turnOffSecretKey (line 154)

Disable secret key using

  • access: public
Mage_Adminhtml_Model_Url turnOffSecretKey ()
turnOnSecretKey (line 143)

Enable secret key using

  • access: public
Mage_Adminhtml_Model_Url turnOnSecretKey ()
useSecretKey (line 133)

Return secret key settings flag

  • access: public
boolean useSecretKey ()

Inherited Methods

Inherited From Mage_Core_Model_Url

Mage_Core_Model_Url::addSessionParam()
Mage_Core_Model_Url::checkCookieDomains()
Mage_Core_Model_Url::escape()
Mage_Core_Model_Url::getActionName()
Mage_Core_Model_Url::getActionPath()
Mage_Core_Model_Url::getBaseUrl()
Mage_Core_Model_Url::getConfigData()
Mage_Core_Model_Url::getControllerName()
Mage_Core_Model_Url::getDefaultActionName()
Mage_Core_Model_Url::getDefaultControllerName()
Mage_Core_Model_Url::getDirectUrl()
Mage_Core_Model_Url::getFragment()
Mage_Core_Model_Url::getQuery()
Mage_Core_Model_Url::getQueryParam()
Mage_Core_Model_Url::getQueryParams()
Mage_Core_Model_Url::getRequest()
Mage_Core_Model_Url::getRouteFrontName()
Mage_Core_Model_Url::getRouteName()
Mage_Core_Model_Url::getRouteParam()
Mage_Core_Model_Url::getRouteParams()
Mage_Core_Model_Url::getRoutePath()
Mage_Core_Model_Url::getRouteUrl()
Mage_Core_Model_Url::getSecure()
Mage_Core_Model_Url::getStore()
Mage_Core_Model_Url::getType()
Mage_Core_Model_Url::getUrl()
Mage_Core_Model_Url::getUseSession()
Mage_Core_Model_Url::isOwnOriginUrl()
Mage_Core_Model_Url::parseUrl()
Mage_Core_Model_Url::purgeQueryParams()
Mage_Core_Model_Url::sessionUrlVar()
Mage_Core_Model_Url::sessionVarCallback()
Mage_Core_Model_Url::setActionName()
Mage_Core_Model_Url::setControllerName()
Mage_Core_Model_Url::setFragment()
Mage_Core_Model_Url::setQuery()
Mage_Core_Model_Url::setQueryParam()
Mage_Core_Model_Url::setQueryParams()
Mage_Core_Model_Url::setRequest()
Mage_Core_Model_Url::setRouteFrontName()
Mage_Core_Model_Url::setRouteName()
Mage_Core_Model_Url::setRouteParam()
Mage_Core_Model_Url::setRouteParams()
Mage_Core_Model_Url::setRoutePath()
Mage_Core_Model_Url::setStore()
Mage_Core_Model_Url::setUseSession()
Mage_Core_Model_Url::setUseUrlCache()
Mage_Core_Model_Url::useSessionIdForUrl()
Mage_Core_Model_Url::_construct()
Mage_Core_Model_Url::_prepareSessionUrl()
Class Constants

Documentation generated on Fri, 11 Feb 2011 17:15:31 +0200 by phpDocumentor 1.4.3