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_Server_Handler_Abstract

Webservice default handler

Direct known subclasses

Mage_Api_Model_Server_Handler, Mage_Api_Model_Server_V2_Handler, Mage_Api_Model_Server_WSI_Handler
Abstract
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/Server/Handler/Abstract.php
Methods summary
public
# __construct( )
public
# handlePhpError( mixed $errorCode, mixed $errorMessage, mixed $errorFile )
protected Mage_Api_Model_Session
# _getSession( )

Retrive webservice session

Retrive webservice session

Returns

Mage_Api_Model_Session
protected Mage_Api_Model_Config
# _getConfig( )

Retrive webservice configuration

Retrive webservice configuration

Returns

Mage_Api_Model_Config
protected Mage_Api_Model_Server
# _getServer( )

Retrive webservice server

Retrive webservice server

Returns

Mage_Api_Model_Server
protected Mage_Api_Model_Server_Handler_Abstract
# _startSession( string $sessionId = null )

Start webservice session

Start webservice session

Parameters

$sessionId
string
$sessionId

Returns

Mage_Api_Model_Server_Handler_Abstract
protected 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
protected boolean
# _isSessionExpired( )

Check session expiration

Check session expiration

Returns

boolean
protected
# _fault( string $faultName, string $resourceName = null, string $customMessage = null )

Dispatch webservice fault

Dispatch webservice fault

Parameters

$faultName
string
$faultName
$resourceName
string
$resourceName
$customMessage
string
$customMessage
protected array
# _faultAsArray( string $faultName, string $resourceName = null, string $customMessage = null )

Retrive webservice fault as array

Retrive webservice fault as array

Parameters

$faultName
string
$faultName
$resourceName
string
$resourceName
$customMessage
string
$customMessage

Returns

array
public string
# startSession( )

Start web service session

Start web service session

Returns

string
public boolean
# endSession( string $sessionId )

End web service session

End web service session

Parameters

$sessionId
string
$sessionId

Returns

boolean
protected string
# _prepareResourceModelName( string $resource )

Enter description here...

Enter description here...

Parameters

$resource
string
$resource

Returns

string
public string
# login( string $username, string $apiKey = null )

Login user and Retrieve session id

Login user and Retrieve session id

Parameters

$username
string
$username
$apiKey
string
$apiKey

Returns

string
public mixed
# call( string $sessionId, string $apiPath, array $args = array() )

Call resource functionality

Call resource functionality

Parameters

$sessionId
string
$sessionId
$apiPath
string
$apiPath
$args
array
$args

Returns

mixed
public array
# multiCall( string $sessionId, array $calls = array(), array $options = array() )

Multiple calls of resource functionality

Multiple calls of resource functionality

Parameters

$sessionId
string
$sessionId
$calls
array
$calls
$options
array
$options

Returns

array
public array
# resources( string $sessionId )

List of available resources

List of available resources

Parameters

$sessionId
string
$sessionId

Returns

array
public array
# resourceFaults( string $sessionId, string $resourceName )

List of resource faults

List of resource faults

Parameters

$sessionId
string
$sessionId
$resourceName
string
$resourceName

Returns

array
public array
# globalFaults( string $sessionId )

List of global faults

List of global faults

Parameters

$sessionId
string
$sessionId

Returns

array
Properties summary
protected mixed $_resourceSuffix null
#
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0