sunnysideup / silverstripe-ecommerce

code/model/extensions/EcommerceSiteTreeExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -330,7 +330,7 @@
      * In templates, it is used like this:
      * $EcommerceConfigAjax.TableID.
      *
-     * @return EcommerceConfigAjax
+     * @return EcommerceConfigAjaxDefinitions
      **/
     public function AJAXDefinitions()
     {

code/model/process/OrderSteps/OrderStep_Archived.php

Doc Comments +2 added lines, -2 removed lines

@@ -26,7 +26,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -43,7 +43,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if run correctly.
      **/

code/model/process/OrderSteps/OrderStep_Created.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/

code/search/filters/EcommercePaymentFilters.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
 class OrderEmailRecordFilters_MultiOptionsetStatusIDFilter extends ExactMatchFilter
 {
     /**
-     *@return SQLQuery
+     *@return DataQuery
      **/
     public function apply(DataQuery $query)
     {

code/model/process/OrderProcessQueue.php

Doc Comments +1 added lines, -1 removed lines

@@ -151,7 +151,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)
     {

code/api/ShoppingCart.php

Doc Comments +15 added lines, -13 removed lines

@@ -279,8 +279,8 @@ 
      * Adds any number of items to the cart.
      * Returns the order item on succes OR false on failure.
      *
-     * @param DataObject $buyable    - the buyable (generally a product) being added to the cart
-     * @param float      $quantity   - number of items add.
+     * @param BuyableModel $buyable    - the buyable (generally a product) being added to the cart
+     * @param integer      $quantity   - number of items add.
      * @param mixed      $parameters - array of parameters to target a specific order item. eg: group=1, length=5
      *                                 if you make it a form, it will save the form into the orderitem
      *
@@ -322,7 +322,7 @@ 
     /**
      * Sets quantity for an item in the cart.
      *
-     * @param DataObject $buyable    - the buyable (generally a product) being added to the cart
+     * @param BuyableModel $buyable    - the buyable (generally a product) being added to the cart
      * @param float      $quantity   - number of items add.
      * @param array      $parameters - array of parameters to target a specific order item. eg: group=1, length=5
      *
@@ -348,8 +348,8 @@ 
     /**
      * Removes any number of items from the cart.
      *
-     * @param DataObject $buyable    - the buyable (generally a product) being added to the cart
-     * @param float      $quantity   - number of items add.
+     * @param BuyableModel $buyable    - the buyable (generally a product) being added to the cart
+     * @param integer      $quantity   - number of items add.
      * @param array      $parameters - array of parameters to target a specific order item. eg: group=1, length=5
      *
      * @return false | DataObject (OrderItem)
@@ -382,7 +382,7 @@ 
     /**
      * Delete item from the cart.
      *
-     * @param OrderItem $buyable    - the buyable (generally a product) being added to the cart
+     * @param BuyableModel $buyable    - the buyable (generally a product) being added to the cart
      * @param array     $parameters - array of parameters to target a specific order item. eg: group=1, length=5
      *
      * @return bool | item - successfully removed
@@ -407,9 +407,8 @@ 
     /**
      * Checks and prepares variables for a quantity change (add, edit, remove) for an Order Item.
      *
-     * @param DataObject    $buyable             - the buyable (generally a product) being added to the cart
-     * @param float         $quantity            - number of items add.
-     * @param bool          $mustBeExistingItems - if false, the Order Item gets created if it does not exist - if TRUE the order item is searched for and an error shows if there is no Order item.
+     * @param BuyableModel    $buyable             - the buyable (generally a product) being added to the cart
+     * @param bool          $mustBeExistingItem - if false, the Order Item gets created if it does not exist - if TRUE the order item is searched for and an error shows if there is no Order item.
      * @param array | Form  $parameters          - array of parameters to target a specific order item. eg: group=1, length=5*
      *                                           - form saved into item...
      *
@@ -477,7 +476,7 @@ 
      * we do not need things like "canPurchase" here, because that is with the "addBuyable" method.
      * NOTE: does not write!
      *
-     * @param DataObject $buyable
+     * @param BuyableModel $buyable
      * @param array      $parameters
      *
      * @return OrderItem
@@ -617,6 +616,7 @@ 
      * Removes a modifier from the cart.
      *
      * @param Int/ OrderModifier
+     * @param integer $modifier
      *
      * @return bool
      */
@@ -683,6 +683,7 @@ 
      * NOTE: tried to copy part to the Order Class - but that was not much of a go-er.
      *
      * @param int | Order $order
+     * @param DataObject $oldOrder
      *
      * @return Order | false
      **/
@@ -759,6 +760,7 @@ 
      * sets region in order so that modifiers can be recalculated, etc...
      *
      * @param int | String - $regionID you can use the ID or the code.
+     * @param integer $regionID
      *
      * @return bool
      **/
@@ -901,7 +903,7 @@ 
     /**
      * Stores a message that can later be returned via ajax or to $form->sessionMessage();.
      *
-     * @param $message - the message, which could be a notification of successful action, or reason for failure
+     * @param string $message - the message, which could be a notification of successful action, or reason for failure
      * @param $type - please use good, bad, warning
      */
     public function addMessage($message, $status = 'good')
@@ -927,7 +929,7 @@ 
     /**
      * Gets an existing order item based on buyable and passed parameters.
      *
-     * @param DataObject $buyable
+     * @param BuyableModel $buyable
      * @param array      $parameters
      *
      * @return OrderItem | null
@@ -953,7 +955,7 @@ 
     /**
      * Removes parameters that aren't in the default array, merges with default parameters, and converts raw2SQL.
      *
-     * @param array $parameters
+     * @param array $params
      *
      * @return cleaned array
      */

code/CartPage.php

Doc Comments +7 added lines, -2 removed lines

@@ -215,6 +215,7 @@ 
      * Returns the "new order" link.
      *
      * @param int | String $orderID - not used in CartPage
+     * @param integer $orderID
      *
      * @return string (URLSegment)
      */
@@ -240,7 +241,7 @@ 
      *
      * @param int|string $orderID ID of the order
      *
-     * @return int | String (URLSegment)
+     * @return string | String (URLSegment)
      */
     public static function get_order_link($orderID)
     {
@@ -382,6 +383,10 @@ 
      * @todo: check if we need this....!
      **/
     private $message = '';
+
+    /**
+     * @param string $s
+     */
     public static function set_message($s)
     {
         $sessionCode = EcommerceConfig::get('CartPage_Controller', 'session_code');
@@ -651,7 +656,7 @@ 
     }
 
     /**
-     * @return string
+     * @return DBField
      **/
     public function Message()
     {