Docs For Class Services_Ebay

buildRequestBody [line 360]

string buildRequestBody(
string
$verb, [array|null
$params = array()], [
$authType = Services_Ebay::AUTH_TYPE_TOKEN])

build XML code for a request

Return: XML request
Access: public

Parameters:

string	`$verb`	—	verb of the request
array\|null	`$params`	—	parameters of the request
	`$authType`	—

[ Top ]

__construct (Constructor) [line 228]

Services_Ebay_Session __construct(
string
$devId, string
$appId, string
$certId, [string
$encoding = 'ISO-8859-1'])

create the session object

Access: public

Parameters:

string	`$devId`	—	developer id
string	`$appId`	—	application id
string	`$certId`	—	certificate id
string	`$encoding`	—	external encoding, as eBay uses UTF-8, the session will encode and decode to the specified encoding. Possible values are ISO-8859-1 and UTF-8

[ Top ]

getErrors [line 534]

array getErrors(
[boolean
$clear = true])

get the errors and warnings that happened during the last API calls

Access: public

Parameters:

boolean $clear — whether to clear the internal error list

[ Top ]

getWire [line 280]

string getWire(
)

get the XML code that was sent accross the network

To use this, debug mode must be set to DEBUG_STORE or DEBUG_PRINT

Return: xml wire
Access: public

[ Top ]

sendRequest [line 419]

array sendRequest(
string
$verb, [array
$params = array()], [integer
$authType = Services_Ebay::AUTH_TYPE_TOKEN], [boolean
$parseResult = true])

send a request

This method is used by the API methods. You may call it directly to access any eBay function that is not yet implemented.

Return: response
Todo: add real error handling
Access: public

Parameters:

string	`$verb`	—	function to call
array	`$params`	—	associative array containing all parameters for the function call
integer	`$authType`	—	authentication type
boolean	`$parseResult`	—	flag to indicate, whether XML should be parsed or returned raw

[ Top ]

setAuthenticationData [line 300]

void setAuthenticationData(
string
$username, [
$password = null])

set the authentication username and password

Access: public

Parameters:

string	`$username`	—
	`$password`	—

[ Top ]

setCompatLevel [line 569]

void setCompatLevel(
int
$compatLevel)

set compatibility level if particular request needs another version of API instead of default one

Access: public

Parameters:

int $compatLevel —

[ Top ]

setDebug [line 268]

void setDebug(
integer
$debug)

set the debug mode

Possible values are:

Services_Ebay_Session::DEBUG_NONE
Services_Ebay_Session::DEBUG_STORE
Services_Ebay_Session::DEBUG_PRINT

See: Services_Ebay_Session::getWire()
Access: public

Parameters:

integer $debug —

[ Top ]

setDetailLevel [line 337]

void setDetailLevel(
integer
$level)

set the detail level

Access: public

Parameters:

integer $level —

[ Top ]

setErrorLanguage [line 347]

void setErrorLanguage(
string
$language)

set the error language

Access: public

Parameters:

string $language —

[ Top ]

setSerializerOptions [line 548]

void setSerializerOptions(
[array
$opts = array()])

set additional options for the serializer

Access: public

Parameters:

array $opts —

[ Top ]

setSiteId [line 327]

void setSiteId(
integer
$siteId)

set the site id

Access: public

Parameters:

integer $siteId —

[ Top ]

setToken [line 290]

void setToken(
string
$token)

set the authentication token

Access: public

Parameters:

string $token —

[ Top ]

setUnserializerOptions [line 558]

void setUnserializerOptions(
[array
$opts = array()])

set additional options for the unserializer

Access: public

Parameters:

array $opts —

[ Top ]

setUrl [line 317]

void setUrl(
string
$url)

set the API URL

Access: public

Parameters:

string

$url

—

Possible values are:

Services_Ebay_Session::URL_SANDBOX
Services_Ebay_Session::URL_PRODUCTION
Other URLs as applicable

[ Top ]

Class: Services_Ebay_Session

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$compatLevel = 405

$debug = 1

$detailLevel =

$wire = null

Method Detail

buildRequestBody [line 360]

Parameters:

__construct (Constructor) [line 228]

Parameters:

getErrors [line 534]

Parameters:

getWire [line 280]

sendRequest [line 419]

Parameters:

setAuthenticationData [line 300]

Parameters:

setCompatLevel [line 569]

Parameters:

setDebug [line 268]

Parameters:

setDetailLevel [line 337]

Parameters:

setErrorLanguage [line 347]

Parameters:

setSerializerOptions [line 548]

Parameters:

setSiteId [line 327]

Parameters:

setToken [line 290]

Parameters:

setUnserializerOptions [line 558]

Parameters:

setUrl [line 317]

Parameters: