Class: Services_Ebay_Model

Source Location: /Services_Ebay-0.13.1/Services/Ebay/Model.php

Class Overview

Base class for all models

Author(s):

Stephan Schmidt <schst at php.net>

Variables

Methods

Child classes:

Services_Ebay_Model_Preferences: Model for an eBay preference

Services_Ebay_Model_Feedback: Model for a eBay feedback

Services_Ebay_Model_Shipment: Model for a shipment

Services_Ebay_Model_TransactionList: Model for a list of transactions

Services_Ebay_Model_MemberMessageList: Model for a list of member messages

Services_Ebay_Model_Account: Model for an eBay account

Services_Ebay_Model_MemberMessage: Model for a member message

Services_Ebay_Model_Bid: Model for a single bid

Services_Ebay_Model_MyeBay: Model for My eBay

Services_Ebay_Model_User: Model for an eBay user

Services_Ebay_Model_FeedbackEntry: Model for a eBay feedback

Services_Ebay_Model_Transaction: Model for a eBay transaction

Services_Ebay_Model_BidList: Model for a list of bids

Services_Ebay_Model_DisputeList: Model for a list of eBay disputes

Services_Ebay_Model_Store: Model for an eBay store

Services_Ebay_Model_ProductFinder: Model for a product finder

Services_Ebay_Model_ItemList: Model for a item list

Services_Ebay_Model_Item: Model for an eBay item

Services_Ebay_Model_Dispute: Model for a eBay dispute

Services_Ebay_Model_Order: Model for an eBay order

Services_Ebay_Model_SearchResult: Model for a search result

Inherited Variables

Inherited Methods

Class Details

[line 16]
Base class for all models

$Id$

The base class provides __set() and __get() as well as some other helper methods.

Author: Stephan Schmidt <schst@php.net>
Todo: different caches for different detail levels
Todo: add the possibility to disable the cache for single models

[ Top ]

Class Variables

$cache = null

[line 61]

store the static cache for all models of this type

Access: protected

Type:

object Services_Ebay_Cache

[ Top ]

$cached = false

[line 67]

indicates, whether the model has been cached

Access: protected

Type:

mixed

[ Top ]

$eBayProperties = array()

[line 40]

properties that are stored in eBay's database

These are stored to check, which fields have been modified in the item

Access: protected

Type:

array

[ Top ]

$primaryKey = null

[line 54]

property that stores the unique identifier (=pk) of the model

Access: protected

Type:

string

[ Top ]

$properties = array()

[line 30]

properties of the model

Access: protected

Type:

array

[ Top ]

$session =

[line 47]

optional session, used to send API calls

Access: protected

Type:

object Services_Ebay_Session

[ Top ]

$type = null

[line 23]

model type

Access: protected

Type:

string

[ Top ]

Method Detail

__construct (Constructor) [line 74]

Services_Ebay_Model __construct(
array
$props, [
$session = null], [
$DetailLevel = 0])

create new model

Access: public

Overridden in child classes as:

Services_Ebay_Model_Preferences::__construct(): create new preferences

Services_Ebay_Model_Feedback::__construct(): create new feedback model

Services_Ebay_Model_TransactionList::__construct(): create new feedback model

Services_Ebay_Model_MemberMessageList::__construct(): create new feedback model

Services_Ebay_Model_Account::__construct(): create new model

Services_Ebay_Model_Bid::__construct(): Constructor

Services_Ebay_Model_MyeBay::__construct(): create a new item list

Services_Ebay_Model_BidList::__construct(): create new feedback model

Services_Ebay_Model_DisputeList::__construct(): create a new list of disputes

Services_Ebay_Model_Store::__construct(): create a new item list

Services_Ebay_Model_ProductFinder::__construct(): create new model

Services_Ebay_Model_ItemList::__construct(): create a new item list

Services_Ebay_Model_Item::__construct(): create new item

Services_Ebay_Model_Dispute::__construct(): constructor

Services_Ebay_Model_Order::__construct(): create a new order

Services_Ebay_Model_SearchResult::__construct(): create new model

Parameters:

array	`$props`	—	properties
	`$session`	—
	`$DetailLevel`	—

[ Top ]

GetModifiedProperties [line 176]

array GetModifiedProperties(
)

get the properties that have been modified, since the item has been fetched the last time.

This does not involve an API-call

Access: public

[ Top ]

getPrimaryKey [line 249]

string getPrimaryKey(
)

get the primary key of the model

Access: public

[ Top ]

isCached [line 108]

boolean isCached(
)

check, whether the model has been cached

Access: public

[ Top ]

offsetExists [line 199]

void offsetExists(
string
$offset)

check, whether a property exists

This is needed to implement the ArrayAccess interface

Access: public

Parameters:

string $offset — property

[ Top ]

offsetGet [line 214]

void offsetGet(
string
$offset)

get a property

This is needed to implement the ArrayAccess interface

Access: public

Parameters:

string $offset — property

[ Top ]

offsetSet [line 227]

void offsetSet(
string
$offset, mixed
$value)

set a property

This is needed to implement the ArrayAccess interface

Access: public

Parameters:

string	`$offset`	—	property
mixed	`$value`	—	value

[ Top ]

offsetUnset [line 239]

void offsetUnset(
string
$offset)

unset a property

This is needed to implement the ArrayAccess interface

Access: public

Parameters:

string $offset — property

[ Top ]

setCache [line 128]

void setCache(
Services_Ebay_Cache
$cache)

set the cache

Access: public

Parameters:

object Services_Ebay_Cache $cache —

[ Top ]

setSession [line 118]

void setSession(
Services_Ebay_Session
$session)

set the session

Access: public

Parameters:

object Services_Ebay_Session $session —

[ Top ]

toArray [line 162]

array toArray(
)

return all properties of the user

Access: public

Overridden in child classes as:

Services_Ebay_Model_Preferences::toArray(): creates an array for serialization

[ Top ]

__get [line 139]

mixed __get(
string
$prop)

get a property

Return: property value
Access: public

Parameters:

string $prop — property name

[ Top ]

__set [line 152]

void __set(
string
$prop, mixed
$value)

set a property

Access: public

Overridden in child classes as:

Services_Ebay_Model_Item::__set()

Services_Ebay_Model_Order::__set(): set a property (overriding the parent one)

Parameters:

string	`$prop`	—	property name
mixed	`$value`	—	property value

[ Top ]