Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_Admin_Helper_Data
  • Mage_Admin_Model_Acl
  • Mage_Admin_Model_Acl_Assert_Ip
  • Mage_Admin_Model_Acl_Assert_Time
  • Mage_Admin_Model_Acl_Resource
  • Mage_Admin_Model_Acl_Role
  • Mage_Admin_Model_Acl_Role_Generic
  • Mage_Admin_Model_Acl_Role_Group
  • Mage_Admin_Model_Acl_Role_Registry
  • Mage_Admin_Model_Acl_Role_User
  • Mage_Admin_Model_Config
  • Mage_Admin_Model_Mysql4_Acl
  • Mage_Admin_Model_Mysql4_Acl_Role
  • Mage_Admin_Model_Mysql4_Acl_Role_Collection
  • Mage_Admin_Model_Mysql4_Permissions_Collection
  • Mage_Admin_Model_Mysql4_Role
  • Mage_Admin_Model_Mysql4_Role_Collection
  • Mage_Admin_Model_Mysql4_Roles
  • Mage_Admin_Model_Mysql4_Roles_Collection
  • Mage_Admin_Model_Mysql4_Roles_User_Collection
  • Mage_Admin_Model_Mysql4_Rules
  • Mage_Admin_Model_Mysql4_Rules_Collection
  • Mage_Admin_Model_Mysql4_User
  • Mage_Admin_Model_Mysql4_User_Collection
  • Mage_Admin_Model_Observer
  • Mage_Admin_Model_Resource_Acl
  • Mage_Admin_Model_Resource_Acl_Role_Collection
  • Mage_Admin_Model_Resource_Permissions_Collection
  • Mage_Admin_Model_Resource_Role
  • Mage_Admin_Model_Resource_Role_Collection
  • Mage_Admin_Model_Resource_Roles
  • Mage_Admin_Model_Resource_Roles_Collection
  • Mage_Admin_Model_Resource_Roles_User_Collection
  • Mage_Admin_Model_Resource_Rules
  • Mage_Admin_Model_Resource_Rules_Collection
  • Mage_Admin_Model_Resource_User
  • Mage_Admin_Model_Resource_User_Collection
  • Mage_Admin_Model_Role
  • Mage_Admin_Model_Roles
  • Mage_Admin_Model_Rules
  • Mage_Admin_Model_Session
  • Mage_Admin_Model_User
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Admin_Model_Session

Auth session model

Varien_Object
Extended by Mage_Core_Model_Session_Abstract_Varien
Extended by Mage_Core_Model_Session_Abstract
Extended by Mage_Admin_Model_Session
Package: Mage\Admin
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/Admin/Model/Session.php
Methods summary
public
# __construct( )

Class constructor

Class constructor

public Mage_Admin_Model_Session
# init( string $namespace, string $sessionName = null )

Pull out information from session whether there is currently the first page after log in

Pull out information from session whether there is currently the first page after log in

The idea is to set this value on login(), then redirect happens, after that on next request the value is grabbed once the session is initialized Since the session is used as a singleton, the value will be in $_isFirstPageAfterLogin until the end of request, unless it is reset intentionally from somewhere

Parameters

$namespace
string
$namespace
$sessionName
string
$sessionName

Returns

Mage_Admin_Model_Session

See

Mage_Admin_Model_Session::login()

Overrides

Mage_Core_Model_Session_Abstract::init()
public Mage_Admin_Model_User|null
# login( string $username, string $password, Mage_Core_Controller_Request_Http $request = null )

Try to login user in admin

Try to login user in admin

Parameters

$username
string
$username
$password
string
$password
$request
Mage_Core_Controller_Request_Http
$request

Returns

Mage_Admin_Model_User|null
public Mage_Admin_Model_Session
# refreshAcl( Mage_Admin_Model_User $user = null )

Refresh ACL resources stored in session

Refresh ACL resources stored in session

Parameters

$user
Mage_Admin_Model_User
$user

Returns

Mage_Admin_Model_Session
public boolean
# isAllowed( string $resource, string $privilege = null )

Check current user permission on resource and privilege

Check current user permission on resource and privilege

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

Parameters

$resource
string
$resource
$privilege
string
$privilege

Returns

boolean
public boolean
# isLoggedIn( )

Check if user is logged in

Check if user is logged in

Returns

boolean
public boolean
# isFirstPageAfterLogin( )

Check if it is the first page after successfull login

Check if it is the first page after successfull login

Returns

boolean
public Mage_Admin_Model_Session
# setIsFirstPageAfterLogin( boolean $value )

Setter whether the current/next page should be treated as first page after login

Setter whether the current/next page should be treated as first page after login

Parameters

$value
boolean
$value

Returns

Mage_Admin_Model_Session
protected string|null
# _getRequestUri( Mage_Core_Controller_Request_Http $request = null )

Custom REQUEST_URI logic

Custom REQUEST_URI logic

Parameters

$request
Mage_Core_Controller_Request_Http
$request

Returns

string|null
Methods inherited from Mage_Core_Model_Session_Abstract
addError(), addException(), addHost(), addMessage(), addMessages(), addNotice(), addSuccess(), addUniqueMessages(), addWarning(), getCookieDomain(), getCookieLifetime(), getCookiePath(), getEncryptedSessionId(), getMessages(), getSessionHosts(), getSessionIdForHost(), getSessionIdQueryParam(), getSessionSaveMethod(), getSessionSavePath(), getSkipSessionIdFlag(), getValidateHttpUserAgentSkip(), isValidForHost(), isValidForPath(), renewSession(), setSessionId(), setSkipSessionIdFlag(), useSid(), useValidateHttpUserAgent(), useValidateHttpVia(), useValidateHttpXForwardedFor(), useValidateRemoteAddr()
Methods inherited from Mage_Core_Model_Session_Abstract_Varien
_validate(), clear(), getCookie(), getData(), getSessionId(), getSessionName(), getValidatorData(), regenerateSessionId(), setSessionName(), start(), unsetAll(), validate()
Constants inherited from Mage_Core_Model_Session_Abstract
SESSION_ID_QUERY_PARAM, XML_NODE_SESSION_SAVE, XML_NODE_SESSION_SAVE_PATH, XML_NODE_USET_AGENT_SKIP, XML_PATH_COOKIE_DOMAIN, XML_PATH_COOKIE_LIFETIME, XML_PATH_COOKIE_PATH, XML_PATH_LOG_EXCEPTION_FILE, XML_PATH_USE_FRONTEND_SID, XML_PATH_USE_HTTP_VIA, XML_PATH_USE_REMOTE_ADDR, XML_PATH_USE_USER_AGENT, XML_PATH_USE_X_FORWARDED
Constants inherited from Mage_Core_Model_Session_Abstract_Varien
VALIDATOR_HTTP_USER_AGENT_KEY, VALIDATOR_HTTP_VIA_KEY, VALIDATOR_HTTP_X_FORVARDED_FOR_KEY, VALIDATOR_KEY, VALIDATOR_REMOTE_ADDR_KEY
Properties summary
protected boolean $_isFirstPageAfterLogin
#

Whether it is the first page after successfull login

Whether it is the first page after successfull login

Properties inherited from Mage_Core_Model_Session_Abstract
$_encryptedSessionId, $_skipSessionIdFlag, $_urlHostCache
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0