Class Mage_Catalog_Model_Api2_Product_Rest

Abstract API2 class for product instance

Mage_Catalog_Model_Api2_Product_Rest

Direct known subclasses

Mage_Catalog_Model_Api2_Product_Category_Rest, Mage_Catalog_Model_Api2_Product_Image_Rest, Mage_Catalog_Model_Api2_Product_Rest_Admin_V1, Mage_Catalog_Model_Api2_Product_Rest_Customer_V1, Mage_Catalog_Model_Api2_Product_Rest_Guest_V1

Indirect known subclasses

Mage_Catalog_Model_Api2_Product_Category_Rest_Admin_V1, Mage_Catalog_Model_Api2_Product_Category_Rest_Customer_V1, Mage_Catalog_Model_Api2_Product_Category_Rest_Guest_V1, Mage_Catalog_Model_Api2_Product_Image_Rest_Admin_V1, Mage_Catalog_Model_Api2_Product_Image_Rest_Customer_V1, Mage_Catalog_Model_Api2_Product_Image_Rest_Guest_V1

Abstract
Package: Mage\Catalog
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/Catalog/Model/Api2/Product/Rest.php

Methods summary
`protected array`	# `_retrieve( )` Retrieve product data Retrieve product data Returns `array`
`protected array`	# `_retrieveCollection( )` Retrieve list of products Retrieve list of products Returns `array`
`protected`	# `_applyCategoryFilter( Mage_Catalog_Model_Resource_Product_Collection $collection )` Apply filter by category id Apply filter by category id Parameters `$collection` `Mage_Catalog_Model_Resource_Product_Collection` $collection
`protected`	# `_prepareProductForResponse( Mage_Catalog_Model_Product $product )` Add special fields to product get response Add special fields to product get response Parameters `$product` `Mage_Catalog_Model_Product` $product
`protected`	# `_create( array $data )` Product create only available for admin Product create only available for admin Parameters `$data` `array` $data
`protected`	# `_update( array $data )` Product update only available for admin Product update only available for admin Parameters `$data` `array` $data
`protected`	# `_delete( )` Product delete only available for admin Product delete only available for admin
`protected Mage_Catalog_Model_Product`	# `_getProduct( )` Load product by its SKU or ID provided in request Load product by its SKU or ID provided in request Returns `Mage_Catalog_Model_Product`
`protected`	# `_setProduct( Mage_Catalog_Model_Product $product )` Set product Set product Parameters `$product` `Mage_Catalog_Model_Product` $product
`protected Mage_Catalog_Model_Category`	# `_getCategoryById( integer $categoryId )` Load category by id Load category by id Parameters `$categoryId` `integer` $categoryId Returns `Mage_Catalog_Model_Category`
`protected float`	# `_getPrice( float $price, boolean $includingTax = null, null\|Mage_Customer_Model_Address $shippingAddress = null, null\|Mage_Customer_Model_Address $billingAddress = null, null\|integer $ctc = null, boolean $priceIncludesTax = null )` Get product price with all tax settings processing Get product price with all tax settings processing Parameters `$price` `float` $price inputed product price `$includingTax` `boolean` $includingTax return price include tax flag `$shippingAddress` `null\|Mage_Customer_Model_Address` $shippingAddress `$billingAddress` `null\|Mage_Customer_Model_Address` $billingAddress `$ctc` `null\|integer` $ctc customer tax class `$priceIncludesTax` `boolean` $priceIncludesTax flag that price parameter contain tax Returns `float` See `Mage_Tax_Helper_Data::getPrice()`
`protected float`	# `_calculatePrice( float $price, float $percent, boolean $includeTax )` Calculate price imcluding/excluding tax base on tax rate percent Calculate price imcluding/excluding tax base on tax rate percent Parameters `$price` `float` $price `$percent` `float` $percent `$includeTax` `boolean` $includeTax true - for calculate price including tax and false if price excluding tax Returns `float`
`protected array`	# `_getTierPrices( )` Retrive tier prices in special format Retrive tier prices in special format Returns `array`
`protected null`	# `_getCustomerGroupId( )` Default implementation. May be different for customer/guest/admin role. Default implementation. May be different for customer/guest/admin role. Returns `null`
`protected float`	# `_applyTaxToPrice( float $price, boolean $withTax = true )` Default implementation. May be different for customer/guest/admin role. Default implementation. May be different for customer/guest/admin role. Parameters `$price` `float` $price `$withTax` `boolean` $withTax Returns `float`

Methods inherited from Mage_Catalog_Model_Api2_Product
`_isAttributeVisible(), getAvailableAttributes()`

Methods inherited from Mage_Api2_Model_Resource
_applyCollectionModifiers(), _applyFilter(), _checkMethodExist(), _critical(), _error(), _errorIfMethodNotExist(), _errorMessage(), _getCriticalErrors(), _getLocation(), _getResourceAttributes(), _getStore(), _getSubModel(), _isSubCallAllowed(), _multicall(), _render(), _successMessage(), dispatch(), getActionType(), getApiType(), getApiUser(), getAvailableAttributesFromConfig(), getConfig(), getDbAttributes(), getEavAttributes(), getEntityOnlyAttributes(), getExcludedAttributes(), getFilter(), getForcedAttributes(), getIncludedAttributes(), getOperation(), getRenderer(), getRequest(), getResourceType(), getResponse(), getUserType(), getVersion(), getWorkingModel(), setActionType(), setApiType(), setApiUser(), setFilter(), setOperation(), setRenderer(), setRequest(), setResourceType(), setResponse(), setReturnData(), setUserType(), setVersion()

Constants inherited from Mage_Api2_Model_Resource
ACTION_TYPE_COLLECTION, ACTION_TYPE_ENTITY, OPERATION_ATTRIBUTE_READ, OPERATION_ATTRIBUTE_WRITE, OPERATION_CREATE, OPERATION_DELETE, OPERATION_RETRIEVE, OPERATION_UPDATE, PAGE_SIZE_DEFAULT, PAGE_SIZE_MAX, RESOURCE_COLLECTION_ATTRIBUTES_ERROR, RESOURCE_COLLECTION_FILTERING_ERROR, RESOURCE_COLLECTION_ORDERING_ERROR, RESOURCE_COLLECTION_PAGING_ERROR, RESOURCE_COLLECTION_PAGING_LIMIT_ERROR, RESOURCE_DATA_INVALID, RESOURCE_DATA_PRE_VALIDATION_ERROR, RESOURCE_INTERNAL_ERROR, RESOURCE_METHOD_NOT_ALLOWED, RESOURCE_METHOD_NOT_IMPLEMENTED, RESOURCE_NOT_FOUND, RESOURCE_REQUEST_DATA_INVALID, RESOURCE_UNKNOWN_ERROR, RESOURCE_UPDATED_SUCCESSFUL

Properties summary
`protected Mage_Catalog_Model_Product`	`$_product`		# Current loaded product Current loaded product

Properties inherited from Mage_Api2_Model_Resource
`$_actionType, $_apiType, $_apiUser, $_filter, $_multicall, $_operation, $_renderer, $_request, $_resourceType, $_response, $_returnData, $_userType, $_version`

Packages

Classes

Interfaces

Class Mage_Catalog_Model_Api2_Product_Rest

Direct known subclasses

Indirect known subclasses

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Returns

Returns

Parameters

Returns