| category |
Zend |
| package |
Zend_Service |
| subpackage |
Ebay |
| copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license |
New BSD License |
| uses |
|
| inherited_from |
\Zend_Service_Ebay_Abstract |
Methods
__construct()
__construct(\Zend_Config|array|string $options) : void
| inherited_from |
\Zend_Service_Ebay_Abstract::__construct() |
Parameters
$options
\Zend_ConfigarraystringApplication Id or array of options
Exceptions
\Zend_Service_Ebay_Finding_Exception |
When application id is missing |
__construct()
__construct(\Zend_Config|array $options = null) : void
Inherited
Parameters
$options
\Zend_Configarray
Finds items by a keyword query and/or category and allows searching
within item descriptions.
findItemsAdvanced(string $keywords, boolean $descriptionSearch = true, integer $categoryId = null, \Zend_Config|array $options = null) : \Zend_Service_Ebay_Finding_Response_Items
Parameters
$keywords
string
$descriptionSearch
boolean
$categoryId
integer
$options
\Zend_Configarray
Returns
\Zend_Service_Ebay_Finding_Response_Items
Finds items in a specific category. Results can be filtered and sorted.
findItemsByCategory(integer $categoryId, \Zend_Config|array $options = null) : \Zend_Service_Ebay_Finding_Response_Items
Parameters
$categoryId
integer
$options
\Zend_Configarray
Returns
\Zend_Service_Ebay_Finding_Response_Items
Finds items on eBay based upon a keyword query and returns details for
matching items.
findItemsByKeywords(string $keywords, \Zend_Config|array $options = null) : \Zend_Service_Ebay_Finding_Response_Items
Parameters
$keywords
string
$options
\Zend_Configarray
Returns
\Zend_Service_Ebay_Finding_Response_Items
Finds items based upon a product ID, such as an ISBN, UPC, EAN, or ePID.
findItemsByProduct(integer $productId, string $productIdType = null, \Zend_Config|array $options = null) : \Zend_Service_Ebay_Finding_Response_Items
Parameters
$productId
integer
$productIdType
stringDefault value is ReferenceID
$options
\Zend_Configarray
Returns
\Zend_Service_Ebay_Finding_Response_Items
Finds items in eBay stores. Can search a specific store or can search all
stores with a keyword query.
findItemsInEbayStores(string $storeName, \Zend_Config|array $options = null) : \Zend_Service_Ebay_Finding_Response_Items
Parameters
$storeName
string
$options
\Zend_Configarray
Returns
\Zend_Service_Ebay_Finding_Response_Items
getClient()
getClient() : \Zend_Rest_Client
| inherited_from |
\Zend_Service_Ebay_Abstract::getClient() |
Returns
\Zend_Rest_Client
getClient()
getClient() : mixed
Inherited
Gets category and/or aspect metadata for the specified category.
getHistograms(integer $categoryId, \Zend_Config|array $options = null) : \Zend_Service_Ebay_Finding_Response_Histograms
Parameters
$categoryId
integer
$options
\Zend_Configarray
Returns
\Zend_Service_Ebay_Finding_Response_Histograms
getOption()
getOption(string $name = null) : mixed
Inherited
Parameters
$name
string
Returns
mixed
Checks specified keywords and returns correctly spelled keywords for best
search results.
getSearchKeywordsRecommendation(string $keywords, \Zend_Config|array $options = null) : \Zend_Service_Ebay_Finding_Response_Keywords
Parameters
$keywords
string
$options
\Zend_Configarray
Returns
\Zend_Service_Ebay_Finding_Response_Keywords
getXmlNamespaces()
getXmlNamespaces() : array
Static
hasOption()
hasOption(string $name) : boolean
Inherited
Parameters
$name
string
Returns
boolean
optionsToArray()
optionsToArray(\Zend_Config|array $options) : array
InheritedStatic
Parameters
$options
\Zend_Configarray
Exceptions
\Zend_Service_Ebay_Finding_Exception |
When $options is not an array neither a Zend_Config object |
Returns
array
setClient()
setClient(\Zend_Rest_Client $client) : \Zend_Service_Ebay_Finding
| inherited_from |
\Zend_Service_Ebay_Abstract::setClient() |
Parameters
$client
\Zend_Rest_Client
Returns
\Zend_Service_Ebay_FindingProvides a fluent interface
setClient()
setClient(mixed $client) : \Zend_Service_Ebay_Abstract
Inherited
Parameters
$client
mixed
Returns
\Zend_Service_Ebay_AbstractProvides a fluent interface
setOption()
setOption(string|\Zend_Config|array $name, mixed $value = null) : \Zend_Service_Ebay_Abstract
Inherited
Parameters
$name
string\Zend_Configarray
$value
mixed
Returns
\Zend_Service_Ebay_AbstractProvides a fluent interface
Translate native PHP values format to ebay format for request.
toEbayValue(mixed $value) : string
InheritedStatic
Boolean is translated to "0" or "1", date object generates ISO 8601,
everything else is translated to string.
Parameters
$value
mixed
Returns
string
Translate an ebay value format to native PHP type.
toPhpValue(string $value, string $type) : mixed
InheritedStatic
Parameters
$value
string
$type
string
Exceptions
\Zend_Service_Ebay_Finding_Exception |
When $type is not valid |
Returns
mixed
_findItems()
_findItems(array $options, string $operation) : \Zend_Service_Ebay_Finding_Response_Items
Parameters
$options
array
$operation
string
Returns
\Zend_Service_Ebay_Finding_Response_Items
Implements Name-value Syntax translator.
_optionsToNameValueSyntax(\Zend_Config|array $options) : array
Inherited
Example:
array(
'paginationInput' => array(
'entriesPerPage' => 5,
'pageNumber' => 2
),
'itemFilter' => array(
array(
'name' => 'MaxPrice',
'value' => 25,
'paramName' => 'Currency',
'paramValue' => 'USD'
),
array(
'name' => 'FreeShippingOnly',
'value' => true
),
array(
'name' => 'ListingType',
'value' => array(
'AuctionWithBIN',
'FixedPrice',
'StoreInventory'
)
)
),
'productId' => array(
'' => 123,
'type' => 'UPC'
)
)
this above is translated to
array(
'paginationInput.entriesPerPage' => '5',
'paginationInput.pageNumber' => '2',
'itemFilter(0).name' => 'MaxPrice',
'itemFilter(0).value' => '25',
'itemFilter(0).paramName' => 'Currency',
'itemFilter(0).paramValue' => 'USD',
'itemFilter(1).name' => 'FreeShippingOnly',
'itemFilter(1).value' => '1',
'itemFilter(2).name' => 'ListingType',
'itemFilter(2).value(0)' => 'AuctionWithBIN',
'itemFilter(2).value(1)' => 'FixedPrice',
'itemFilter(2).value(2)' => 'StoreInventory',
'productId' => '123',
'productId.@type' => 'UPC'
)
Parameters
$options
\Zend_Configarray
Returns
arrayA simple array of strings
Search for error from request.
_parseResponse(\Zend_Http_Response $response) : \DOMDocument
If any error is found a DOMDocument is returned, this object contains a
DOMXPath object as "ebayFindingXPath" attribute.
Parameters
$response
\Zend_Http_Response
Exceptions
\Zend_Service_Ebay_Finding_Exception |
When any error occurrs during request |
Returns
\DOMDocument
_request()
_request(string $operation, array $options = null) : \DOMDocument
Parameters
$operation
string
$options
array
Returns
\DOMDocument
Properties
$_client
$_client : mixed
$_options
$_options : array
Default
array(self::OPTION_GLOBAL_ID => 'EBAY-US')
| inherited_from |
\Zend_Service_Ebay_Abstract::_options |
$_options
$_options : array
$_xmlNamespaces
$_xmlNamespaces : array
Default
array(self::XMLNS_FINDING => 'http://www.ebay.com/marketplace/search/v1/services', self::XMLNS_MS => 'http://www.ebay.com/marketplace/services')
Static
Constants
ENDPOINT_PATH
ENDPOINT_PATH = 'services/search/FindingService/v1'
ENDPOINT_URI
ENDPOINT_URI = 'http://svcs.ebay.com'
OPTION_APP_ID
OPTION_APP_ID = 'app_id'
OPTION_GLOBAL_ID
OPTION_GLOBAL_ID = 'global_id'
SERVICE_NAME
SERVICE_NAME = 'FindingService'
SERVICE_VERSION
SERVICE_VERSION = '1.0.0'
XMLNS_FINDING
XMLNS_FINDING = 'e'