@@ -93,7 +93,6 @@ |
||
| 93 | 93 | /** |
| 94 | 94 | * saves the form into session. |
| 95 | 95 | * |
| 96 | - * @param array $data - data from form. |
|
| 97 | 96 | */ |
| 98 | 97 | public function saveDataToSession() |
| 99 | 98 | { |
@@ -93,7 +93,6 @@ |
||
| 93 | 93 | /** |
| 94 | 94 | * saves the form into session. |
| 95 | 95 | * |
| 96 | - * @param array $data - data from form. |
|
| 97 | 96 | */ |
| 98 | 97 | public function saveDataToSession() |
| 99 | 98 | { |
@@ -27,7 +27,7 @@ |
||
| 27 | 27 | private $divider = 3; |
| 28 | 28 | |
| 29 | 29 | /** |
| 30 | - *@return SQLQuery |
|
| 30 | + *@return DataQuery |
|
| 31 | 31 | **/ |
| 32 | 32 | public function apply(DataQuery $query) |
| 33 | 33 | { |
@@ -11,7 +11,7 @@ |
||
| 11 | 11 | class OrderFilters_HasBeenCancelled extends ExactMatchFilter |
| 12 | 12 | { |
| 13 | 13 | /** |
| 14 | - *@return SQLQuery |
|
| 14 | + *@return DataQuery |
|
| 15 | 15 | **/ |
| 16 | 16 | public function apply(DataQuery $query) |
| 17 | 17 | { |
@@ -15,7 +15,7 @@ |
||
| 15 | 15 | class OrderFilters_MemberAndAddress extends ExactMatchFilter |
| 16 | 16 | { |
| 17 | 17 | /** |
| 18 | - *@return SQLQuery |
|
| 18 | + *@return DataQuery |
|
| 19 | 19 | **/ |
| 20 | 20 | public function apply(DataQuery $query) |
| 21 | 21 | { |
@@ -11,7 +11,7 @@ |
||
| 11 | 11 | class OrderFilters_MultiOptionsetStatusIDFilter extends ExactMatchFilter |
| 12 | 12 | { |
| 13 | 13 | /** |
| 14 | - *@return SQLQuery |
|
| 14 | + *@return DataQuery |
|
| 15 | 15 | **/ |
| 16 | 16 | public function apply(DataQuery $query) |
| 17 | 17 | { |
@@ -11,7 +11,7 @@ |
||
| 11 | 11 | class OrderFilters_MustHaveAtLeastOnePayment extends ExactMatchFilter |
| 12 | 12 | { |
| 13 | 13 | /** |
| 14 | - *@return SQLQuery |
|
| 14 | + *@return DataQuery |
|
| 15 | 15 | **/ |
| 16 | 16 | public function apply(DataQuery $query) |
| 17 | 17 | { |
@@ -192,7 +192,7 @@ discard block |
||
| 192 | 192 | * @param bool (optional) $b |
| 193 | 193 | * @param int (optional) $orderID |
| 194 | 194 | * |
| 195 | - * @return bool |
|
| 195 | + * @return boolean|null |
|
| 196 | 196 | */ |
| 197 | 197 | public static function set_needs_recalculating($b = true, $orderID = 0) |
| 198 | 198 | { |
@@ -264,7 +264,7 @@ discard block |
||
| 264 | 264 | /** |
| 265 | 265 | * This function returns the OrderSteps. |
| 266 | 266 | * |
| 267 | - * @return ArrayList (OrderSteps) |
|
| 267 | + * @return DataList (OrderSteps) |
|
| 268 | 268 | **/ |
| 269 | 269 | public static function get_order_status_options() |
| 270 | 270 | { |
@@ -453,6 +453,7 @@ discard block |
||
| 453 | 453 | * link to edit the record. |
| 454 | 454 | * |
| 455 | 455 | * @param string | Null $action - e.g. edit |
| 456 | + * @param string $action |
|
| 456 | 457 | * |
| 457 | 458 | * @return string |
| 458 | 459 | */ |
@@ -1159,7 +1160,7 @@ discard block |
||
| 1159 | 1160 | * @param Member $member - the user cancelling the order |
| 1160 | 1161 | * @param string $reason - the reason the order is cancelled |
| 1161 | 1162 | * |
| 1162 | - * @return OrderStatusLog_Cancel |
|
| 1163 | + * @return integer |
|
| 1163 | 1164 | */ |
| 1164 | 1165 | public function Cancel(Member $member, $reason = '') |
| 1165 | 1166 | { |
@@ -1594,7 +1595,7 @@ discard block |
||
| 1594 | 1595 | * Stores the preferred currency of the order. |
| 1595 | 1596 | * IMPORTANTLY we store the exchange rate for future reference... |
| 1596 | 1597 | * |
| 1597 | - * @param EcommerceCurrency $currency |
|
| 1598 | + * @param EcommerceCurrency $newCurrency |
|
| 1598 | 1599 | */ |
| 1599 | 1600 | public function UpdateCurrency($newCurrency) |
| 1600 | 1601 | { |
@@ -2055,7 +2056,7 @@ discard block |
||
| 2055 | 2056 | * @param string|array $excluded - Class(es) of modifier(s) to ignore in the calculation. |
| 2056 | 2057 | * @param bool $stopAtExcludedModifier - when this flag is TRUE, we stop adding the modifiers when we reach an excluded modifier. |
| 2057 | 2058 | * |
| 2058 | - * @return float |
|
| 2059 | + * @return integer |
|
| 2059 | 2060 | */ |
| 2060 | 2061 | public function ModifiersSubTotal($excluded = null, $stopAtExcludedModifier = false) |
| 2061 | 2062 | { |
@@ -2253,7 +2254,7 @@ discard block |
||
| 2253 | 2254 | * |
| 2254 | 2255 | * @param Member (optional) $member |
| 2255 | 2256 | * |
| 2256 | - * @return bool |
|
| 2257 | + * @return boolean|null |
|
| 2257 | 2258 | **/ |
| 2258 | 2259 | public function canViewAdminStuff($member = null) |
| 2259 | 2260 | { |
@@ -2306,7 +2307,7 @@ discard block |
||
| 2306 | 2307 | * If any of them need immediate attention then this is done |
| 2307 | 2308 | * first after which it will go through to the checkout page. |
| 2308 | 2309 | * |
| 2309 | - * @param Member (optional) $member |
|
| 2310 | + * @param Member Member $member |
|
| 2310 | 2311 | * |
| 2311 | 2312 | * @return bool |
| 2312 | 2313 | **/ |
@@ -2652,6 +2653,10 @@ discard block |
||
| 2652 | 2653 | { |
| 2653 | 2654 | return $this->getTitle($dateFormat, $includeName); |
| 2654 | 2655 | } |
| 2656 | + |
|
| 2657 | + /** |
|
| 2658 | + * @param string $dateFormat |
|
| 2659 | + */ |
|
| 2655 | 2660 | public function getTitle($dateFormat = null, $includeName = false) |
| 2656 | 2661 | { |
| 2657 | 2662 | if ($this->exists()) { |
@@ -2715,7 +2720,7 @@ discard block |
||
| 2715 | 2720 | /** |
| 2716 | 2721 | * Returns the subtotal of the items for this order. |
| 2717 | 2722 | * |
| 2718 | - * @return float |
|
| 2723 | + * @return integer |
|
| 2719 | 2724 | */ |
| 2720 | 2725 | public function SubTotal() |
| 2721 | 2726 | { |
@@ -2781,7 +2786,7 @@ discard block |
||
| 2781 | 2786 | /** |
| 2782 | 2787 | * Returns the total cost of an order including the additional charges or deductions of its modifiers. |
| 2783 | 2788 | * |
| 2784 | - * @return float |
|
| 2789 | + * @return integer |
|
| 2785 | 2790 | */ |
| 2786 | 2791 | public function Total() |
| 2787 | 2792 | { |
@@ -3411,7 +3416,7 @@ discard block |
||
| 3411 | 3416 | /** |
| 3412 | 3417 | * Converts the Order into HTML, based on the Order Template. |
| 3413 | 3418 | * |
| 3414 | - * @return HTML Object |
|
| 3419 | + * @return DBField Object |
|
| 3415 | 3420 | **/ |
| 3416 | 3421 | public function ConvertToHTML() |
| 3417 | 3422 | { |
@@ -3475,7 +3480,7 @@ discard block |
||
| 3475 | 3480 | * In templates, it is used like this: |
| 3476 | 3481 | * $EcommerceConfigAjax.TableID. |
| 3477 | 3482 | * |
| 3478 | - * @return EcommerceConfigAjax |
|
| 3483 | + * @return EcommerceConfigAjaxDefinitions |
|
| 3479 | 3484 | **/ |
| 3480 | 3485 | public function AJAXDefinitions() |
| 3481 | 3486 | { |
@@ -24,7 +24,7 @@ discard block |
||
| 24 | 24 | * |
| 25 | 25 | * @see Order::doNextStatus |
| 26 | 26 | * |
| 27 | - * @param Order object |
|
| 27 | + * @param Order Order |
|
| 28 | 28 | * |
| 29 | 29 | * @return bool - true if the current step is ready to be run... |
| 30 | 30 | **/ |
@@ -41,7 +41,7 @@ discard block |
||
| 41 | 41 | * |
| 42 | 42 | * @see Order::doNextStatus |
| 43 | 43 | * |
| 44 | - * @param Order object |
|
| 44 | + * @param Order Order |
|
| 45 | 45 | * |
| 46 | 46 | * @return bool - true if run correctly. |
| 47 | 47 | **/ |