Class Mage_Api2_Helper_Data

Webservice API2 data helper

Mage_Api2_Helper_Data

Package: Mage\Api2
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/Api2/Helper/Data.php

Methods summary
`protected static integer`	# `_compareOrder( integer $a, integer $b )` Compare order to be used in adapters list sort Compare order to be used in adapters list sort Parameters `$a` `integer` $a `$b` `integer` $b Returns `integer`
`public array`	# `getAuthAdapters( boolean $enabledOnly = false )` Retrieve Auth adapters info from configuration file as array Retrieve Auth adapters info from configuration file as array Parameters `$enabledOnly` `boolean` $enabledOnly Returns `array`
`public array`	# `getUserTypes( )` Retrieve enabled user types in form of user type => user model pairs Retrieve enabled user types in form of user type => user model pairs Returns `array`
`public array`	# `getRequestInterpreterAdapters( )` Get interpreter type for Request body according to Content-type HTTP header Get interpreter type for Request body according to Content-type HTTP header Returns `array`
`public array`	# `getResponseRenderAdapters( )` Get interpreter type for Request body according to Content-type HTTP header Get interpreter type for Request body according to Content-type HTTP header Returns `array`
`public boolean`	# `isApiTypeSupported( string $type )` Check API type support Check API type support Parameters `$type` `string` $type Returns `boolean`
`public array`	# `getAllowedAttributes( string $userType, string $resourceId, string $operation )` Get allowed attributes of a rule Get allowed attributes of a rule Parameters `$userType` `string` $userType `$resourceId` `string` $resourceId `$operation` `string` $operation One of Mage_Api2_Model_Resource::OPERATION_ATTRIBUTE_... constant Returns `array`
`public boolean`	# `isAllAttributesAllowed( string $userType )` Check if ALL attributes are allowed Check if ALL attributes are allowed Parameters `$userType` `string` $userType Returns `boolean`
`public string`	# `getTypeOfOperation( string $operation )` Get operation type for specified operation Get operation type for specified operation Parameters `$operation` `string` $operation One of Mage_Api2_Model_Resource::OPERATION_... constant Returns `string` One of Mage_Api2_Model_Resource::OPERATION_ATTRIBUTE_... constant Throws `Exception`

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_API2_REQUEST_INTERPRETERS`	`'global/api2/request/interpreters'`	# Request interpret adapters Request interpret adapters
`string`	`XML_PATH_API2_RESPONSE_RENDERS`	`'global/api2/response/renders'`	# Response render adapters Response render adapters
`string`	`XML_PATH_AUTH_ADAPTERS`	`'global/api2/auth_adapters'`	# Config paths Config paths
`string`	`XML_PATH_USER_TYPES`	`'global/api2/user_types'`	#

Properties inherited from Mage_Core_Helper_Abstract
`$_layout, $_moduleName, $_request`

Packages

Classes

Interfaces

Exceptions

Class Mage_Api2_Helper_Data

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws