Functions:ordersGetList - Revision history

Root: added fromdate, todate

2009-05-01T01:34:09Z

added fromdate, todate

71.163.185.8: added authorizeIsLoggedIn to example source

2009-02-20T14:25:28Z

added authorizeIsLoggedIn to example source

71.163.185.8 at 19:34, 19 February 2009

2009-02-19T19:34:25Z

71.163.185.8 at 19:27, 19 February 2009

2009-02-19T19:27:23Z

71.163.185.8 at 19:24, 19 February 2009

2009-02-19T19:24:58Z

71.163.185.8: New page: == Description == eV::ordersGetList() retrieves a multidimensional array of order information. Especially useful for order history pages. == Syntax == $array = eV::orderGetList([$userId[,...

2009-02-19T19:07:31Z

New page: == Description == eV::ordersGetList() retrieves a multidimensional array of order information. Especially useful for order history pages. == Syntax == $array = eV::orderGetList([$userId[,...

New page

== Description ==
eV::ordersGetList() retrieves a multidimensional array of order information. Especially useful for order history pages.

== Syntax ==
$array = eV::orderGetList([$userId[,$fieldList]]);

== Paramaters ==
*$userId INT (optional)
:: system designated unique userId - all orders that belong to the user will be returned. Defaults to the current session's user.
*$fieldList STRING (optional)
:: comma-delimited list of fields to be returned. If not passed, all fields will be returned.

== Return Values ==
Returns a multidimensional array where the first dimension is the index of the order, and the second dimension is the order's field names:

<pre>
Array
(
[0] => Array
(
// fields automatically included
[orderId] => INT
[orderNumber] => IN
[createDate] => DATETIME
[completeDate] => DATETIME
[cancelDate] => DATETIME
[user_firstName] => STR
[user_lastName] => STR
[user_emailAddress] => STR
[ship_firstName] => STR
[ship_lastName] => STR
[ship_emailAddress] => STR
[pay_firstName] => STR
[pay_lastName] => STR
[pay_emailAddress] => STR
[itemTotal] => FLOAT // cost of items in cart added up
[discountTotal] => FLOAT // discount totals added up
[orderTotal] => FLOAT // cost of items in cart added up, less discounts
[taxTotal] => FLOAT // total taxes charged to order
[shipTotal] => FLOAT // total shipping charged to order
[orderGrandTotal] => FLOAT // sum total of everything (item, tax, ship, less discount) for order
)
[1] => Array
(
...
)
)
</pre>

== Examples ==
;example 1
example 1 goes here
;example 2
example 2 goes here

== See Also ==
:*[[tag:1|tag 1]]
:*[[tag:2|tag 2]]
:*[[tag:3|tag 3]]

@@ Line 51: / Line 51: @@
 == Example ==
 <source lang="php">
 // get listing

@@ Line 67: / Line 67: @@
          echo "<tr><td><a href=\"index.php?fa=ORDER.invoice&orderNumber=" . $order['orderNumber'] . "\">" . $order['orderNumber'] . "</a></td>";
          echo "<td>" . date('M d, Y',strtotime($order['completeDate'])) . "</td>";
-         echo "<td>" . eV::dollarFormat($order['orderGrandTotal'] . "</td></tr>";
+         echo "<td>" . eV::dollarFormat($order['orderGrandTotal']) . "</td></tr>";
       // end if order qualifies to be displayed
       };

@@ Line 58: / Line 58: @@
 echo "<table><tr><td>Order Number</td><td>Date</td><td>Total</td></tr>";
-if(!count($arrOrders)){
-  // no orders, display message
+// we have orders, lets loop
-  echo "<tr><td colspan=3>You have no orders at this time</td></tr>";
+$orderCount = 0;
-} else {
+foreach($arrOrders as $order) {
-  // we have orders, lets loop
-  foreach($arrOrders as $order) {
       // only display orders that are completed and current (not cancelled)
       if(!empty($order['completeDate']) && empty($order['cancelDate'])) {
          echo "<tr><td><a href=\"index.php?fa=ORDER.invoice&orderNumber=" . $order['orderNumber'] . "\">" . $order['orderNumber'] . "</a></td>";
          echo "<td>" . date('M d, Y',strtotime($order['completeDate'])) . "</td>";
@@ Line 71: / Line 70: @@
       // end if order qualifies to be displayed
       };
-   // end order loop
+ // end order loop
-   };
+ };
-// end if !count($arrOrders)
 };
-</source>
+// close the table
-== See Also ==
+// fin!
-:*[[tag:1|tag 1]]
+</source>
-:*[[tag:2|tag 2]]
-:*[[tag:3|tag 3]]

@@ Line 3: / Line 3: @@
 == Syntax ==
-$array = eV::orderGetList([$fieldList[,$userId]]);
+$array = eV::orderGetList([$fieldList[,$userId[,$fromDate[,$toDate]]]]);
 == Paramaters ==
@@ Line 10: / Line 10: @@
 *$userId INT (optional)
 :: system designated unique userId - all orders that belong to the user will be returned. Defaults to the current session's user.

@@ Line 3: / Line 3: @@
 == Syntax ==
-$array = eV::orderGetList([$userId[,$fieldList]]);
+$array = eV::orderGetList([$fieldList[,$userId]]);
 == Paramaters ==
 *$fieldList STRING (optional)
 :: comma-delimited list of fields to be returned. If not passed, all fields will be returned.
 == Return Values ==
@@ Line 48: / Line 49: @@
 </pre>
-== Examples ==
+== Example ==
-;example 1
+<source lang="php">
-example 1 goes here
-;example 2
+// get listing
-example 2 goes here
+$arrOrders = eV::ordersGetList("orderId,orderNumber,completeDate,cancelDate,orderTotal");
 == See Also ==