Functions:addressesGet - Revision history

Root: changes shippingOrBilling to shippingOrPayment

2009-05-25T17:54:17Z

changes shippingOrBilling to shippingOrPayment

Root: added shippingOrBilling

2009-05-25T17:47:14Z

added shippingOrBilling

Root at 03:37, 25 May 2009

2009-05-25T03:37:20Z

Root at 03:17, 25 May 2009

2009-05-25T03:17:07Z

Root: New page: == Description == eV::addressesGet returns an array of addresses from both the selected user account and order. For use with offering an address selection for multiple shipping address che...

2009-05-25T03:09:39Z

New page: == Description == eV::addressesGet returns an array of addresses from both the selected user account and order. For use with offering an address selection for multiple shipping address che...

New page

== Description ==
eV::addressesGet returns an array of addresses from both the selected user account and order. For use with offering an address selection for multiple shipping address checkouts.

== Syntax ==
$array = eV::addressesGet([$addressList][,$orderArray][,$userId]);

== Paramaters ==
*addressList STRING OPTIONAL
:: comma-delimited list of address fields. user_addressId and sale_addressId will automatically be included. Available address fields:
::*addressName
::*firstName
::*lastName
::*street1
::*street2
::*city
::*state
::*zipCode
::*country
::*phone1
::*phone2
::*phone3
::*fax
::*title
::*company
*orderArray ARRAY OPTIONAL
:: Array of order information for order addresses to be returned, as provided by eV::orderGetCompleteArray()
*userId INT OPTIONAL
:: unique userId for user's addresses to be returned

== Return Values ==
Multidimensional array with first dimension being the numerical index of the address, second index containing the address field name.

The returned array is as follows (only requested fields via $fieldList will be returned):
<pre>
Array
(
[0] => Array
(
// always returned
[user_addressId] => INT
[sale_addressId] => INT
// optional elements, as specified in $fieldList
[addressName] => STRING
[firstName] => STRING
[lastName] => STRING
[street1] => STRING
[street2] => STRING
[city] => STRING
[state] => STRING
[zipCode] => STRING
[country] => STRING
[phone1] => STRING
[phone2] => STRING
[phone3] => STRING
[fax] => STRING
[company] => STRING
[title] => STRING
)
[1] => Array ...
)
</pre>

== Examples ==
;Basic use example
<source lang="php">
// get current order, users addresses
$arrAddresses = eV::getAddresses('addressName,firstName,lastName');
// output
foreach($arrAddresses as $address) echo "<br>" . $address['addressName'] . ": " . $address['firstName'] . " " . $address['lastName'];
</source>

;Example with previously called eV::orderGetCompleteArray
<source lang="php">
// get order
$orderArray = eV::orderGetCompleteArray();
// get current order, users addresses
// reuse the orderArray so script uses less overhead
$arrAddresses = eV::getAddresses('addressName,firstName,lastName',$orderArray);
// output
foreach($arrAddresses as $address) echo "<br>" . $address['addressName'] . ": " . $address['firstName'] . " " . $address['lastName'];
</source>

@@ Line 3: / Line 3: @@
 == Syntax ==
-$array = eV::addressesGet([$fieldList][,$shippingOrBilling][,$orderId][,$userId]);
+$array = eV::addressesGet([$fieldList][,$shippingOrPayment][,$orderId][,$userId]);
 == Paramaters ==
@@ Line 23: / Line 23: @@
 ::*title
 ::*company
-*shippingOrBilling BIT OPTIONAL
+*shippingOrPayment BIT OPTIONAL
 :: 0 = only shipping addresses from order, 1 = only billing addresses from order, NULL = both
 *orderId INT OPTIONAL

@@ Line 3: / Line 3: @@
 == Syntax ==
-$array = eV::addressesGet([$addressList][,$orderArray][,$userId]);
+$array = eV::addressesGet([$addressList][,$orderId][,$userId]);
 == Paramaters ==
 *addressList STRING OPTIONAL
-:: comma-delimited list of address fields. user_addressId and order_addressId will automatically be included. Available address fields:
+:: comma-delimited list of address fields. user_addressId and sale_addressId will automatically be included. Available address fields:
 ::*addressName
 ::*firstName
@@ Line 23: / Line 23: @@
 ::*title
 ::*company
-*orderArray ARRAY OPTIONAL
+*orderId INT OPTIONAL
-:: Array of order information for order addresses to be returned, as provided by eV::orderGetCompleteArray()
+:: unique orderId for visitor's shopping cart
 *userId INT OPTIONAL
 :: unique userId for user's addresses to be returned
@@ Line 39: / Line 39: @@
              // always returned
              [user_addressId] => INT
-             [order_addressId] => INT
+             [sale_addressId] => INT
              // optional elements, as specified in $fieldList
              [addressName] => STRING
@@ Line 66: / Line 66: @@
 // get current order, users addresses
 $arrAddresses = eV::getAddresses('addressName,firstName,lastName');
 // output
 foreach($arrAddresses as $address) echo "<br>" . $address['addressName'] . ": " . $address['firstName'] . " " . $address['lastName'];
 </source>