Mage_Admin_Model_Session Class Reference

Inheritance diagram for Mage_Admin_Model_Session:

List of all members.

Public Member Functions
	__construct ()
	login ($username, $password, $request=null)
	refreshAcl ($user=null)
	isAllowed ($resource, $privilege=null)
	isLoggedIn ()
	isFirstPageAfterLogin ()
Protected Member Functions
	_getRequestUri ($request=null)
Protected Attributes
	$_isFirstPageAfterLogin

---

Detailed Description

Definition at line 35 of file Session.php.

---

Constructor & Destructor Documentation

__construct

(

)

Class constructor

Reimplemented from Varien_Object.

Definition at line 49 of file Session.php.

    {
        $this->init('admin');
    }

---

Member Function Documentation

_getRequestUri

(

$

request = null

)

[protected]

Custom REQUEST_URI logic

Parameters:

Mage_Core_Controller_Request_Http

$request

Returns:

string|null

Definition at line 188 of file Session.php.

    {
        if (Mage::getSingleton('adminhtml/url')->useSecretKey()) {
            return Mage::getSingleton('adminhtml/url')->getUrl('*/*/*', array('_current' => true));
        } elseif ($request) {
            return $request->getRequestUri();
        } else {
            return null;
        }
    }

isAllowed	(	$	resource,
		$	privilege = null
	)

Check current user permission on resource and privilege

Mage.getSingleton('admin/session')->isAllowed('admin/catalog') Mage.getSingleton('admin/session')->isAllowed('catalog')

Parameters:

	string	$resource
	string	$privilege

Returns:

boolean

Definition at line 136 of file Session.php.

    {
        $user = $this->getUser();
        $acl = $this->getAcl();

        if ($user && $acl) {
            if (!preg_match('/^admin/', $resource)) {
                $resource = 'admin/'.$resource;
            }

            try {
                return $acl->isAllowed($user->getAclRole(), $resource, $privilege);
            } catch (Exception $e) {
                try {
                    if (!$acl->has($resource)) {
                        return $acl->isAllowed($user->getAclRole(), null, $privilege);
                    }
                } catch (Exception $e) { }
            }
        }
        return false;
    }

isFirstPageAfterLogin

(

)

Check if it is the first page after successfull login

Returns:

boolean

Definition at line 174 of file Session.php.

    {
        if (is_null($this->_isFirstPageAfterLogin)) {
            $this->_isFirstPageAfterLogin = $this->getData('is_first_visit', true);
        }
        return $this->_isFirstPageAfterLogin;
    }

isLoggedIn

(

)

Check if user is logged in

Returns:

boolean

Definition at line 164 of file Session.php.

    {
        return $this->getUser() && $this->getUser()->getId();
    }

login	(	$	username,
		$	password,
		$	request = null
	)

Try to login user in admin

Parameters:

	string	$username
	string	$password
	Mage_Core_Controller_Request_Http	$request

Returns:

Mage_Admin_Model_User|null

Definition at line 62 of file Session.php.

    {
        if (empty($username) || empty($password)) {
            return;
        }

        try {
            /* @var $user Mage_Admin_Model_User */
            $user = Mage::getModel('admin/user');
            $user->login($username, $password);
            if ($user->getId()) {

                if (Mage::getSingleton('adminhtml/url')->useSecretKey()) {
                    Mage::getSingleton('adminhtml/url')->renewSecretUrls();
                }
                $session = Mage::getSingleton('admin/session');
                $session->setIsFirstVisit(true);
                $session->setUser($user);
                $session->setAcl(Mage::getResourceModel('admin/acl')->loadAcl());
                if ($requestUri = $this->_getRequestUri($request)) {
                    Mage::dispatchEvent('admin_session_user_login_success', array('user'=>$user));
                    header('Location: ' . $requestUri);
                    exit;
                }
            }
            else {
                Mage::throwException(Mage::helper('adminhtml')->__('Invalid Username or Password.'));
            }
        }
        catch (Mage_Core_Exception $e) {
            Mage::dispatchEvent('admin_session_user_login_failed', array('user_name'=>$username, 'exception' => $e));
            if ($request && !$request->getParam('messageSent')) {
                Mage::getSingleton('adminhtml/session')->addError($e->getMessage());
                $request->setParam('messageSent', true);
            }
        }

        return $user;
    }

refreshAcl

(

$

user = null

)

Refresh ACL resources stored in session

Parameters:

Mage_Admin_Model_User

$user

Returns:

Mage_Admin_Model_Session

Definition at line 108 of file Session.php.

    {
        if (is_null($user)) {
            $user = $this->getUser();
        }
        if (!$user) {
            return $this;
        }
        if (!$this->getAcl() || $user->getReloadAclFlag()) {
            $this->setAcl(Mage::getResourceModel('admin/acl')->loadAcl());
        }
        if ($user->getReloadAclFlag()) {
            $user->unsetData('password');
            $user->setReloadAclFlag('0')->save();
        }
        return $this;
    }

---

Member Data Documentation

$_isFirstPageAfterLogin [protected]

Definition at line 43 of file Session.php.

---

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

• app/code/core/Mage/Admin/Model/Session.php