Service/Ebay/Finding/Response/Items.php

Show: PublicProtectedPrivateinherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
Ebay  
Version
$Id: Items.php 22804 2010-08-08 05:08:05Z renanbr $  

\Zend_Service_Ebay_Finding_Response_Items

Package: Zend\Service\Ebay
Parent(s)
\Zend_Service_Ebay_Finding_Response_Histograms < \Zend_Service_Ebay_Finding_Response_Abstract < \Zend_Service_Ebay_Finding_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_Service_Ebay_Finding_Response_Histograms  

Constants

>VConstant  PAGE_MAX_INFINITY = 0

Properties

>VPropertyprotected\Zend_Service_Ebay_Finding_Response_Items[] $_pageCache = array()
static
Default valuearray()Details
Type
\Zend_Service_Ebay_Finding_Response_Items[]
>VPropertypublicstring $ack
inherited
Indicates whether or not errors or warnings were generated during the processing of the request.
Inherited from: \Zend_Service_Ebay_Finding_Response_Abstract::$$ack\Zend_Service_Ebay_Finding_Response_Histograms::$$ack

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.
Details
Type
string
Inherited_from
\Zend_Service_Ebay_Finding_Response_Abstract::$$ack  
Inherited_from
\Zend_Service_Ebay_Finding_Response_Histograms::$$ack  
>VPropertypublic\Zend_Service_Ebay_Finding_Aspect_Histogram_Container $aspectHistogramContainer
inherited
Response container for aspect histograms.
Inherited from: \Zend_Service_Ebay_Finding_Response_Histograms::$$aspectHistogramContainer

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.

Details
Type
\Zend_Service_Ebay_Finding_Aspect_Histogram_Container
Inherited_from
\Zend_Service_Ebay_Finding_Response_Histograms::$$aspectHistogramContainer  
>VPropertypublic\Zend_Service_Ebay_Finding_Category_Histogram_Container $categoryHistogramContainer
inherited
Response container for category histograms.
Inherited from: \Zend_Service_Ebay_Finding_Response_Histograms::$$categoryHistogramContainer

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

Details
Type
\Zend_Service_Ebay_Finding_Category_Histogram_Container
Inherited_from
\Zend_Service_Ebay_Finding_Response_Histograms::$$categoryHistogramContainer  
>VPropertypublic\Zend_Service_Ebay_Finding_Error_Message $errorMessage
inherited
Information regarding an error or warning that occurred when eBay processed the request.
Inherited from: \Zend_Service_Ebay_Finding_Response_Abstract::$$errorMessage\Zend_Service_Ebay_Finding_Response_Histograms::$$errorMessage

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

Details
Type
\Zend_Service_Ebay_Finding_Error_Message
Inherited_from
\Zend_Service_Ebay_Finding_Response_Abstract::$$errorMessage  
Inherited_from
\Zend_Service_Ebay_Finding_Response_Histograms::$$errorMessage  
>VPropertypublic\Zend_Service_Ebay_Finding_PaginationOutput $paginationOutput
Indicates the pagination of the result set.

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.

Details
Type
\Zend_Service_Ebay_Finding_PaginationOutput
>VPropertypublic\Zend_Service_Ebay_Finding_Search_Result $searchResult
Container for the item listings that matched the search criteria.

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

Details
Type
\Zend_Service_Ebay_Finding_Search_Result
>VPropertypublicstring $timestamp
inherited
This value represents the date and time when eBay processed the request.
Inherited from: \Zend_Service_Ebay_Finding_Response_Abstract::$$timestamp\Zend_Service_Ebay_Finding_Response_Histograms::$$timestamp

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.

Details
Type
string
Inherited_from
\Zend_Service_Ebay_Finding_Response_Abstract::$$timestamp  
Inherited_from
\Zend_Service_Ebay_Finding_Response_Histograms::$$timestamp  
>VPropertypublicstring $version
inherited
The release version that eBay used to process the request.
Inherited from: \Zend_Service_Ebay_Finding_Response_Abstract::$$version\Zend_Service_Ebay_Finding_Response_Histograms::$$version

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

Details
Type
string
Inherited_from
\Zend_Service_Ebay_Finding_Response_Abstract::$$version  
Inherited_from
\Zend_Service_Ebay_Finding_Response_Histograms::$$version  

Methods

methodprotected_init() : void

Initialize object.

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

methodprotected_query(string $path, string $type, string $array = false) : mixed
Parameters
NameTypeDescription
$pathstring
$typestring
$arraystring

When true means it expects more than one node occurence

Returns
TypeDescription
mixed
methodpublicattributes(string $tag, string $attribute = null) : mixed
Parameters
NameTypeDescription
$tagstring
$attributestring
Returns
TypeDescription
mixed
methodpublicgetOption(string $name = null) : mixed
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
mixed
methodpublicpage(\Zend_Service_Ebay_Finding $proxy, integer $number) : \Zend_Service_Ebay_Finding_Response_Items

Parameters
NameTypeDescription
$proxy\Zend_Service_Ebay_Finding
$numberinteger
Returns
TypeDescription
\Zend_Service_Ebay_Finding_Response_Items
Throws
ExceptionDescription
\Zend_Service_Ebay_Finding_ExceptionWhen $number is invalid
methodpublicpageLast(\Zend_Service_Ebay_Finding $proxy, integer $max = self::PAGE_MAX_DEFAULT) : \Zend_Service_Ebay_Finding_Response_Items

Parameters
NameTypeDescription
$proxy\Zend_Service_Ebay_Finding
$maxinteger
Returns
TypeDescription
\Zend_Service_Ebay_Finding_Response_Items
methodpublicpageNext(\Zend_Service_Ebay_Finding $proxy, integer $max = self::PAGE_MAX_DEFAULT) : \Zend_Service_Ebay_Finding_Response_Items

Parameters
NameTypeDescription
$proxy\Zend_Service_Ebay_Finding
$maxinteger
Returns
TypeDescription
\Zend_Service_Ebay_Finding_Response_Items
methodpublicsetOperation(string $operation) : \Zend_Service_Ebay_Finding_Response_Abstract
Parameters
NameTypeDescription
$operationstring
Returns
TypeDescription
\Zend_Service_Ebay_Finding_Response_AbstractProvides a fluent interface
methodpublicsetOption(string | \Zend_Config | array $name, mixed $value = null) : \Zend_Service_Ebay_Finding_Response_Abstract
Parameters
NameTypeDescription
$namestring | \Zend_Config | array
$valuemixed
Returns
TypeDescription
\Zend_Service_Ebay_Finding_Response_AbstractProvides a fluent interface
Documentation was generated by phpDocumentor 2.0.0a12.