Class Mage_Api2_Model_Request

API Request model

Zend_Controller_Request_Http

Mage_Api2_Model_Request

Direct known subclasses

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/Request.php

Methods summary
`public`	# `__construct( string\|Zend_Uri $uri = null )` Constructor Constructor If a $uri is passed, the object will attempt to populate itself using that information. Override parent class to allow object instance get via Mage::getSingleton() Parameters `$uri` `string\|Zend_Uri` $uri
`protected Mage_Api2_Model_Request_Interpreter_Interface`	# `_getInterpreter( )` Get request interpreter Get request interpreter Returns `Mage_Api2_Model_Request_Interpreter_Interface`
`public array`	# `getAcceptTypes( )` Retrieve accept types understandable by requester in a form of array sorted by quality descending Retrieve accept types understandable by requester in a form of array sorted by quality descending Returns `array`
`public string`	# `getApiType( )` Get api type from Request Get api type from Request Returns `string`
`public array`	# `getBodyParams( )` Fetch data from HTTP Request body Fetch data from HTTP Request body Returns `array`
`public string`	# `getContentType( )` Get Content-Type of request Get Content-Type of request Returns `string` Throws `Mage_Api2_Exception`
`public mixed`	# `getFilter( )` Get filter settings passed by API user Get filter settings passed by API user Returns `mixed`
`public string\|null`	# `getModel( )` Get resource model class name Get resource model class name Returns `string\|null`
`public string`	# `getOperation( )` Retrieve one of CRUD operation dependent on HTTP method Retrieve one of CRUD operation dependent on HTTP method Returns `string` Throws `Mage_Api2_Exception`
`public mixed`	# `getOrderDirection( )` Get sort order direction requested by API user Get sort order direction requested by API user Returns `mixed`
`public mixed`	# `getOrderField( )` Get sort order field requested by API user Get sort order field requested by API user Returns `mixed`
`public mixed`	# `getPageNumber( )` Retrieve page number requested by API user Retrieve page number requested by API user Returns `mixed`
`public mixed`	# `getPageSize( )` Retrieve page size requested by API user Retrieve page size requested by API user Returns `mixed`
`public array`	# `getRequestedAttributes( )` Get an array of attribute codes requested by API user Get an array of attribute codes requested by API user Returns `array`
`public string`	# `getResourceType( )` Retrieve resource type Retrieve resource type Returns `string`
`public string`	# `getVersion( )` Get Version header from headers Get Version header from headers Returns `string`
`public string\|null`	# `getActionType( )` Retrieve action type Retrieve action type Returns `string\|null`
`public boolean`	# `isAssocArrayInRequestBody( )` It checks if the array in the request body is an associative one. It is required for definition of the dynamic aaction type (multi or single) It checks if the array in the request body is an associative one. It is required for definition of the dynamic aaction type (multi or single) Returns `boolean`

Constants summary
`string`	`REQUEST_CHARSET`	`'utf-8'`	# Character set which must be used in request Character set which must be used in request
`string`	`QUERY_PARAM_REQ_ATTRS`	`'attrs'`	# Name of query ($_GET) parameters to use in navigation and so on Name of query ($_GET) parameters to use in navigation and so on
`string`	`QUERY_PARAM_PAGE_NUM`	`'page'`	#
`string`	`QUERY_PARAM_PAGE_SIZE`	`'limit'`	#
`string`	`QUERY_PARAM_ORDER_FIELD`	`'order'`	#
`string`	`QUERY_PARAM_ORDER_DIR`	`'dir'`	#
`string`	`QUERY_PARAM_FILTER`	`'filter'`	#

Properties summary
`protected Mage_Api2_Model_Request_Interpreter_Interface`	`$_interpreter`		# Interpreter adapter Interpreter adapter
`protected array`	`$_bodyParams`		# Body params Body params

Packages

Classes

Interfaces

Exceptions

Class Mage_Api2_Model_Request

Direct known subclasses

Parameters

Returns

Returns

Returns

Returns

Returns

Throws

Returns

Returns

Returns

Throws

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns