cvs: pear /Services_Ebay/Ebay/Model DisputeList.php Shipment.php /Services_Ebay/docs ideas.txt

schst Sun Nov 7 08:28:02 2004 EDT Modified files: /pear/Services_Ebay/Ebay/Model DisputeList.php Shipment.php /pear/Services_Ebay/docs ideas.txt Log: added some documentation http://cvs.php.net/diff.php/pear/Services_Ebay/Ebay/Model/DisputeList.php?r1=1.1&r2=1.2&ty=u Index: pear/Services_Ebay/Ebay/Model/DisputeList.php diff -u pear/Services_Ebay/Ebay/Model/DisputeList.php:1.1 pear/Services_Ebay/Ebay/Model/DisputeList.php:1.2 --- pear/Services_Ebay/Ebay/Model/DisputeList.php:1.1 Thu Oct 28 13:14:53 2004 +++ pear/Services_Ebay/Ebay/Model/DisputeList.php Sun Nov 7 08:28:02 2004 @@ -8,7 +8,19 @@ */ class Services_Ebay_Model_DisputeList extends Services_Ebay_Model implements IteratorAggregate { + /** + * container for disputes + * + * @var array + */ private $disputes = array(); + + /** + * create a new list of disputes + * + * @param array return value from GetUserDisputes + * @param Services_Ebay_Session + */ public function __construct($props, $session = null) { if (isset($props['Disputes'])) { @@ -23,6 +35,11 @@ parent::__construct($props, $session); } + /** + * iterate through the disputes + * + * @return object + */ public function getIterator() { $it = new ArrayObject($this->disputes); http://cvs.php.net/diff.php/pear/Services_Ebay/Ebay/Model/Shipment.php?r1=1.1&r2=1.2&ty=u Index: pear/Services_Ebay/Ebay/Model/Shipment.php diff -u pear/Services_Ebay/Ebay/Model/Shipment.php:1.1 pear/Services_Ebay/Ebay/Model/Shipment.php:1.2 --- pear/Services_Ebay/Ebay/Model/Shipment.php:1.1 Thu Oct 28 13:14:53 2004 +++ pear/Services_Ebay/Ebay/Model/Shipment.php Sun Nov 7 08:28:02 2004 @@ -8,13 +8,24 @@ */ class Services_Ebay_Model_Shipment extends Services_Ebay_Model { + /** + * default properties for a shipment + * + * @var array + */ protected $properties = array( 'CurrencyId' => 1, 'Transactions' => array() ); - - + /** + * set package dimemsions for the shipment + * + * @param int depth + * @param int length + * @param int width + * @return void + */ public function SetPackageDimensions($Depth, $Length, $Width) { $this->properties['PackageDimensions'] = array( @@ -25,11 +36,32 @@ ); } + /** + * add a transaction + * + * @param string item id + * @param string transactio id + * @return void + */ public function AddTransaction($ItemId, $TransactionId) { array_push($this->properties['Transactions'], array( 'ItemId' => $ItemId, 'TransactionId' => $TransactionId )); } + /** + * set the from address + * + * @param string company name + * @param string name + * @param string street, line 1 + * @param string street, line 2 + * @param string city + * @param string zipcode + * @param string state or province + * @param string country + * @param string phone number + * @return void + */ public function SetFromAddress($CompanyName, $Name, $Street1, $Street2, $City, $Zip, $StateOrProvince, $Country, $Phone = null) { $this->properties['ShipFromAddress'] = array( @@ -45,6 +77,21 @@ ); } + /** + * set the to address + * + * @param string type of the address + * @param string company name + * @param string name + * @param string street, line 1 + * @param string street, line 2 + * @param string city + * @param string zipcode + * @param string state or province + * @param string country + * @param string phone number + * @return void + */ public function SetAddress($Type, $CompanyName, $Name, $Street1, $Street2, $City, $Zip, $StateOrProvince, $Country, $Phone = null) { $this->properties['ShippingAddress'] = array( http://cvs.php.net/diff.php/pear/Services_Ebay/docs/ideas.txt?r1=1.1&r2=1.2&ty=u Index: pear/Services_Ebay/docs/ideas.txt diff -u pear/Services_Ebay/docs/ideas.txt:1.1 pear/Services_Ebay/docs/ideas.txt:1.2 --- pear/Services_Ebay/docs/ideas.txt:1.1 Thu Oct 28 13:14:53 2004 +++ pear/Services_Ebay/docs/ideas.txt Sun Nov 7 08:28:02 2004 @@ -1,6 +1,6 @@ Services_Ebay ideas: -------------------- -$Id: ideas.txt,v 1.1 2004/10/28 17:14:53 schst Exp $ +$Id: ideas.txt,v 1.2 2004/11/07 13:28:02 schst Exp $ 1. Models: ---------- @@ -18,7 +18,13 @@ some notices/warnings, whenever someone is using a parameter that des not exist -3. Deprecated Methods +3. Cache models +--------------- +- Use PEAR::Cache +- Models may return their lifetime, allows you to cache items for a shorter + amount of time based on the time the auction has left + +4. Deprecated Methods --------------------- Could be implemented and raise a notice, when used.