Ebay extends Platform
Class Platform Base class for trading platforms.
Table of Contents
Constants
- API_URL = "https://api.ebay.com/ws/api.dll"
- LINK_TYPE_PUBLIC_DETAIL_ORDER = 'PUBLIC_DETAIL_ORDER'
- LINK_TYPE_PUBLIC_FEEDBACK = 'PUBLIC_FEEDBACK'
- TRADING_PLATFORM_CODE = "ebay"
Methods
- addLogRecord() : bool
- getAnalyticCode() : string
- getApiTokenUrl() : mixed
- getApiUrl() : mixed
- getCode() : string
- getExternalLink() : string
- getField() : mixed
- getId() : mixed
- getInfo() : array<string|int, mixed>
- getInstance() : Ebay
- getInstanceByCode() : Platform
- getRealName() : mixed
- getSettings() : array<string|int, mixed>
- getSftpTokenUrl() : mixed
- install() : bool
- Installs all necessary stuff for Ebay.
- isActive() : bool
- isInstalled() : bool
- isOfType() : bool
- log() : bool
- Log events to system log & sends error to email.
- onAfterUpdateShipment() : mixed
- resetSettings() : mixed
- saveSettings() : bool
- sendErrorMail() : bool
- Sends error description to e-mail
- setActive() : bool
- Sets Ebay active.
- setShipmentTableOnAfterUpdateEvent() : mixed
- uninstall() : bool
- unsetActive() : bool
- Sets Ebay inactive.
Constants
API_URL
public
mixed
API_URL
= "https://api.ebay.com/ws/api.dll"
LINK_TYPE_PUBLIC_DETAIL_ORDER
public
mixed
LINK_TYPE_PUBLIC_DETAIL_ORDER
= 'PUBLIC_DETAIL_ORDER'
LINK_TYPE_PUBLIC_FEEDBACK
public
mixed
LINK_TYPE_PUBLIC_FEEDBACK
= 'PUBLIC_FEEDBACK'
TRADING_PLATFORM_CODE
public
mixed
TRADING_PLATFORM_CODE
= "ebay"
Methods
addLogRecord()
public
addLogRecord(int $level, string $type, string $itemId, string $description) : bool
Parameters
- $level : int
-
The level of event.
- $type : string
-
Type of event.
- $itemId : string
-
Item idenifyer.
- $description : string
-
Description of event.
Return values
bool —Success or not.
getAnalyticCode()
public
getAnalyticCode() : string
Return values
string —Platform code.
getApiTokenUrl()
public
static getApiTokenUrl() : mixed
getApiUrl()
public
static getApiUrl() : mixed
getCode()
public
getCode() : string
Return values
string —Platform code.
getExternalLink()
public
getExternalLink(mixed $type, Order $order) : string
Parameters
- $type : mixed
- $order : Order
Return values
stringgetField()
public
getField(mixed $fieldName) : mixed
Parameters
- $fieldName : mixed
getId()
public
getId() : mixed
Return values
mixed —Id of the current trading platform.
getInfo()
public
getInfo() : array<string|int, mixed>
Return values
array<string|int, mixed>getInstance()
public
static getInstance() : Ebay
Tags
Return values
EbaygetInstanceByCode()
public
static getInstanceByCode(mixed $code) : Platform
Parameters
- $code : mixed
Tags
Return values
PlatformgetRealName()
public
getRealName() : mixed
getSettings()
public
getSettings() : array<string|int, mixed>
Return values
array<string|int, mixed> —Platform settings.
getSftpTokenUrl()
public
static getSftpTokenUrl(mixed $accountName) : mixed
Parameters
- $accountName : mixed
install()
Installs all necessary stuff for Ebay.
public
install() : bool
Return values
boolisActive()
public
isActive() : bool
Return values
boolisInstalled()
public
isInstalled() : bool
Return values
bool —Is platfom installed?.
isOfType()
public
isOfType(string $type) : bool
Parameters
- $type : string
Return values
boollog()
Log events to system log & sends error to email.
public
static log(int $level, string $type, string $itemId, string $description, string $siteId) : bool
Parameters
- $level : int
-
Log level of event.
- $type : string
-
Event type.
- $itemId : string
-
Item id.
- $description : string
-
Event description.
- $siteId : string
-
Site id.
Return values
boolonAfterUpdateShipment()
public
static onAfterUpdateShipment(Event $event, array<string|int, mixed> $additional) : mixed
Parameters
- $event : Event
- $additional : array<string|int, mixed>
resetSettings()
public
resetSettings(mixed $siteId) : mixed
Parameters
- $siteId : mixed
saveSettings()
public
saveSettings(array<string|int, mixed> $settings) : bool
Parameters
- $settings : array<string|int, mixed>
-
Platform settings.
Return values
bool —Is success?.
sendErrorMail()
Sends error description to e-mail
public
sendErrorMail(string $type, string $details, string $siteId) : bool
Parameters
- $type : string
-
Type of error.
- $details : string
-
Error details.
- $siteId : string
-
Site id.
Return values
boolsetActive()
Sets Ebay active.
public
setActive() : bool
Tags
Return values
boolsetShipmentTableOnAfterUpdateEvent()
public
static setShipmentTableOnAfterUpdateEvent() : mixed
uninstall()
public
uninstall() : bool
Return values
bool —Is deletion successful?.
unsetActive()
Sets Ebay inactive.
public
unsetActive() : bool