Mage_Adminhtml_Model_Url Class Reference

Inheritance diagram for Mage_Adminhtml_Model_Url:

List of all members.

Public Member Functions
	getSecure ()
	setRouteParams (array $data, $unsetOldParams=true)
	getUrl ($routePath=null, $routeParams=null)
	getSecretKey ($controller=null, $action=null)
	useSecretKey ()
	turnOnSecretKey ()
	turnOffSecretKey ()
	renewSecretUrls ()
Public Attributes
const	SECRET_KEY_PARAM_NAME = 'key'

---

Detailed Description

Definition at line 26 of file Url.php.

---

Member Function Documentation

getSecretKey	(	$	controller = null,
		$	action = null
	)

Generate secret key for controller and action based on form key

Parameters:

	string	$controller Controller name
	string	$action Action name

Returns:

string

Definition at line 100 of file Url.php.

    {
        $salt = Mage::getSingleton('core/session')->getFormKey();

        $p = explode('/', trim($this->getRequest()->getOriginalPathInfo(), '/'));
        if (!$controller) {
            $controller = !empty($p[1]) ? $p[1] : $this->getRequest()->getControllerName();
        }
        if (!$action) {
            $action = !empty($p[2]) ? $p[2] : $this->getRequest()->getActionName();
        }

        $secret = $controller . $action . $salt;
        return Mage::helper('core')->getHash($secret);
    }

getSecure

(

)

Retrieve is secure mode for ULR logic

Returns:

bool

Reimplemented from Mage_Core_Model_Url.

Definition at line 38 of file Url.php.

    {
        if ($this->hasData('secure_is_forced')) {
            return $this->getData('secure');
        }
        return Mage::getStoreConfigFlag('web/secure/use_in_adminhtml');
    }

getUrl	(	$	routePath = null,
		$	routeParams = null
	)

Custom logic to retrieve Urls

Parameters:

	string	$routePath
	array	$routeParams

Returns:

string

Reimplemented from Mage_Core_Model_Url.

Definition at line 70 of file Url.php.

    {
        $result = parent::getUrl($routePath, $routeParams);

        if (!$this->useSecretKey()) {
            return $result;
        }

        $_route = $this->getRouteName() ? $this->getRouteName() : '*';
        $_controller = $this->getControllerName() ? $this->getControllerName() : $this->getDefaultControllerName();
        $_action = $this->getActionName() ? $this->getActionName() : $this->getDefaultActionName();
        $secret = array(self::SECRET_KEY_PARAM_NAME => $this->getSecretKey($_controller, $_action));
        if (is_array($routeParams)) {
            $routeParams = array_merge($secret, $routeParams);
        } else {
            $routeParams = $secret;
        }
        if (is_array($this->getRouteParams())) {
            $routeParams = array_merge($this->getRouteParams(), $routeParams);
        }
        return parent::getUrl("{$_route}/{$_controller}/{$_action}", $routeParams);
    }

renewSecretUrls

(

)

Refresh admin menu cache etc.

Returns:

Mage_Adminhtml_Model_Url

Definition at line 153 of file Url.php.

    {
        Mage::app()->cleanCache(array(Mage_Adminhtml_Block_Page_Menu::CACHE_TAGS));
    }

setRouteParams	(	array $	data,
		$	unsetOldParams = true
	)

Force strip secret key param if _nosecret param specified

Returns:

Mage_Core_Model_Url

Reimplemented from Mage_Core_Model_Url.

Definition at line 51 of file Url.php.

    {
        if (isset($data['_nosecret'])) {
            $this->setNoSecret(true);
            unset($data['_nosecret']);
        } else {
            $this->setNoSecret(false);
        }

        return parent::setRouteParams($data, $unsetOldParams);
    }

turnOffSecretKey

(

)

Disable secret key using

Returns:

Mage_Adminhtml_Model_Url

Definition at line 142 of file Url.php.

    {
        $this->setNoSecret(true);
        return $this;
    }

turnOnSecretKey

(

)

Enable secret key using

Returns:

Mage_Adminhtml_Model_Url

Definition at line 131 of file Url.php.

    {
        $this->setNoSecret(false);
        return $this;
    }

useSecretKey

(

)

Return secret key settings flag

Returns:

boolean

Definition at line 121 of file Url.php.

    {
        return Mage::getStoreConfigFlag('admin/security/use_form_key') && !$this->getNoSecret();
    }

---

Member Data Documentation

const SECRET_KEY_PARAM_NAME = 'key'

Secret key query param name

Definition at line 31 of file Url.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Adminhtml/Model/Url.php