Class Mage_Api2_Model_Resource

API2 Abstract Resource

Direct known subclasses

Mage_Catalog_Model_Api2_Product, Mage_Catalog_Model_Api2_Product_Category, Mage_Sales_Model_Api2_Order_Item, Mage_Catalog_Model_Api2_Product_Image, Mage_Catalog_Model_Api2_Product_Website, Mage_CatalogInventory_Model_Api2_Stock_Item, Mage_Customer_Model_Api2_Customer, Mage_Customer_Model_Api2_Customer_Address, Mage_Sales_Model_Api2_Order, Mage_Sales_Model_Api2_Order_Address, Mage_Sales_Model_Api2_Order_Comment

Indirect known subclasses

Abstract
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/Resource.php

Methods summary
`public`	# `dispatch( )` Dispatch To implement the functionality, you must create a method in the parent one. Dispatch To implement the functionality, you must create a method in the parent one. Action type is defined in api2.xml in the routes section and depends on entity (single object) or collection (several objects). HTTP_MULTI_STATUS is used for several status codes in the response
`protected`	# `_errorIfMethodNotExist( mixed $methodName )` Trigger error for not-implemented operations Trigger error for not-implemented operations Parameters `$methodName` `mixed` $methodName
`protected boolean`	# `_checkMethodExist( mixed $methodName )` Check method exist Check method exist Parameters `$methodName` `mixed` $methodName Returns `boolean`
`public Mage_Api2_Model_Request`	# `getRequest( )` Get request Get request Returns `Mage_Api2_Model_Request` Throws `Exception`
`public Mage_Api2_Model_Resource`	# `setRequest( Mage_Api2_Model_Request $request )` Set request Set request Parameters `$request` `Mage_Api2_Model_Request` $request Returns `Mage_Api2_Model_Resource`
`public string`	# `getResourceType( )` Get resource type If not exists get from Request Get resource type If not exists get from Request Returns `string`
`public Mage_Api2_Model_Resource`	# `setResourceType( string $resourceType )` Set resource type Set resource type Parameters `$resourceType` `string` $resourceType Returns `Mage_Api2_Model_Resource`
`public string`	# `getApiType( )` Get API type If not exists get from Request. Get API type If not exists get from Request. Returns `string`
`public Mage_Api2_Model_Resource`	# `setApiType( string $apiType )` Set API type Set API type Parameters `$apiType` `string` $apiType Returns `Mage_Api2_Model_Resource`
`public integer`	# `getVersion( )` Determine version from class name Determine version from class name Returns `integer`
`public`	# `setVersion( integer $version )` Set API version Set API version Parameters `$version` `integer` $version
`public Mage_Api2_Model_Response`	# `getResponse( )` Get response Get response Returns `Mage_Api2_Model_Response`
`public`	# `setResponse( Mage_Api2_Model_Response $response )` Set response Set response Parameters `$response` `Mage_Api2_Model_Response` $response
`public Mage_Api2_Model_Acl_Filter`	# `getFilter( )` Get filter if not exists create Get filter if not exists create Returns `Mage_Api2_Model_Acl_Filter`
`public`	# `setFilter( Mage_Api2_Model_Acl_Filter $filter )` Set filter Set filter Parameters `$filter` `Mage_Api2_Model_Acl_Filter` $filter
`public Mage_Api2_Model_Renderer_Interface`	# `getRenderer( )` Get renderer if not exists create Get renderer if not exists create Returns `Mage_Api2_Model_Renderer_Interface`
`public`	# `setRenderer( Mage_Api2_Model_Renderer_Interface $renderer )` Set renderer Set renderer Parameters `$renderer` `Mage_Api2_Model_Renderer_Interface` $renderer
`public string`	# `getUserType( )` Get user type If not exists get from apiUser Get user type If not exists get from apiUser Returns `string`
`public Mage_Api2_Model_Resource`	# `setUserType( string $userType )` Set user type Set user type Parameters `$userType` `string` $userType Returns `Mage_Api2_Model_Resource`
`public Mage_Api2_Model_Auth_User_Abstract`	# `getApiUser( )` Get API user Get API user Returns `Mage_Api2_Model_Auth_User_Abstract` Throws `Exception`
`public Mage_Api2_Model_Resource`	# `setApiUser( Mage_Api2_Model_Auth_User_Abstract $apiUser )` Set API user Set API user Parameters `$apiUser` `Mage_Api2_Model_Auth_User_Abstract` $apiUser Returns `Mage_Api2_Model_Resource`
`public string`	# `getActionType( )` Get action type If not exists get from Request Get action type If not exists get from Request Returns `string` One of Mage_Api2_Model_Resource::ACTION_TYPE_... constant
`public Mage_Api2_Model_Resource`	# `setActionType( string $actionType )` Set route type Set route type Parameters `$actionType` `string` $actionType One of Mage_Api2_Model_Resource::ACTION_TYPE_... constant Returns `Mage_Api2_Model_Resource`
`public string`	# `getOperation( )` Get operation If not exists get from Request Get operation If not exists get from Request Returns `string` One of Mage_Api2_Model_Resource::OPERATION_... constant
`public Mage_Api2_Model_Resource`	# `setOperation( string $operation )` Set operation Set operation Parameters `$operation` `string` $operation One of Mage_Api2_Model_Resource::OPERATION_... constant Returns `Mage_Api2_Model_Resource`
`public Mage_Api2_Model_Config`	# `getConfig( )` Get API2 config Get API2 config Returns `Mage_Api2_Model_Config`
`public Mage_Core_Model_Abstract`	# `getWorkingModel( )` Get working model Get working model Returns `Mage_Core_Model_Abstract`
`protected`	# `_render( mixed $data )` Render data using registered Renderer Render data using registered Renderer Parameters `$data` `mixed` $data
`protected`	# `_critical( string $message, integer $code = null )` Throw exception, critical error - stop execution Throw exception, critical error - stop execution Parameters `$message` `string` $message `$code` `integer` $code Throws `Mage_Api2_Exception`
`protected array`	# `_getCriticalErrors( )` Retrieve array with critical errors mapped to HTTP codes Retrieve array with critical errors mapped to HTTP codes Returns `array`
`protected Mage_Api2_Model_Resource`	# `_error( string $message, integer $code )` Add non-critical error Add non-critical error Parameters `$message` `string` $message `$code` `integer` $code Returns `Mage_Api2_Model_Resource`
`protected Mage_Api2_Model_Resource`	# `_successMessage( string $message, integer $code, array $params = array() )` Add success message Add success message Parameters `$message` `string` $message `$code` `integer` $code `$params` `array` $params Returns `Mage_Api2_Model_Resource`
`protected Mage_Api2_Model_Resource`	# `_errorMessage( string $message, integer $code, array $params = array() )` Add error message Add error message Parameters `$message` `string` $message `$code` `integer` $code `$params` `array` $params Returns `Mage_Api2_Model_Resource`
`final protected Mage_Api2_Model_Resource`	# `_applyCollectionModifiers( Varien_Data_Collection_Db $collection )` Set navigation parameters and apply filters from URL params Set navigation parameters and apply filters from URL params Parameters `$collection` `Varien_Data_Collection_Db` $collection Returns `Mage_Api2_Model_Resource`
`protected Mage_Api2_Model_Resource`	# `_applyFilter( Varien_Data_Collection_Db $collection )` Validate filter data and apply it to collection if possible Validate filter data and apply it to collection if possible Parameters `$collection` `Varien_Data_Collection_Db` $collection Returns `Mage_Api2_Model_Resource`
`protected Mage_Api2_Model_Response`	# `_multicall( string $resourceInstanceId )` Perform multiple calls to subresources of specified resource Perform multiple calls to subresources of specified resource Parameters `$resourceInstanceId` `string` $resourceInstanceId Returns `Mage_Api2_Model_Response`
`protected Mage_Api2_Model_Resource`	# `_getSubModel( string $resourceId, array $requestParams )` Create model of specified resource and configure it with current object attributes Create model of specified resource and configure it with current object attributes Parameters `$resourceId` `string` $resourceId Resource identifier `$requestParams` `array` $requestParams Parameters to be set to request Returns `Mage_Api2_Model_Resource`
`protected boolean`	# `_isSubCallAllowed( string $resourceId )` Check ACL permission for specified resource with current other conditions Check ACL permission for specified resource with current other conditions Parameters `$resourceId` `string` $resourceId Resource identifier Returns `boolean` Throws `Exception`
`public Mage_Api2_Model_Resource`	# `setReturnData( boolean $flag )` Set 'returnData' flag Set 'returnData' flag Parameters `$flag` `boolean` $flag Returns `Mage_Api2_Model_Resource`
`protected string`	# `_getLocation( Mage_Core_Model_Abstract $resource )` Get resource location Get resource location Parameters `$resource` `Mage_Core_Model_Abstract` $resource Returns `string` URL
`protected array`	# `_getResourceAttributes( )` Resource specific method to retrieve attributes' codes. May be overriden in child. Resource specific method to retrieve attributes' codes. May be overriden in child. Returns `array`
`public array`	# `getAvailableAttributes( string $userType, string $operation )` Get available attributes of API resource Get available attributes of API resource Parameters `$userType` `string` $userType `$operation` `string` $operation Returns `array`
`public array`	# `getExcludedAttributes( string $userType, string $operation )` Get excluded attributes for user type Get excluded attributes for user type Parameters `$userType` `string` $userType `$operation` `string` $operation Returns `array`
`public array`	# `getForcedAttributes( )` Get forced attributes Get forced attributes Returns `array`
`public array`	# `getIncludedAttributes( string $userType, string $operationType )` Retrieve list of included attributes Retrieve list of included attributes Parameters `$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`	# `getEntityOnlyAttributes( string $userType, string $operationType )` Retrieve list of entity only attributes Retrieve list of entity only attributes Parameters `$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`	# `getAvailableAttributesFromConfig( )` Get available attributes of API resource from configuration file Get available attributes of API resource from configuration file Returns `array`
`public array`	# `getDbAttributes( )` Get available attributes of API resource from data base Get available attributes of API resource from data base Returns `array`
`public array`	# `getEavAttributes( boolean $onlyVisible = false, boolean $excludeSystem = false )` Get EAV attributes of working model Get EAV attributes of working model Parameters `$onlyVisible` `boolean` $onlyVisible OPTIONAL Show only the attributes which are visible on frontend `$excludeSystem` `boolean` $excludeSystem OPTIONAL Exclude attributes marked as system Returns `array`
`protected Mage_Core_Model_Store`	# `_getStore( )` Retrieve current store according to request and API user type Retrieve current store according to request and API user type Returns `Mage_Core_Model_Store`

Constants summary
`string`	`ACTION_TYPE_ENTITY`	`'entity'`	# Action types Action types
`string`	`ACTION_TYPE_COLLECTION`	`'collection'`	#
`string`	`OPERATION_CREATE`	`'create'`	# Operations. Resource method names Operations. Resource method names
`string`	`OPERATION_RETRIEVE`	`'retrieve'`	#
`string`	`OPERATION_UPDATE`	`'update'`	#
`string`	`OPERATION_DELETE`	`'delete'`	#
`string`	`OPERATION_ATTRIBUTE_READ`	`'read'`	# Common operations for attributes Common operations for attributes
`string`	`OPERATION_ATTRIBUTE_WRITE`	`'write'`	#
`string`	`RESOURCE_NOT_FOUND`	`'Resource not found.'`	# Default error messages Default error messages
`string`	`RESOURCE_METHOD_NOT_ALLOWED`	`'Resource does not support method.'`	#
`string`	`RESOURCE_METHOD_NOT_IMPLEMENTED`	`'Resource method not implemented yet.'`	#
`string`	`RESOURCE_INTERNAL_ERROR`	`'Resource internal error.'`	#
`string`	`RESOURCE_DATA_PRE_VALIDATION_ERROR`	`'Resource data pre-validation error.'`	#
`string`	`RESOURCE_DATA_INVALID`	`'Resource data invalid.'`	#
`string`	`RESOURCE_UNKNOWN_ERROR`	`'Resource unknown error.'`	#
`string`	`RESOURCE_REQUEST_DATA_INVALID`	`'The request data is invalid.'`	#
`string`	`RESOURCE_COLLECTION_PAGING_ERROR`	`'Resource collection paging error.'`	# Default collection resources error messages Default collection resources error messages
`string`	`RESOURCE_COLLECTION_PAGING_LIMIT_ERROR`	`'The paging limit exceeds the allowed number.'`	#
`string`	`RESOURCE_COLLECTION_ORDERING_ERROR`	`'Resource collection ordering error.'`	#
`string`	`RESOURCE_COLLECTION_FILTERING_ERROR`	`'Resource collection filtering error.'`	#
`string`	`RESOURCE_COLLECTION_ATTRIBUTES_ERROR`	`'Resource collection including additional attributes error.'`	#
`string`	`RESOURCE_UPDATED_SUCCESSFUL`	`'Resource updated successful.'`	# Default success messages Default success messages
`integer`	`PAGE_SIZE_DEFAULT`	`10`	# Collection page sizes Collection page sizes
`integer`	`PAGE_SIZE_MAX`	`100`	#

Properties summary
`protected Mage_Api2_Model_Request`	`$_request`		# Request Request
`protected string`	`$_resourceType`		# Resource type Resource type
`protected string`	`$_apiType`		# Api type Api type
`protected integer`	`$_version`	`null`	# API Version API Version
`protected Zend_Controller_Response_Http`	`$_response`		# Response Response
`protected Mage_Api2_Model_Acl_Filter`	`$_filter`		# Attribute Filter Attribute Filter
`protected Mage_Api2_Model_Renderer_Interface`	`$_renderer`		# Renderer Renderer
`protected Mage_Api2_Model_Auth_User_Abstract`	`$_apiUser`		# Api user Api user
`protected string`	`$_userType`		# User type User type
`protected string`	`$_actionType`		# One of Mage_Api2_Model_Resource::ACTION_TYPE_... constant One of Mage_Api2_Model_Resource::ACTION_TYPE_... constant
`protected string`	`$_operation`		# One of Mage_Api2_Model_Resource::OPERATION_... constant One of Mage_Api2_Model_Resource::OPERATION_... constant
`protected boolean`	`$_returnData`	`false`	# If TRUE - no rendering will be done and dispatch will return data. Otherwise, by default If TRUE - no rendering will be done and dispatch will return data. Otherwise, by default
`protected Mage_Api2_Model_Multicall`	`$_multicall`		#

Packages

Classes

Interfaces

Exceptions

Class Mage_Api2_Model_Resource

Direct known subclasses

Indirect known subclasses

Parameters

Parameters

Returns

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Parameters

Throws

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns