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_Finding_Response_Histograms

 Methods

__construct()

__construct(\DOMElement $dom) : void
Inherited

Parameters

$dom

\DOMElement

attributes()

attributes(string $tag, string $attribute = null) : mixed
Inherited

Parameters

$tag

string

$attribute

string

Returns

mixed

getDom()

getDom() : \DOMElement
Inherited

Returns

\DOMElement

getOperation()

getOperation() : string
Inherited

Returns

string

getOption()

getOption(string $name = null) : mixed
Inherited

Parameters

$name

string

Returns

mixed

getXPath()

getXPath() : \DOMXPath
Inherited

Returns

\DOMXPath

page()

page(\Zend_Service_Ebay_Finding $proxy, integer $number) : \Zend_Service_Ebay_Finding_Response_Items

Parameters

$proxy

\Zend_Service_Ebay_Finding

$number

integer

Exceptions

\Zend_Service_Ebay_Finding_Exception When $number is invalid

Returns

\Zend_Service_Ebay_Finding_Response_Items

pageFirst()

pageFirst(\Zend_Service_Ebay_Finding $proxy) : \Zend_Service_Ebay_Finding_Response_Items

Parameters

$proxy

\Zend_Service_Ebay_Finding

Returns

\Zend_Service_Ebay_Finding_Response_Items

pageLast()

pageLast(\Zend_Service_Ebay_Finding $proxy, integer $max = self::PAGE_MAX_DEFAULT) : \Zend_Service_Ebay_Finding_Response_Items

Parameters

$proxy

\Zend_Service_Ebay_Finding

$max

integer

Returns

\Zend_Service_Ebay_Finding_Response_Items

pageNext()

pageNext(\Zend_Service_Ebay_Finding $proxy, integer $max = self::PAGE_MAX_DEFAULT) : \Zend_Service_Ebay_Finding_Response_Items

Parameters

$proxy

\Zend_Service_Ebay_Finding

$max

integer

Returns

\Zend_Service_Ebay_Finding_Response_Items

pagePrevious()

pagePrevious(\Zend_Service_Ebay_Finding $proxy) : \Zend_Service_Ebay_Finding_Response_Items

Parameters

$proxy

\Zend_Service_Ebay_Finding

Returns

\Zend_Service_Ebay_Finding_Response_Items

setOperation()

setOperation(string $operation) : \Zend_Service_Ebay_Finding_Response_Abstract
Inherited

Parameters

$operation

string

Returns

\Zend_Service_Ebay_Finding_Response_AbstractProvides a fluent interface

setOption()

setOption(string|\Zend_Config|array $name, mixed $value = null) : \Zend_Service_Ebay_Finding_Response_Abstract
Inherited

Parameters

$name

string\Zend_Configarray

$value

mixed

Returns

\Zend_Service_Ebay_Finding_Response_AbstractProvides a fluent interface

Initialize object.

_init() : void

Post construct logic, classes must read their members here. Called from __construct() as final step of object initialization.

inherited_from \Zend_Service_Ebay_Finding_Response_Histograms::_init()

Initialize object.

_init() : void
Inherited

Post construct logic, classes must read their members here. Called from __construct() as final step of object initialization.

Load DOMXPath for current DOM object.

_initXPath() : void
Inherited
see

_query()

_query(string $path, string $type, string $array = false) : mixed
Inherited

Parameters

$path

string

$type

string

$array

string

When true means it expects more than one node occurence

Returns

mixed

 Properties

 

Indicates whether or not errors or warnings were generated during the processing of the request.

$ack : string

Default

Applicable values:

Failure
eBay encountered a fatal error during the processing of the request,
causing the request to fail. When a serious application-level error
occurs, the error is returned instead of the business data.

PartialFailure
eBay successfully processed the request, but one or more non-fatal
errors occurred during the processing. For best results, requests
should return without warning messages. Inspect the message details
and resolve any problems before resubmitting the request.

Success
eBay successfully processed the request and the business data is
returned in the response. Note that it is possible for a response to
return Success, but still not contain the expected data in the result.

Warning
The request was successfully processed, but eBay encountered a
non-fatal error during the processing. For best results, requests
should return without warnings. Inspect the warning details and
resolve the problem before resubmitting the request.
 

Response container for aspect histograms.

$aspectHistogramContainer : \Zend_Service_Ebay_Finding_Aspect_Histogram_Container

Default

Aspect histograms are returned for categories that have been mapped to domains only. In most cases, just leaf categories are mapped to domains, but there are exceptions.

 

Response container for category histograms.

$categoryHistogramContainer : \Zend_Service_Ebay_Finding_Category_Histogram_Container

Default

This container is returned only when the specified category has children categories.

 

Information regarding an error or warning that occurred when eBay processed the request.

$errorMessage : \Zend_Service_Ebay_Finding_Error_Message

Default

Not returned when the ack value is Success. Run-time errors are not reported here.

 

Indicates the pagination of the result set.

$paginationOutput : \Zend_Service_Ebay_Finding_PaginationOutput

Default

Child elements indicate the page number that is returned, the maximum number of item listings to return per page, total number of pages that can be returned, and the total number of listings that match the search criteria.

 

Container for the item listings that matched the search criteria.

$searchResult : \Zend_Service_Ebay_Finding_Search_Result

Default

The data for each item is returned in individual containers, if any matches were found.

 

This value represents the date and time when eBay processed the request.

$timestamp : string

Default

This value is returned in GMT, the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone.

 

The release version that eBay used to process the request.

$version : string

Default

Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

 

$_attributes

$_attributes : array

Default

array()
 

$_dom

$_dom : \DOMElement

Default

 

$_operation

$_operation : string

Default

 

$_options

$_options : array

Default

array()
 

$_pageCache

$_pageCache : array<mixed,\Zend_Service_Ebay_Finding_Response_Items>

Default

array()
Static
 

$_xPath

$_xPath : \DOMXPath

Default

 Constants

 

PAGE_MAX_DEFAULT

PAGE_MAX_DEFAULT = 100 
 

PAGE_MAX_INFINITY

PAGE_MAX_INFINITY = 0