Class Mage_Api2_Model_Config

Webservice api2 config model

Varien_Simplexml_Config

Mage_Api2_Model_Config

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/Model/Config.php

Methods summary
`public`	# `__construct( string\|Varien_Simplexml_Element\|null $sourceData = null )` Constructor Initializes XML for this configuration Local cache configuration Constructor Initializes XML for this configuration Local cache configuration Parameters `$sourceData` `string\|Varien_Simplexml_Element\|null` $sourceData
`public array`	# `getRoutes( string $apiType )` Fetch all routes of the given api type from config files api2.xml Fetch all routes of the given api type from config files api2.xml Parameters `$apiType` `string` $apiType Returns `array` Throws `Mage_Api2_Exception`
`public Varien_Simplexml_Element`	# `getResources( )` Retrieve all resources from config files api2.xml Retrieve all resources from config files api2.xml Returns `Varien_Simplexml_Element`
`public array`	# `getResourcesTypes( )` Retrieve all resources types Retrieve all resources types Returns `array`
`public Varien_Simplexml_Element\|boolean`	# `getResourceGroups( )` Retrieve all resource groups from config files api2.xml Retrieve all resource groups from config files api2.xml Returns `Varien_Simplexml_Element\|boolean`
`public Mage_Core_Model_Config_Element\|boolean`	# `getResourceGroup( string $name )` Retrieve resource group from config files api2.xml Retrieve resource group from config files api2.xml Parameters `$name` `string` $name Returns `Mage_Core_Model_Config_Element\|boolean`
`public Varien_Simplexml_Element\|boolean`	# `getResource( string $node )` Retrieve resource by type (node) Retrieve resource by type (node) Parameters `$node` `string` $node Returns `Varien_Simplexml_Element\|boolean`
`public array`	# `getResourceAttributes( string $node )` Retrieve resource attributes Retrieve resource attributes Parameters `$node` `string` $node Returns `array`
`public array`	# `getResourceExcludedAttributes( string $resource, string $userType, string $operation )` Get excluded attributes of API resource Get excluded attributes of API resource Parameters `$resource` `string` $resource `$userType` `string` $userType `$operation` `string` $operation Returns `array`
`public array`	# `getResourceForcedAttributes( string $resource, string $userType )` Get forced attributes of API resource Get forced attributes of API resource Parameters `$resource` `string` $resource `$userType` `string` $userType Returns `array`
`public array`	# `getResourceIncludedAttributes( string $resource, string $userType, string $operationType )` Get included attributes Get included attributes Parameters `$resource` `string` $resource API resource ID `$userType` `string` $userType API user type `$operationType` `string` $operationType Type of operation: one of Mage_Api2_Model_Resource::OPERATION_ATTRIBUTE_... constant Returns `array`
`public array`	# `getResourceEntityOnlyAttributes( string $resource, string $userType, string $operationType )` Get entity only attributes Get entity only attributes Parameters `$resource` `string` $resource API resource ID `$userType` `string` $userType API user type `$operationType` `string` $operationType Type of operation: one of Mage_Api2_Model_Resource::OPERATION_ATTRIBUTE_... constant Returns `array`
`public string`	# `getResourceWorkingModel( string $node )` Retrieve resource working model Retrieve resource working model Parameters `$node` `string` $node Returns `string`
`public array`	# `getVersions( string $node )` Get resource allowed versions sorted in reverse order Get resource allowed versions sorted in reverse order Parameters `$node` `string` $node Returns `array` Throws `Exception`
`public string`	# `getResourceModel( string $node )` Retrieve resource model Retrieve resource model Parameters `$node` `string` $node Returns `string`
`public array`	# `getResourceUserPrivileges( string $resource, string $userType )` Retrieve API user privileges for specified resource Retrieve API user privileges for specified resource Parameters `$resource` `string` $resource `$userType` `string` $userType Returns `array`
`public array`	# `getResourceSubresources( string $node )` Retrieve resource subresources Retrieve resource subresources Parameters `$node` `string` $node Returns `array`
`public array`	# `getValidationConfig( string $resourceType, string $validatorType )` Get validation config by validator type Get validation config by validator type Parameters `$resourceType` `string` $resourceType `$validatorType` `string` $validatorType Returns `array`
`public integer`	# `getResourceLastVersion( string $resourceType, integer $lowerOrEqualsTo = null )` Get latest version of resource model. If second arg is specified - use it as a limiter Get latest version of resource model. If second arg is specified - use it as a limiter Parameters `$resourceType` `string` $resourceType Resource type `$lowerOrEqualsTo` `integer` $lowerOrEqualsTo OPTIONAL If specified - return version equal or lower to Returns `integer`
`public string`	# `getRouteWithEntityTypeAction( string $node )` Get route with Mage_Api2_Model_Resource::ACTION_TYPE_ENTITY type Get route with Mage_Api2_Model_Resource::ACTION_TYPE_ENTITY type Parameters `$node` `string` $node Returns `string`

Constants summary
`string`	`NODE_RESOURCE_GROUPS`	`'resource_groups'`	# Node name of resource groups Node name of resource groups
`string`	`CACHE_ID`	`'config_api2'`	# Id for config cache Id for config cache
`string`	`CACHE_TAG`	`'CONFIG_API2'`	# Tag name for config cache Tag name for config cache

Properties summary
`protected boolean`	`$_resourcesGrouped`	`false`	# Is resources added to group Is resources added to group

Packages

Classes

Interfaces

Exceptions

Class Mage_Api2_Model_Config

Parameters

Parameters

Returns

Throws

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns