sunnysideup / silverstripe-ecommerce

code/api/ShoppingCart.php

Doc Comments +14 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
      */
@@ -759,6 +759,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 +902,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 +928,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 +954,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 +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');
@@ -648,7 +654,7 @@ 
     }
 
     /**
-     * @return string
+     * @return DBField
      **/
     public function Message()
     {

code/CheckoutPage.php

Doc Comments +2 added lines, -1 removed lines

@@ -162,6 +162,7 @@ 
      *
      * @param string - $currentStep       is the step that has just been actioned....
      * @param bool -   $doPreviousInstead - return previous rather than next step
+     * @param string $currentStep
      *
      * @return string (URLSegment)
      */
@@ -688,7 +689,7 @@ 
     /**
      * returns the percentage of steps done (0 - 100).
      *
-     * @return int
+     * @return double
      */
     public function PercentageDone()
     {

code/cms/dev/EcommerceDatabaseAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -333,7 +333,7 @@
     }
 
     /**
-     * @return array ????
+     * @return string ????
      */
     public function AllTests()
     {

code/cms/dev/EcommerceDevelopmentAdminDecorator.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
      *
      * @param SS_HTTPRequest
      *
-     * @return HTML
+     * @return EcommerceDatabaseAdmin
      **/
     public function ecommerce(SS_HTTPRequest $request)
     {

code/config/EcommerceConfigDefinitions.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
     /**
      * Tells us the version of e-commerce in use.
      *
-     * @return int
+     * @return double
      */
     public function Version()
     {

code/control/CartResponse.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,11 +47,11 @@
     /**
      * Builds json object to be returned via ajax.
      *
-     * @param array  $message        (Type, Message)
+     * @param array  $messages        (Type, Message)
      * @param array  $additionalData
      * @param string $status
      *
-     * @return HEADER + JSON
+     * @return string + JSON
      **/
     public function ReturnCartData(array $messages = array(), array $additionalData = null, $status = 'success')
     {

code/control/EcommerceResponse.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
 {
     /**
      * @param string       $status  the status to return
-     * @param string       $message the message to return with the retur
+     * @param string       $messages the message to return with the retur
      * @param null | Array $data,   that should be included
      */
     public function ReturnCartData(array $messages = array(), array $additionalData = null, $status = 'success')

code/control/OrderEmailRecord_Review.php

Doc Comments +3 added lines

@@ -7,6 +7,9 @@
         'read' => 'ShopAdmin',
     );
 
+    /**
+     * @param OrderEmailRecord $email
+     */
     public static function review_link($email)
     {
         return Config::inst()->get('OrderEmailRecord_Review', 'url_segment').'/read/'.$email->ID;