sunnysideup / silverstripe-ecommerce

code/model/process/OrderProcessQueue.php

Doc Comments +4 added lines, -5 removed lines

@@ -152,7 +152,7 @@ 
      * META METHOD: Add an order to the job list if it does not exist already.
      *
      * @param Order $order
-     * @param Int   $deferInSeconds
+     * @param Int   $deferTimeInSeconds
      */
     public function AddOrderToQueue($order, $deferTimeInSeconds)
     {
@@ -184,7 +184,7 @@ 
      *
      *
      * @param  Order $order optional
-     * @return boolean | string
+     * @return boolean|string | string
      */
     public function process($order = null)
     {
@@ -244,7 +244,7 @@ 
      *
      * @param  Order $order
      *
-     * @return null |   OrderProcessQueue
+     * @return DataObject |   OrderProcessQueue
      */
     public function getQueueObject($order)
     {
@@ -301,7 +301,6 @@ 
 
     /**
      * META METHOD: all orders with a queue object
-     * @param int $id force this Order to be processed
      * @param int $limit total number of orders that can be retrieved at any one time
      *
      * @return DataList (of orders)
@@ -467,7 +466,7 @@ 
 
     /**
      * sort phrase for orders, based in order IDs...
-     * @param  array $orderIds
+     * @param  array $orderIDs
      * @return string
      */
     protected function sortPhraseForOrderIDs($orderIDs)

code/tasks/EcommerceTaskArchiveAllOrdersWithItems.php

Doc Comments +5 added lines

@@ -100,6 +100,11 @@
         }
     }
 
+    /**
+     * @param DataObject $lastOrderStep
+     * @param string $orderStatusLogClassName
+     * @param integer $offset
+     */
     public function getOrdersForCreateSubmissionLogForArchivedOrders($lastOrderStep, $orderStatusLogClassName, $offset)
     {
         return Order::get()

code/CartPage.php

Doc Comments +8 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)
      */
@@ -227,6 +228,7 @@ 
      * Returns the "copy order" link.
      *
      * @param int | String $orderID - not used in CartPage
+     * @param integer $orderID
      *
      * @return string (URLSegment)
      */
@@ -240,7 +242,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 +384,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');
@@ -703,7 +709,7 @@ 
 
 
     /**
-     * @return string
+     * @return DBField
      **/
     public function Message()
     {

code/model/OrderItem.php

Doc Comments +2 added lines, -2 removed lines

@@ -300,7 +300,7 @@ 
      * standard SS method.
      *
      * @param BuyableModel $buyable
-     * @param float        $quantity
+     * @param integer        $quantity
      *
      * @return FieldList
      **/
@@ -580,7 +580,7 @@ 
     }
 
     /**
-     * @return Field (EcomQuantityField)
+     * @return EcomQuantityField (EcomQuantityField)
      **/
     public function QuantityField()
     {

code/forms/ProductSearchForm.php

Doc Comments +2 added lines, -2 removed lines

@@ -495,7 +495,7 @@ 
      * can be executed one after the other, each
      * being less specific than the last...
      *
-     * @return array
+     * @return boolean
      */
     protected function addToResults($listToAdd)
     {
@@ -518,8 +518,8 @@ 
      * can be executed one after the other, each
      * being less specific than the last...
      *
-     * @param array $words  - words being search
      * @param array $fields - fields being searched
+     * @param string $keywordPhrase
      *
      * @return array
      */

code/tasks/EcommerceTaskTryToFinaliseOrders.php

Doc Comments +4 added lines

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