sunnysideup / silverstripe-ecommerce

code/model/money/EcommercePayment.php

Doc Comments +3 added lines, -1 removed lines

@@ -81,7 +81,7 @@ 
      * CRUCIAL
      * makes sure all the relevant payment methods are available ...
      *
-     * @return this | EcommercePayment
+     * @return EcommercePayment | EcommercePayment
      */
     public function init()
     {
@@ -399,6 +399,7 @@ 
      * Return the form requirements for all the payment methods.
      *
      * @param null | Array
+     * @param Order $order
      *
      * @return An array suitable for passing to CustomRequiredFields
      */
@@ -414,6 +415,7 @@ 
      *
      * @param string       $amount formatted amount (e.g. 12.30) without the currency
      * @param null | Order $order
+     * @param Order $order
      *
      * @return FieldList
      */

code/model/Order.php

Doc Comments +18 added lines, -13 removed lines

@@ -192,7 +192,7 @@ 
      * @param bool (optional) $b
      * @param int (optional)  $orderID
      *
-     * @return bool
+     * @return boolean|null
      */
     public static function set_needs_recalculating($b = true, $orderID = 0)
     {
@@ -264,7 +264,7 @@ 
     /**
      * This function returns the OrderSteps.
      *
-     * @return ArrayList (OrderSteps)
+     * @return DataList (OrderSteps)
      **/
     public static function get_order_status_options()
     {
@@ -453,6 +453,7 @@ 
      * link to edit the record.
      *
      * @param string | Null $action - e.g. edit
+     * @param string $action
      *
      * @return string
      */
@@ -1159,7 +1160,7 @@ 
      * @param Member $member - the user cancelling the order
      * @param string $reason - the reason the order is cancelled
      *
-     * @return OrderStatusLog_Cancel
+     * @return integer
      */
     public function Cancel(Member $member, $reason = '')
     {
@@ -1594,7 +1595,7 @@ 
      * Stores the preferred currency of the order.
      * IMPORTANTLY we store the exchange rate for future reference...
      *
-     * @param EcommerceCurrency $currency
+     * @param EcommerceCurrency $newCurrency
      */
     public function UpdateCurrency($newCurrency)
     {
@@ -1690,9 +1691,9 @@ 
      *
      * @param string        $emailClassName     - the class name of the email you wish to send
      * @param string        $subject            - email subject
-     * @param bool          $copyToAdmin        - true by default, whether it should send a copy to the admin
      * @param bool          $resend             - sends the email even it has been sent before.
      * @param bool | string $adminOnlyOrToEmail - sends the email to the ADMIN ONLY, if you provide an email, it will go to the email...
+     * @param string $message
      *
      * @return bool TRUE for success, FALSE for failure (not tested)
      */
@@ -1811,7 +1812,7 @@ 
      * @param string $message        - the additional message
      * @param string $emailClassName - template to use.
      *
-     * @return array (Message, Order, EmailLogo, ShopPhysicalAddress)
+     * @return string (Message, Order, EmailLogo, ShopPhysicalAddress)
      */
     public function renderOrderInEmailFormat($message = '', $emailClassName)
     {
@@ -2054,7 +2055,7 @@ 
      * @param string|array $excluded               - Class(es) of modifier(s) to ignore in the calculation.
      * @param bool         $stopAtExcludedModifier - when this flag is TRUE, we stop adding the modifiers when we reach an excluded modifier.
      *
-     * @return float
+     * @return integer
      */
     public function ModifiersSubTotal($excluded = null, $stopAtExcludedModifier = false)
     {
@@ -2252,7 +2253,7 @@ 
      *
      * @param Member (optional) $member
      *
-     * @return bool
+     * @return boolean|null
      **/
     public function canViewAdminStuff($member = null)
     {
@@ -2305,7 +2306,7 @@ 
      * If any of them need immediate attention then this is done
      * first after which it will go through to the checkout page.
      *
-     * @param Member (optional) $member
+     * @param Member Member $member
      *
      * @return bool
      **/
@@ -2651,6 +2652,10 @@ 
     {
         return $this->getTitle($dateFormat, $includeName);
     }
+
+    /**
+     * @param string $dateFormat
+     */
     public function getTitle($dateFormat = null, $includeName = false)
     {
         if ($this->exists()) {
@@ -2714,7 +2719,7 @@ 
     /**
      * Returns the subtotal of the items for this order.
      *
-     * @return float
+     * @return integer
      */
     public function SubTotal()
     {
@@ -2780,7 +2785,7 @@ 
     /**
      * Returns the total cost of an order including the additional charges or deductions of its modifiers.
      *
-     * @return float
+     * @return integer
      */
     public function Total()
     {
@@ -3410,7 +3415,7 @@ 
     /**
      * Converts the Order into HTML, based on the Order Template.
      *
-     * @return HTML Object
+     * @return DBField Object
      **/
     public function ConvertToHTML()
     {
@@ -3474,7 +3479,7 @@ 
      * In templates, it is used like this:
      * $EcommerceConfigAjax.TableID.
      *
-     * @return EcommerceConfigAjax
+     * @return EcommerceConfigAjaxDefinitions
      **/
     public function AJAXDefinitions()
     {

code/model/process/OrderProcessQueue.php

Doc Comments +1 added lines, -2 removed lines

@@ -150,7 +150,7 @@ 
      * If the order already exists, it will update the seconds and the creation  time.
      *
      * @param Order $order          [description]
-     * @param Int   $deferInSeconds [description]
+     * @param Int   $deferTimeInSeconds [description]
      */
     public function AddOrderToQueue($order, $deferTimeInSeconds)
     {
@@ -222,7 +222,6 @@ 
 
     /**
      * META METHOD: returns a list of orders to be processed
-     * @param int $limit total number of orders that can be retrieved at any one time
      * @return DataList (of orders)
      */
     public function OrdersToBeProcessed()

code/model/process/OrderStep.php

Doc Comments +6 added lines, -5 removed lines

@@ -594,7 +594,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -613,7 +613,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if run correctly.
      **/
@@ -655,6 +655,7 @@ 
      *
      * @param string $code:       the name of the step to check
      * @param bool   $orIsEqualTo if set to true, this method will return TRUE if the step being checked is the current one
+     * @param string $code
      *
      * @return bool
      **/
@@ -902,7 +903,7 @@ 
     /**
      * Formatted answer for "hasCustomerMessage".
      *
-     * @return string
+     * @return DBField
      */
     public function ShowAsSummary()
     {
@@ -912,7 +913,7 @@ 
     /**
      *
      *
-     * @return string
+     * @return DBField
      */
     public function getShowAsSummary()
     {
@@ -972,7 +973,7 @@ 
     /**
      * Formatted answer for "hasCustomerMessage".
      *
-     * @return string
+     * @return DBField
      */
     public function NameAndDescription()
     {

code/model/process/OrderSteps/OrderStep_SentInvoice.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
       * NOTE: must have a payment (even if it is a fake payment).
       * The reason for this is if people pay straight away then they want to see the payment shown on their invoice.
       *
-      * @param Order object
+      * @param Order Order
       *
       * @return bool - true if the current step is ready to be run...
       **/

code/ProductGroup.php

Doc Comments +6 added lines, -7 removed lines

@@ -372,7 +372,7 @@ 
      * by either type (e.g. FILER) or variable (e.g dbFieldName)
      * or both.
      *
-     * @param string $typeOfVariableName FILTER | SORT | DISPLAY or sessionName, getVariable, etc...
+     * @param string $typeOrVariable FILTER | SORT | DISPLAY or sessionName, getVariable, etc...
      * @param string $variable:          sessionName, getVariable, etc...
      *
      * @return array | String
@@ -1528,9 +1528,8 @@ 
 
     /**
      *
-     * @param string $name
-     * @param string $filterKey
      *
+     * @param string $cacheKey
      * @return string
      */
     public function cacheKey($cacheKey)
@@ -1827,7 +1826,7 @@ 
      * This is the call that is made from the template...
      * The actual final products being shown.
      *
-     * @return PaginatedList
+     * @return DataList
      **/
     public function Products()
     {
@@ -2151,7 +2150,7 @@ 
      *
      * This is different from IsSearchResults.
      *
-     * @return bool
+     * @return boolean|null
      */
     public function ActiveSearchTerm()
     {
@@ -2217,7 +2216,7 @@ 
      * Is there a special sort operating at the moment?
      * Is the current sort the default one (return inverse!)?
      *
-     * @return bool
+     * @return boolean|null
      */
     public function HasSort()
     {
@@ -2599,7 +2598,7 @@ 
      *
      * @param SS_List
      *
-     * @return PaginatedList
+     * @return ProductGroup_Controller|null
      */
     protected function paginateList(SS_List $list)
     {

code/tasks/EcommerceTaskTryToFinaliseOrders.php

Doc Comments +4 added lines

@@ -92,6 +92,10 @@
         $this->doNotSendEmails = false;
     }
 
+    /**
+     * @param integer|null $limit
+     * @param integer|null $startAt
+     */
     protected function tryToFinaliseOrders($orders, $limit, $startAt)
     {
         $orders = $orders->limit($limit, $startAt);