Docs For Class Mage_Api_Model_Server_Handler

Description

Webservice default handler

author: Magento Core Team <[email protected]>
abstract:

Located in /Api/Model/Server/Handler/Abstract.php (line 34)

Direct descendents

Class	Description
Mage_Api_Model_Server_V2_Handler	Webservices server handler v2
Mage_Api_Model_Server_Handler	Webservices default server handler

Variable Summary

mixed $_resourceSuffix

Method Summary

Mage_Api_Model_Server_Handler_Abstract __construct ()

mixed call (string $sessionId, $apiPath, [array $args = array()], string $resourcePath)

boolean endSession (string $sessionId)

array globalFaults (string $sessionId)

void handlePhpError ( $errorCode, $errorMessage, $errorFile)

string login (string $username, string $apiKey)

array multiCall (string $sessionId, [ $calls = array()], [array $options = array()])

array resourceFaults (string $sessionId, string $resourceName)

array resources (string $sessionId)

string startSession ()

void _fault (string $faultName, [string $resourceName = null], [string $customMessage = null])

array _faultAsArray (string $faultName, [string $resourceName = null], [string $customMessage = null])

Mage_Api_Model_Config _getConfig ()

Mage_Api_Model_Server _getServer ()

Mage_Api_Model_Session _getSession ()

bool _isAllowed (string $resource, [string $privilege = null])

boolean _isSessionExpired ()

string _prepareResourceModelName (string $resource)

Mage_Api_Model_Server_Handler_Abstract _startSession ([string $sessionId = null])

Variables

mixed $_resourceSuffix = null (line 36)

access: protected

Redefined in descendants as:

Mage_Api_Model_Server_V2_Handler::$_resourceSuffix

Methods

Constructor __construct (line 38)

access: public

Mage_Api_Model_Server_Handler_Abstract __construct ()

call (line 231)

Call resource functionality

access: public

mixed call (string $sessionId, $apiPath, [array $args = array()], string $resourcePath)

string $sessionId
string $resourcePath
array $args
$apiPath

endSession (line 184)

End web service session

access: public

boolean endSession (string $sessionId)

string $sessionId

globalFaults (line 536)

List of global faults

access: public

array globalFaults (string $sessionId)

string $sessionId

handlePhpError (line 43)

access: public

void handlePhpError ( $errorCode, $errorMessage, $errorFile)

$errorCode
$errorMessage
$errorFile

login (line 212)

Login user and Retrieve session id

access: public

string login (string $username, string $apiKey)

string $username
string $apiKey

multiCall (line 312)

Multiple calls of resource functionality

access: public

array multiCall (string $sessionId, [ $calls = array()], [array $options = array()])

string $sessionId
array $calls
array $options

resourceFaults (line 501)

List of resource faults

access: public

array resourceFaults (string $sessionId, string $resourceName)

string $sessionId
string $resourceName

resources (line 436)

List of available resources

access: public

array resources (string $sessionId)

string $sessionId

startSession (line 171)

Start web service session

access: public

string startSession ()

_fault (line 126)

Dispatch webservice fault

access: protected

void _fault (string $faultName, [string $resourceName = null], [string $customMessage = null])

string $faultName
string $resourceName
string $customMessage

_faultAsArray (line 150)

Retrive webservice fault as array

access: protected

array _faultAsArray (string $faultName, [string $resourceName = null], [string $customMessage = null])

string $faultName
string $resourceName
string $customMessage

_getConfig (line 68)

Retrive webservice configuration

access: protected

Mage_Api_Model_Config _getConfig ()

_getServer (line 78)

Retrive webservice server

access: protected

Mage_Api_Model_Server _getServer ()

_getSession (line 58)

Retrive webservice session

access: protected

Mage_Api_Model_Session _getSession ()

_isAllowed (line 104)

Check current user permission on resource and privilege

access: protected

bool _isAllowed (string $resource, [string $privilege = null])

string $resource
string $privilege

_isSessionExpired (line 114)

Check session expiration

access: protected

boolean _isSessionExpired ()

_prepareResourceModelName (line 197)

Enter description here...

access: protected

string _prepareResourceModelName (string $resource)

string $resource

_startSession (line 89)

Start webservice session

access: protected

Mage_Api_Model_Server_Handler_Abstract _startSession ([string $sessionId = null])

string $sessionId

Class Mage_Api_Model_Server_Handler_Abstract