API Documentation

Zend/Service/Ebay/Abstract.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 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: Abstract.php 22824 2010-08-09 18:59:54Z renanbr $  

\Zend_Service_Ebay_Abstract

Package: Zend\Service\Ebay

Children
\Zend_Service_Ebay_Finding
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Used_by
\Zend_Service_Ebay_Finding  

Constants

Constant  OPTION_APP_ID = 'app_id'
Constant  OPTION_GLOBAL_ID = 'global_id'

Properties

Propertyprotectedmixed  $_client= ''

Details
Type
mixed
Propertyprotectedarray  $_options= 'array()'

Default valuearray()Details
Type
array

Methods

methodpublic__construct( \Zend_Config|array $options = null ) : void

Parameters
Name Type Description
$options \Zend_Config|array
methodprotected_optionsToNameValueSyntax( \Zend_Config|array $options ) : array

Implements Name-value Syntax translator.

Example:

array( 'paginationInput' => array( 'entriesPerPage' => 5, 'pageNumber' => 2 ), 'itemFilter' => array( array( 'name' => 'MaxPrice', 'value' => 25, 'paramName' => 'Currency', 'paramValue' => 'USD' ), array( 'name' => 'FreeShippingOnly', 'value' => true ), array( 'name' => 'ListingType', 'value' => array( 'AuctionWithBIN', 'FixedPrice', 'StoreInventory' ) ) ), 'productId' => array( '' => 123, 'type' => 'UPC' ) )

this above is translated to

array( 'paginationInput.entriesPerPage' => '5', 'paginationInput.pageNumber' => '2', 'itemFilter(0).name' => 'MaxPrice', 'itemFilter(0).value' => '25', 'itemFilter(0).paramName' => 'Currency', 'itemFilter(0).paramValue' => 'USD', 'itemFilter(1).name' => 'FreeShippingOnly', 'itemFilter(1).value' => '1', 'itemFilter(2).name' => 'ListingType', 'itemFilter(2).value(0)' => 'AuctionWithBIN', 'itemFilter(2).value(1)' => 'FixedPrice', 'itemFilter(2).value(2)' => 'StoreInventory', 'productId' => '123', 'productId.@type' => 'UPC' )

Parameters
Name Type Description
$options \Zend_Config|array
Returns
Type Description
array A simple array of strings
Details
Link
http://developer.ebay.com/DevZone/finding/Concepts/MakingACall.html#nvsyntax  
methodpublicgetClient( ) : mixed
abstract

Returns
Type Description
mixed
methodpublicgetOption( string $name = null ) : mixed

Parameters
Name Type Description
$name string
Returns
Type Description
mixed
methodpublichasOption( string $name ) : boolean

Parameters
Name Type Description
$name string
Returns
Type Description
boolean
methodpublicoptionsToArray( \Zend_Config|array $options ) : array
static

Parameters
Name Type Description
$options \Zend_Config|array
Returns
Type Description
array
Throws
Exception Description
\Zend_Service_Ebay_Finding_Exception When $options is not an array neither a Zend_Config object
methodpublicsetClient( mixed $client ) : \Zend_Service_Ebay_Abstract
abstract

Parameters
Name Type Description
$client mixed
Returns
Type Description
\Zend_Service_Ebay_Abstract Provides a fluent interface
methodpublicsetOption( string|\Zend_Config|array $name, mixed $value = null ) : \Zend_Service_Ebay_Abstract

Parameters
Name Type Description
$name string|\Zend_Config|array
$value mixed
Returns
Type Description
\Zend_Service_Ebay_Abstract Provides a fluent interface
methodpublictoEbayValue( mixed $value ) : string
static

Translate native PHP values format to ebay format for request.

Boolean is translated to "0" or "1", date object generates ISO 8601, everything else is translated to string.

Parameters
Name Type Description
$value mixed
Returns
Type Description
string
methodpublictoPhpValue( string $value, string $type ) : mixed
static

Translate an ebay value format to native PHP type.

Parameters
Name Type Description
$value string
$type string
Returns
Type Description
mixed
Throws
Exception Description
\Zend_Service_Ebay_Finding_Exception When $type is not valid
Details
See
\http://developer.ebay.com/DevZone/finding/CallRef/types/simpleTypes.html  
Documentation was generated by DocBlox 0.15.1.