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_Api_Controller_Action
  • Mage_Api_Helper_Data
  • Mage_Api_IndexController
  • Mage_Api_Model_Acl
  • Mage_Api_Model_Acl_Assert_Ip
  • Mage_Api_Model_Acl_Assert_Time
  • Mage_Api_Model_Acl_Resource
  • Mage_Api_Model_Acl_Role
  • Mage_Api_Model_Acl_Role_Generic
  • Mage_Api_Model_Acl_Role_Group
  • Mage_Api_Model_Acl_Role_Registry
  • Mage_Api_Model_Acl_Role_User
  • Mage_Api_Model_Config
  • Mage_Api_Model_Mysql4_Acl
  • Mage_Api_Model_Mysql4_Acl_Role
  • Mage_Api_Model_Mysql4_Acl_Role_Collection
  • Mage_Api_Model_Mysql4_Permissions_Collection
  • Mage_Api_Model_Mysql4_Role
  • Mage_Api_Model_Mysql4_Role_Collection
  • Mage_Api_Model_Mysql4_Roles
  • Mage_Api_Model_Mysql4_Roles_Collection
  • Mage_Api_Model_Mysql4_Roles_User_Collection
  • Mage_Api_Model_Mysql4_Rules
  • Mage_Api_Model_Mysql4_Rules_Collection
  • Mage_Api_Model_Mysql4_User
  • Mage_Api_Model_Mysql4_User_Collection
  • Mage_Api_Model_Resource_Abstract
  • Mage_Api_Model_Resource_Acl
  • Mage_Api_Model_Resource_Acl_Role
  • Mage_Api_Model_Resource_Acl_Role_Collection
  • Mage_Api_Model_Resource_Permissions_Collection
  • Mage_Api_Model_Resource_Role
  • Mage_Api_Model_Resource_Role_Collection
  • Mage_Api_Model_Resource_Roles
  • Mage_Api_Model_Resource_Roles_Collection
  • Mage_Api_Model_Resource_Roles_User_Collection
  • Mage_Api_Model_Resource_Rules
  • Mage_Api_Model_Resource_Rules_Collection
  • Mage_Api_Model_Resource_User
  • Mage_Api_Model_Resource_User_Collection
  • Mage_Api_Model_Role
  • Mage_Api_Model_Roles
  • Mage_Api_Model_Rules
  • Mage_Api_Model_Server
  • Mage_Api_Model_Server_Adapter_Soap
  • Mage_Api_Model_Server_Adapter_Xmlrpc
  • Mage_Api_Model_Server_Handler
  • Mage_Api_Model_Server_Handler_Abstract
  • Mage_Api_Model_Server_V2_Adapter_Soap
  • Mage_Api_Model_Server_V2_Handler
  • Mage_Api_Model_Server_WSI_Adapter_Soap
  • Mage_Api_Model_Server_WSI_Handler
  • Mage_Api_Model_Session
  • Mage_Api_Model_User
  • Mage_Api_Model_Wsdl_Config
  • Mage_Api_Model_Wsdl_Config_Base
  • Mage_Api_SoapController
  • Mage_Api_V2_SoapController
  • Mage_Api_XmlrpcController

Interfaces

  • Mage_Api_Model_Server_Adapter_Interface

Exceptions

  • Mage_Api_Exception
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Api_Model_Session

Webservice api session

Varien_Object
Extended by Mage_Core_Model_Session_Abstract_Varien
Extended by Mage_Core_Model_Session_Abstract
Extended by Mage_Api_Model_Session
Package: Mage\Api
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/Api/Model/Session.php
Methods summary
public Mage_Core_Model_Session_Abstract_Varien
# start( string $sessionName = null )

Configure and start session

Configure and start session

Parameters

$sessionName
string
$sessionName

Returns

Mage_Core_Model_Session_Abstract_Varien

Overrides

Mage_Core_Model_Session_Abstract_Varien::start()
public Mage_Core_Model_Session_Abstract
# init( string $namespace, string $sessionName = null )

Init session

Init session

Parameters

$namespace
string
$namespace
$sessionName
string
$sessionName

Returns

Mage_Core_Model_Session_Abstract

Overrides

Mage_Core_Model_Session_Abstract::init()
public string
# getSessionId( )

Retrieve session Id

Retrieve session Id

Returns

string

Overrides

Mage_Core_Model_Session_Abstract_Varien::getSessionId()
public Mage_Core_Model_Session_Abstract
# setSessionId( string|null $sessId = null )

Specify session identifier

Specify session identifier

Parameters

$sessId
string|null
$id

Returns

Mage_Core_Model_Session_Abstract

Overrides

Mage_Core_Model_Session_Abstract::setSessionId()
public Mage_Core_Model_Session_Abstract_Varien
# clear( )

Alias for unsetAll

Alias for unsetAll

Returns

Mage_Core_Model_Session_Abstract_Varien

Overrides

Mage_Core_Model_Session_Abstract_Varien::clear()
public
# login( mixed $username, mixed $apiKey )
public
# refreshAcl( mixed $user = null )
public boolean
# isAllowed( string $resource, string $privilege = null )

Check current user permission on resource and privilege

Check current user permission on resource and privilege

Parameters

$resource
string
$resource
$privilege
string
$privilege

Returns

boolean
public boolean
# isSessionExpired( mixed $user )

Check session expiration

Check session expiration

Returns

boolean
public
# isLoggedIn( mixed $sessId = false )
protected boolean
# _renewBySessId( string $sessId )

Renew user by session ID if session not expired

Renew user by session ID if session not expired

Parameters

$sessId
string
$sessId

Returns

boolean
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(), setSkipSessionIdFlag(), useSid(), useValidateHttpUserAgent(), useValidateHttpVia(), useValidateHttpXForwardedFor(), useValidateRemoteAddr()
Methods inherited from Mage_Core_Model_Session_Abstract_Varien
_validate(), getCookie(), getData(), getSessionName(), getValidatorData(), regenerateSessionId(), setSessionName(), 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
public array $sessionIds array()
#
protected mixed $_currentSessId null
#
Properties inherited from Mage_Core_Model_Session_Abstract
$_encryptedSessionId, $_skipSessionIdFlag, $_urlHostCache
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0