Service/Ebay/Finding/Response/Histograms.php

Show: inherited
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 [email protected] 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: Histograms.php 22804 2010-08-08 05:08:05Z renanbr $  

\Zend_Service_Ebay_Finding_Response_Histograms

Package: Zend\Service\Ebay

Parent(s)
\Zend_Service_Ebay_Finding_Response_Abstract < \Zend_Service_Ebay_Finding_Abstract
Children
\Zend_Service_Ebay_Finding_Response_Items
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_Abstract  

Properties

Propertyprotectedstring $_operation =
Details
Type
string
Inherited_from
\Zend_Service_Ebay_Finding_Response_Abstract::$$_operation  
Propertyprotectedarray $_options = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Service_Ebay_Finding_Response_Abstract::$$_options  
Propertypublicstring $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

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  
Propertypublic\Zend_Service_Ebay_Finding_Aspect_Histogram_Container $aspectHistogramContainer =

Response container for aspect histograms.

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
Propertypublic\Zend_Service_Ebay_Finding_Category_Histogram_Container $categoryHistogramContainer =

Response container for category histograms.

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

Details
Type
\Zend_Service_Ebay_Finding_Category_Histogram_Container
Propertypublic\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

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  
Propertypublicstring $timestamp =
inherited

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

Inherited from: \Zend_Service_Ebay_Finding_Response_Abstract::$$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  
Propertypublicstring $version =
inherited

The release version that eBay used to process the request.

Inherited from: \Zend_Service_Ebay_Finding_Response_Abstract::$$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  

Methods

methodpublic__construct(\DOMElement $dom) : void
Parameters
Name Type Description
$dom \DOMElement
methodprotected_init() : void

Initialize object.

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

methodprotected_initXPath() : void
Details
See
\global\Zend_Service_Ebay_Finding::_parseResponse()  
methodprotected_query(string $path, string $type, string $array = false) : mixed
Parameters
Name Type Description
$path string
$type string
$array string

When true means it expects more than one node occurence

Returns
Type Description
mixed
methodpublicattributes(string $tag, string $attribute = null) : mixed
Parameters
Name Type Description
$tag string
$attribute string
Returns
Type Description
mixed
methodpublicgetOperation() : string
Returns
Type Description
string
methodpublicgetOption(string $name = null) : mixed
Parameters
Name Type Description
$name string
Returns
Type Description
mixed
methodpublicsetOperation(string $operation) : \Zend_Service_Ebay_Finding_Response_Abstract
Parameters
Name Type Description
$operation string
Returns
Type Description
\Zend_Service_Ebay_Finding_Response_Abstract Provides a fluent interface
methodpublicsetOption(string | \Zend_Config | array $name, mixed $value = null) : \Zend_Service_Ebay_Finding_Response_Abstract
Parameters
Name Type Description
$name string | \Zend_Config | array
$value mixed
Returns
Type Description
\Zend_Service_Ebay_Finding_Response_Abstract Provides a fluent interface
Documentation was generated by phpDocumentor 2.0.0a8.