Service/Ebay/Finding.php

Show:

inherited

Classes
- \Zend_Service_Ebay_Finding

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: Ebay
Version: $Id: Finding.php 22824 2010-08-09 18:59:54Z renanbr $

\Zend_Service_Ebay_Finding
jump to top

Package: Zend_Service\Ebay

Parent(s): \Zend_Service_Ebay_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Uses

Constants

 
                SERVICE_NAME
                = 'FindingService'

 
                SERVICE_VERSION
                = '1.0.0'

 
                RESPONSE_DATA_FORMAT
                = 'XML'

 
                ENDPOINT_URI
                = 'http://svcs.ebay.com'

 
                ENDPOINT_PATH
                = 'services/search/FindingService/v1'

 
                XMLNS_FINDING
                = 'e'

 
                XMLNS_MS
                = 'ms'

Properties

array $_options = array(self::OPTION_GLOBAL_ID => 'EBAY-US')

Default valuearray(self::OPTION_GLOBAL_ID => 'EBAY-US')Details

Type: array

array $_xmlNamespaces = array(self::XMLNS_FINDING => 'http://www.ebay.com/marketplace/search/v1/services', self::XMLNS_MS => 'http://www.ebay.com/marketplace/services')

static

Default value

array(self::XMLNS_FINDING => 'http://www.ebay.com/marketplace/search/v1/services', self::XMLNS_MS => 'http://www.ebay.com/marketplace/services')

Details

Type: array

Methods

__construct(\Zend_Config | array | string $options) : void

Parameters

Name	Type	Description
$options	\Zend_Config \| array \| string	Application Id or array of options

Throws

Exception	Description
\Zend_Service_Ebay_Finding_Exception	When application id is missing

_findItems(array $options, string $operation) : \Zend_Service_Ebay_Finding_Response_Items

Parameters

Name	Type	Description
$options	array
$operation	string

Returns

Type	Description
\Zend_Service_Ebay_Finding_Response_Items

_parseResponse(\Zend_Http_Response $response) : \DOMDocument

Search for error from request.

If any error is found a DOMDocument is returned, this object contains a DOMXPath object as "ebayFindingXPath" attribute.

Parameters

Name	Type	Description
$response	\Zend_Http_Response

Returns

Type	Description
\DOMDocument

Throws

Exception	Description
\Zend_Service_Ebay_Finding_Exception	When any error occurrs during request

Details

Link: http://developer.ebay.com/DevZone/finding/CallRef/types/ErrorSeverity.html
See

_request(string $operation, array $options = null) : \DOMDocument

Parameters

Name	Type	Description
$operation	string
$options	array

Returns

Type	Description
\DOMDocument

Details

Link: http://developer.ebay.com/DevZone/finding/Concepts/MakingACall.html#StandardURLParameters

findItemsAdvanced(string $keywords, boolean $descriptionSearch = true, integer $categoryId = null, \Zend_Config | array $options = null) : \Zend_Service_Ebay_Finding_Response_Items

Finds items by a keyword query and/or category and allows searching within item descriptions.

Parameters

Name	Type	Description
$keywords	string
$descriptionSearch	boolean
$categoryId	integer
$options	\Zend_Config \| array

Returns

Type	Description
\Zend_Service_Ebay_Finding_Response_Items

Details

Link: http://developer.ebay.com/DevZone/finding/CallRef/findItemsAdvanced.html

findItemsByCategory(integer $categoryId, \Zend_Config | array $options = null) : \Zend_Service_Ebay_Finding_Response_Items

Finds items in a specific category. Results can be filtered and sorted.

Parameters

Name	Type	Description
$categoryId	integer
$options	\Zend_Config \| array

Returns

Type	Description
\Zend_Service_Ebay_Finding_Response_Items

Details

Link: http://developer.ebay.com/DevZone/finding/CallRef/findItemsByCategory.html

findItemsByKeywords(string $keywords, \Zend_Config | array $options = null) : \Zend_Service_Ebay_Finding_Response_Items

Finds items on eBay based upon a keyword query and returns details for matching items.

Parameters

Name	Type	Description
$keywords	string
$options	\Zend_Config \| array

Returns

Type	Description
\Zend_Service_Ebay_Finding_Response_Items

Details

Link: http://developer.ebay.com/DevZone/finding/CallRef/findItemsByKeywords.html

findItemsByProduct(integer $productId, string $productIdType = null, \Zend_Config | array $options = null) : \Zend_Service_Ebay_Finding_Response_Items

Finds items based upon a product ID, such as an ISBN, UPC, EAN, or ePID.

Parameters

Name	Type	Description
$productId	integer
$productIdType	string	Default value is ReferenceID
$options	\Zend_Config \| array

Returns

Type	Description
\Zend_Service_Ebay_Finding_Response_Items

Details

Link: http://developer.ebay.com/DevZone/finding/CallRef/findItemsByProduct.html

findItemsInEbayStores(string $storeName, \Zend_Config | array $options = null) : \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.

Parameters

Name	Type	Description
$storeName	string
$options	\Zend_Config \| array

Returns

Type	Description
\Zend_Service_Ebay_Finding_Response_Items

Details

Link: http://developer.ebay.com/DevZone/finding/CallRef/findItemsIneBayStores.html

getClient() : \Zend_Rest_Client

Returns

Type	Description
\Zend_Rest_Client

getHistograms(integer $categoryId, \Zend_Config | array $options = null) : \Zend_Service_Ebay_Finding_Response_Histograms

Gets category and/or aspect metadata for the specified category.

Parameters

Name	Type	Description
$categoryId	integer
$options	\Zend_Config \| array

Returns

Type	Description
\Zend_Service_Ebay_Finding_Response_Histograms

Details

Link: http://developer.ebay.com/DevZone/finding/CallRef/getHistograms.html

getSearchKeywordsRecommendation(string $keywords, \Zend_Config | array $options = null) : \Zend_Service_Ebay_Finding_Response_Keywords

Checks specified keywords and returns correctly spelled keywords for best search results.

Parameters

Name	Type	Description
$keywords	string
$options	\Zend_Config \| array

Returns

Type	Description
\Zend_Service_Ebay_Finding_Response_Keywords

Details

Link: http://developer.ebay.com/DevZone/finding/CallRef/getSearchKeywordsRecommendation.html

getXmlNamespaces() : array

static

Returns

Type	Description
array

setClient(\Zend_Rest_Client $client) : \Zend_Service_Ebay_Finding

Parameters

Name	Type	Description
$client	\Zend_Rest_Client

Returns

Type	Description
\Zend_Service_Ebay_Finding	Provides a fluent interface

Service/Ebay/Finding.php

\Zend_Service_Ebay_Findingjump to top

Constants

Properties

Methods

\Zend_Service_Ebay_Finding
jump to top