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_Helper_Data

Web service api main helper

Mage_Core_Helper_Abstract
Extended by Mage_Api_Helper_Data
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/Helper/Data.php
Methods summary
public string
# getV2AdapterCode( )

Method to find adapter code depending on WS-I compatibility setting

Method to find adapter code depending on WS-I compatibility setting

Returns

string
public boolean
# isComplianceWSI( )

Returns

boolean
public Object
# wsiArrayUnpacker( Object & $obj )

Go thru a WSI args array and turns it to correct state.

Go thru a WSI args array and turns it to correct state.

Parameters

$obj
Object
$obj - Link to Object

Returns

Object
public Object
# v2AssociativeArrayUnpacker( Object & $obj )

Go thru an object parameters and unpak associative object to array.

Go thru an object parameters and unpak associative object to array.

Parameters

$obj
Object
$obj - Link to Object

Returns

Object
public
# associativeArrayUnpack( Mixed & $mixed )

Go thru mixed and turns it to a correct look.

Go thru mixed and turns it to a correct look.

Parameters

$mixed
Mixed
$mixed A link to variable that may contain associative array.
public Object
# clearWsiFootprints( Object & $obj )

Corrects data representation.

Corrects data representation.

Parameters

$obj
Object
$obj - Link to Object

Returns

Object
public mixed
# wsiArrayPacker( mixed $mixed )

For the WSI, generates an response object.

For the WSI, generates an response object.

Parameters

$mixed
mixed
$mixed - Link to Object

Returns

mixed
public Object
# packArrayToObjec( array $arr )

For response to the WSI, generates an object from array.

For response to the WSI, generates an object from array.

Parameters

$arr
Array
$arr - Link to Object

Returns

Object
public
# toArray( array|object & $data )

Convert objects and arrays to array recursively

Convert objects and arrays to array recursively

Parameters

$data
array|object
$data
public array
# parseFilters( null|object|array $filters, array $fieldsMap = null )

Parse filters and format them to be applicable for collection filtration

Parse filters and format them to be applicable for collection filtration

Parameters

$filters
null|object|array
$filters
$fieldsMap
array
$fieldsMap Map of field names in format: array('field_name_in_filter' => 'field_name_in_db')

Returns

array
public
# formatFilterConditionValue( string $conditionOperator, string & $conditionValue )

Convert condition value from the string into the array for the condition operators that require value to be an array. Condition value is changed by reference

Convert condition value from the string into the array for the condition operators that require value to be an array. Condition value is changed by reference

Parameters

$conditionOperator
string
$conditionOperator
$conditionValue
string
$conditionValue
Methods inherited from Mage_Core_Helper_Abstract
__(), _cleanCache(), _getModuleName(), _getRequest(), _getUrl(), _loadCache(), _removeCache(), _saveCache(), escapeHtml(), escapeUrl(), getLayout(), isModuleEnabled(), isModuleOutputEnabled(), jsQuoteEscape(), quoteEscape(), removeTags(), setLayout(), stripTags(), translateArray(), urlDecode(), urlEncode()
Constants summary
string XML_PATH_API_WSI 'api/config/compliance_wsi'
#
Properties inherited from Mage_Core_Helper_Abstract
$_layout, $_moduleName, $_request
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0