@@ -81,7 +81,7 @@ discard block |
||
81 | 81 | * CRUCIAL |
82 | 82 | * makes sure all the relevant payment methods are available ... |
83 | 83 | * |
84 | - * @return this | EcommercePayment |
|
84 | + * @return EcommercePayment | EcommercePayment |
|
85 | 85 | */ |
86 | 86 | public function init() |
87 | 87 | { |
@@ -399,6 +399,7 @@ discard block |
||
399 | 399 | * Return the form requirements for all the payment methods. |
400 | 400 | * |
401 | 401 | * @param null | Array |
402 | + * @param Order $order |
|
402 | 403 | * |
403 | 404 | * @return An array suitable for passing to CustomRequiredFields |
404 | 405 | */ |
@@ -414,6 +415,7 @@ discard block |
||
414 | 415 | * |
415 | 416 | * @param string $amount formatted amount (e.g. 12.30) without the currency |
416 | 417 | * @param null | Order $order |
418 | + * @param Order $order |
|
417 | 419 | * |
418 | 420 | * @return FieldList |
419 | 421 | */ |
@@ -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 | { |
@@ -1690,9 +1691,9 @@ discard block |
||
1690 | 1691 | * |
1691 | 1692 | * @param string $emailClassName - the class name of the email you wish to send |
1692 | 1693 | * @param string $subject - email subject |
1693 | - * @param bool $copyToAdmin - true by default, whether it should send a copy to the admin |
|
1694 | 1694 | * @param bool $resend - sends the email even it has been sent before. |
1695 | 1695 | * @param bool | string $adminOnlyOrToEmail - sends the email to the ADMIN ONLY, if you provide an email, it will go to the email... |
1696 | + * @param string $message |
|
1696 | 1697 | * |
1697 | 1698 | * @return bool TRUE for success, FALSE for failure (not tested) |
1698 | 1699 | */ |
@@ -1811,7 +1812,7 @@ discard block |
||
1811 | 1812 | * @param string $message - the additional message |
1812 | 1813 | * @param string $emailClassName - template to use. |
1813 | 1814 | * |
1814 | - * @return array (Message, Order, EmailLogo, ShopPhysicalAddress) |
|
1815 | + * @return string (Message, Order, EmailLogo, ShopPhysicalAddress) |
|
1815 | 1816 | */ |
1816 | 1817 | public function renderOrderInEmailFormat($message = '', $emailClassName) |
1817 | 1818 | { |
@@ -2054,7 +2055,7 @@ discard block |
||
2054 | 2055 | * @param string|array $excluded - Class(es) of modifier(s) to ignore in the calculation. |
2055 | 2056 | * @param bool $stopAtExcludedModifier - when this flag is TRUE, we stop adding the modifiers when we reach an excluded modifier. |
2056 | 2057 | * |
2057 | - * @return float |
|
2058 | + * @return integer |
|
2058 | 2059 | */ |
2059 | 2060 | public function ModifiersSubTotal($excluded = null, $stopAtExcludedModifier = false) |
2060 | 2061 | { |
@@ -2252,7 +2253,7 @@ discard block |
||
2252 | 2253 | * |
2253 | 2254 | * @param Member (optional) $member |
2254 | 2255 | * |
2255 | - * @return bool |
|
2256 | + * @return boolean|null |
|
2256 | 2257 | **/ |
2257 | 2258 | public function canViewAdminStuff($member = null) |
2258 | 2259 | { |
@@ -2305,7 +2306,7 @@ discard block |
||
2305 | 2306 | * If any of them need immediate attention then this is done |
2306 | 2307 | * first after which it will go through to the checkout page. |
2307 | 2308 | * |
2308 | - * @param Member (optional) $member |
|
2309 | + * @param Member Member $member |
|
2309 | 2310 | * |
2310 | 2311 | * @return bool |
2311 | 2312 | **/ |
@@ -2651,6 +2652,10 @@ discard block |
||
2651 | 2652 | { |
2652 | 2653 | return $this->getTitle($dateFormat, $includeName); |
2653 | 2654 | } |
2655 | + |
|
2656 | + /** |
|
2657 | + * @param string $dateFormat |
|
2658 | + */ |
|
2654 | 2659 | public function getTitle($dateFormat = null, $includeName = false) |
2655 | 2660 | { |
2656 | 2661 | if ($this->exists()) { |
@@ -2714,7 +2719,7 @@ discard block |
||
2714 | 2719 | /** |
2715 | 2720 | * Returns the subtotal of the items for this order. |
2716 | 2721 | * |
2717 | - * @return float |
|
2722 | + * @return integer |
|
2718 | 2723 | */ |
2719 | 2724 | public function SubTotal() |
2720 | 2725 | { |
@@ -2780,7 +2785,7 @@ discard block |
||
2780 | 2785 | /** |
2781 | 2786 | * Returns the total cost of an order including the additional charges or deductions of its modifiers. |
2782 | 2787 | * |
2783 | - * @return float |
|
2788 | + * @return integer |
|
2784 | 2789 | */ |
2785 | 2790 | public function Total() |
2786 | 2791 | { |
@@ -3410,7 +3415,7 @@ discard block |
||
3410 | 3415 | /** |
3411 | 3416 | * Converts the Order into HTML, based on the Order Template. |
3412 | 3417 | * |
3413 | - * @return HTML Object |
|
3418 | + * @return DBField Object |
|
3414 | 3419 | **/ |
3415 | 3420 | public function ConvertToHTML() |
3416 | 3421 | { |
@@ -3474,7 +3479,7 @@ discard block |
||
3474 | 3479 | * In templates, it is used like this: |
3475 | 3480 | * $EcommerceConfigAjax.TableID. |
3476 | 3481 | * |
3477 | - * @return EcommerceConfigAjax |
|
3482 | + * @return EcommerceConfigAjaxDefinitions |
|
3478 | 3483 | **/ |
3479 | 3484 | public function AJAXDefinitions() |
3480 | 3485 | { |
@@ -150,7 +150,7 @@ discard block |
||
150 | 150 | * If the order already exists, it will update the seconds and the creation time. |
151 | 151 | * |
152 | 152 | * @param Order $order [description] |
153 | - * @param Int $deferInSeconds [description] |
|
153 | + * @param Int $deferTimeInSeconds [description] |
|
154 | 154 | */ |
155 | 155 | public function AddOrderToQueue($order, $deferTimeInSeconds) |
156 | 156 | { |
@@ -222,7 +222,6 @@ discard block |
||
222 | 222 | |
223 | 223 | /** |
224 | 224 | * META METHOD: returns a list of orders to be processed |
225 | - * @param int $limit total number of orders that can be retrieved at any one time |
|
226 | 225 | * @return DataList (of orders) |
227 | 226 | */ |
228 | 227 | public function OrdersToBeProcessed() |
@@ -594,7 +594,7 @@ discard block |
||
594 | 594 | * |
595 | 595 | * @see Order::doNextStatus |
596 | 596 | * |
597 | - * @param Order object |
|
597 | + * @param Order Order |
|
598 | 598 | * |
599 | 599 | * @return bool - true if the current step is ready to be run... |
600 | 600 | **/ |
@@ -613,7 +613,7 @@ discard block |
||
613 | 613 | * |
614 | 614 | * @see Order::doNextStatus |
615 | 615 | * |
616 | - * @param Order object |
|
616 | + * @param Order Order |
|
617 | 617 | * |
618 | 618 | * @return bool - true if run correctly. |
619 | 619 | **/ |
@@ -655,6 +655,7 @@ discard block |
||
655 | 655 | * |
656 | 656 | * @param string $code: the name of the step to check |
657 | 657 | * @param bool $orIsEqualTo if set to true, this method will return TRUE if the step being checked is the current one |
658 | + * @param string $code |
|
658 | 659 | * |
659 | 660 | * @return bool |
660 | 661 | **/ |
@@ -902,7 +903,7 @@ discard block |
||
902 | 903 | /** |
903 | 904 | * Formatted answer for "hasCustomerMessage". |
904 | 905 | * |
905 | - * @return string |
|
906 | + * @return DBField |
|
906 | 907 | */ |
907 | 908 | public function ShowAsSummary() |
908 | 909 | { |
@@ -912,7 +913,7 @@ discard block |
||
912 | 913 | /** |
913 | 914 | * |
914 | 915 | * |
915 | - * @return string |
|
916 | + * @return DBField |
|
916 | 917 | */ |
917 | 918 | public function getShowAsSummary() |
918 | 919 | { |
@@ -972,7 +973,7 @@ discard block |
||
972 | 973 | /** |
973 | 974 | * Formatted answer for "hasCustomerMessage". |
974 | 975 | * |
975 | - * @return string |
|
976 | + * @return DBField |
|
976 | 977 | */ |
977 | 978 | public function NameAndDescription() |
978 | 979 | { |
@@ -41,7 +41,7 @@ |
||
41 | 41 | * NOTE: must have a payment (even if it is a fake payment). |
42 | 42 | * The reason for this is if people pay straight away then they want to see the payment shown on their invoice. |
43 | 43 | * |
44 | - * @param Order object |
|
44 | + * @param Order Order |
|
45 | 45 | * |
46 | 46 | * @return bool - true if the current step is ready to be run... |
47 | 47 | **/ |
@@ -372,7 +372,7 @@ discard block |
||
372 | 372 | * by either type (e.g. FILER) or variable (e.g dbFieldName) |
373 | 373 | * or both. |
374 | 374 | * |
375 | - * @param string $typeOfVariableName FILTER | SORT | DISPLAY or sessionName, getVariable, etc... |
|
375 | + * @param string $typeOrVariable FILTER | SORT | DISPLAY or sessionName, getVariable, etc... |
|
376 | 376 | * @param string $variable: sessionName, getVariable, etc... |
377 | 377 | * |
378 | 378 | * @return array | String |
@@ -1528,9 +1528,8 @@ discard block |
||
1528 | 1528 | |
1529 | 1529 | /** |
1530 | 1530 | * |
1531 | - * @param string $name |
|
1532 | - * @param string $filterKey |
|
1533 | 1531 | * |
1532 | + * @param string $cacheKey |
|
1534 | 1533 | * @return string |
1535 | 1534 | */ |
1536 | 1535 | public function cacheKey($cacheKey) |
@@ -1827,7 +1826,7 @@ discard block |
||
1827 | 1826 | * This is the call that is made from the template... |
1828 | 1827 | * The actual final products being shown. |
1829 | 1828 | * |
1830 | - * @return PaginatedList |
|
1829 | + * @return DataList |
|
1831 | 1830 | **/ |
1832 | 1831 | public function Products() |
1833 | 1832 | { |
@@ -2151,7 +2150,7 @@ discard block |
||
2151 | 2150 | * |
2152 | 2151 | * This is different from IsSearchResults. |
2153 | 2152 | * |
2154 | - * @return bool |
|
2153 | + * @return boolean|null |
|
2155 | 2154 | */ |
2156 | 2155 | public function ActiveSearchTerm() |
2157 | 2156 | { |
@@ -2217,7 +2216,7 @@ discard block |
||
2217 | 2216 | * Is there a special sort operating at the moment? |
2218 | 2217 | * Is the current sort the default one (return inverse!)? |
2219 | 2218 | * |
2220 | - * @return bool |
|
2219 | + * @return boolean|null |
|
2221 | 2220 | */ |
2222 | 2221 | public function HasSort() |
2223 | 2222 | { |
@@ -2599,7 +2598,7 @@ discard block |
||
2599 | 2598 | * |
2600 | 2599 | * @param SS_List |
2601 | 2600 | * |
2602 | - * @return PaginatedList |
|
2601 | + * @return ProductGroup_Controller|null |
|
2603 | 2602 | */ |
2604 | 2603 | protected function paginateList(SS_List $list) |
2605 | 2604 | { |
@@ -92,6 +92,10 @@ |
||
92 | 92 | $this->doNotSendEmails = false; |
93 | 93 | } |
94 | 94 | |
95 | + /** |
|
96 | + * @param integer|null $limit |
|
97 | + * @param integer|null $startAt |
|
98 | + */ |
|
95 | 99 | protected function tryToFinaliseOrders($orders, $limit, $startAt) |
96 | 100 | { |
97 | 101 | $orders = $orders->limit($limit, $startAt); |