Zend Framework  1.12
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Zend_Service_Ebay_Finding Class Reference

Public Member Functions

 __construct ($options)
 
 setClient ($client)
 
 getClient ()
 
 findItemsAdvanced ($keywords, $descriptionSearch=true, $categoryId=null, $options=null)
 Finds items by a keyword query and/or category and allows searching within item descriptions.
 
 findItemsByCategory ($categoryId, $options=null)
 Finds items in a specific category.
 
 findItemsByKeywords ($keywords, $options=null)
 Finds items on eBay based upon a keyword query and returns details for matching items.
 
 findItemsByProduct ($productId, $productIdType=null, $options=null)
 Finds items based upon a product ID, such as an ISBN, UPC, EAN, or ePID.
 
 findItemsInEbayStores ($storeName, $options=null)
 Finds items in eBay stores.
 
 getHistograms ($categoryId, $options=null)
 Gets category and/or aspect metadata for the specified category.
 
 getSearchKeywordsRecommendation ($keywords, $options=null)
 Checks specified keywords and returns correctly spelled keywords for best search results.
 
- Public Member Functions inherited from Zend_Service_Ebay_Abstract
 __construct ($options=null)
 
 setOption ($name, $value=null)
 
 getOption ($name=null)
 
 hasOption ($name)
 
 setClient ($client)
 
 getClient ()
 

Static Public Member Functions

static getXmlNamespaces ()
 
- Static Public Member Functions inherited from Zend_Service_Ebay_Abstract
static optionsToArray ($options)
 
static toEbayValue ($value)
 Translate native PHP values format to ebay format for request.
 
static toPhpValue ($value, $type)
 Translate an ebay value format to native PHP type.
 

Public Attributes

const SERVICE_NAME = 'FindingService'
 
const SERVICE_VERSION = '1.0.0'
 
const RESPONSE_DATA_FORMAT = 'XML'
 
const ENDPOINT_URI = 'http://svcs.ebay.com'
 
const ENDPOINT_PATH = 'services/search/FindingService/v1'
 
const XMLNS_FINDING = 'e'
 
const XMLNS_MS = 'ms'
 
- Public Attributes inherited from Zend_Service_Ebay_Abstract
const OPTION_APP_ID = 'app_id'
 
const OPTION_GLOBAL_ID = 'global_id'
 

Protected Member Functions

 _findItems (array $options, $operation)
 
 _request ($operation, array $options=null)
 
 _parseResponse (Zend_Http_Response $response)
 Search for error from request.
 
- Protected Member Functions inherited from Zend_Service_Ebay_Abstract
 _optionsToNameValueSyntax ($options)
 Implements Name-value Syntax translator.
 

Protected Attributes

 $_options
 
- Protected Attributes inherited from Zend_Service_Ebay_Abstract
 $_options = array()
 
 $_client
 

Static Protected Attributes

static $_xmlNamespaces
 

Constructor & Destructor Documentation

__construct (   $options)
Parameters
Zend_Config | array | string$optionsApplication Id or array of options
Exceptions
Zend_Service_Ebay_Finding_ExceptionWhen application id is missing
Returns
void
See Also
Zend_Service_Ebay_Finding_Exception

Member Function Documentation

_findItems ( array  $options,
  $operation 
)
protected
Parameters
array$options
string$operation
Returns
Zend_Service_Ebay_Finding_Response_Items
See Also
Zend_Service_Ebay_Finding_Response_Items
_parseResponse ( Zend_Http_Response  $response)
protected

Search for error from request.

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

Parameters
Zend_Http_Response$responseZend_Service_Ebay_Finding_Abstract::_initXPath() Zend_Service_Ebay_Finding_Exception When any error occurrs during request DOMDocument
See Also
Zend_Service_Ebay_Finding_Exception
_request (   $operation,
array  $options = null 
)
protected
Parameters
string$operation
array$optionsDOMDocument
findItemsAdvanced (   $keywords,
  $descriptionSearch = true,
  $categoryId = null,
  $options = null 
)

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

Parameters
string$keywords
boolean$descriptionSearch
integer$categoryId
Zend_Config | array$optionsZend_Service_Ebay_Finding_Response_Items
findItemsByCategory (   $categoryId,
  $options = null 
)

Finds items in a specific category.

Results can be filtered and sorted.

Parameters
integer$categoryId
Zend_Config | array$optionsZend_Service_Ebay_Finding_Response_Items
findItemsByKeywords (   $keywords,
  $options = null 
)

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

Parameters
string$keywords
Zend_Config | array$optionsZend_Service_Ebay_Finding_Response_Items
findItemsByProduct (   $productId,
  $productIdType = null,
  $options = null 
)

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

Parameters
integer$productId
string$productIdTypeDefault value is ReferenceID
Zend_Config | array$optionsZend_Service_Ebay_Finding_Response_Items
findItemsInEbayStores (   $storeName,
  $options = null 
)

Finds items in eBay stores.

Can search a specific store or can search all stores with a keyword query.

Parameters
string$storeName
Zend_Config | array$optionsZend_Service_Ebay_Finding_Response_Items
getClient ( )
getHistograms (   $categoryId,
  $options = null 
)

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

Parameters
integer$categoryId
Zend_Config | array$optionsZend_Service_Ebay_Finding_Response_Histograms
See Also
Zend_Service_Ebay_Finding_Response_Histograms
getSearchKeywordsRecommendation (   $keywords,
  $options = null 
)

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

Parameters
string$keywords
Zend_Config | array$optionsZend_Service_Ebay_Finding_Response_Keywords
See Also
Zend_Service_Ebay_Finding_Response_Keywords
static getXmlNamespaces ( )
static
Returns
array
setClient (   $client)
Parameters
Zend_Rest_Client$client
Returns
Zend_Service_Ebay_Finding Provides a fluent interface
See Also
Zend_Service_Ebay_Finding_Exception

Member Data Documentation

$_options
protected
Initial value:
= array(
self::OPTION_GLOBAL_ID => 'EBAY-US'
)
$_xmlNamespaces
staticprotected
Initial value:
= array(
self::XMLNS_FINDING => 'http://www.ebay.com/marketplace/search/v1/services',
self::XMLNS_MS => 'http://www.ebay.com/marketplace/services'
)
const ENDPOINT_PATH = 'services/search/FindingService/v1'
const ENDPOINT_URI = 'http://svcs.ebay.com'
const RESPONSE_DATA_FORMAT = 'XML'
const SERVICE_NAME = 'FindingService'
const SERVICE_VERSION = '1.0.0'
const XMLNS_FINDING = 'e'
const XMLNS_MS = 'ms'