sunnysideup / silverstripe-ecommerce

code/model/Order.php

Doc Comments +17 added lines, -12 removed lines

@@ -196,7 +196,7 @@ 
      * @param bool (optional) $b
      * @param int (optional)  $orderID
      *
-     * @return bool
+     * @return boolean|null
      */
     public static function set_needs_recalculating($b = true, $orderID = 0)
     {
@@ -268,7 +268,7 @@ 
     /**
      * This function returns the OrderSteps.
      *
-     * @return ArrayList (OrderSteps)
+     * @return DataList (OrderSteps)
      **/
     public static function get_order_status_options()
     {
@@ -467,6 +467,7 @@ 
      * link to edit the record.
      *
      * @param string | Null $action - e.g. edit
+     * @param string $action
      *
      * @return string
      */
@@ -1410,7 +1411,7 @@ 
      * Has the order been paid?
      * TODO: why do we check if there is a total at all?
      *
-     * @return Boolean (object)
+     * @return DBField (object)
      */
     public function IsPaidNice()
     {
@@ -1665,7 +1666,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)
     {
@@ -2126,7 +2127,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)
     {
@@ -2324,7 +2325,7 @@ 
      *
      * @param Member (optional) $member
      *
-     * @return bool
+     * @return boolean|null
      **/
     public function canViewAdminStuff($member = null)
     {
@@ -2377,7 +2378,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
      **/
@@ -2744,6 +2745,10 @@ 
     {
         return $this->getTitle($dateFormat, $includeName);
     }
+
+    /**
+     * @param string $dateFormat
+     */
     public function getTitle($dateFormat = null, $includeName = false)
     {
         if ($this->exists()) {
@@ -2807,7 +2812,7 @@ 
     /**
      * Returns the subtotal of the items for this order.
      *
-     * @return float
+     * @return integer
      */
     public function SubTotal()
     {
@@ -2873,7 +2878,7 @@ 
     /**
      * Returns the total cost of an order including the additional charges or deductions of its modifiers.
      *
-     * @return float
+     * @return integer
      */
     public function Total()
     {
@@ -3338,7 +3343,7 @@ 
     /**
      * Submission Log for this Order (if any).
      *
-     * @return DateTime
+     * @return DBField
      **/
     public function OrderDate()
     {
@@ -3520,7 +3525,7 @@ 
     /**
      * Converts the Order into HTML, based on the Order Template.
      *
-     * @return HTML Object
+     * @return DBField Object
      **/
     public function ConvertToHTML()
     {
@@ -3584,7 +3589,7 @@ 
      * In templates, it is used like this:
      * $EcommerceConfigAjax.TableID.
      *
-     * @return EcommerceConfigAjax
+     * @return EcommerceConfigAjaxDefinitions
      **/
     public function AJAXDefinitions()
     {

code/api/ShoppingCart.php

Doc Comments +18 added lines, -17 removed lines

@@ -350,8 +350,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
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
@@ -398,7 +398,7 @@ 
      *
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
      *
-     * @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
      *
@@ -428,8 +428,8 @@ 
      *
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
      *
-     * @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 | OrderItem | null
@@ -467,7 +467,7 @@ 
      *
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
      *
-     * @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 | null - successfully removed
@@ -494,9 +494,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...
      *
@@ -564,7 +563,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
@@ -626,7 +625,7 @@ 
     /**
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
      *
-     * @return bool | null
+     * @return boolean|null | null
      */
     public function save()
     {
@@ -690,7 +689,7 @@ 
      *
      * @param OrderModifier $modifier
      *
-     * @return bool | null
+     * @return boolean|null | null
      */
     public function removeModifier(OrderModifier $modifier)
     {
@@ -722,8 +721,9 @@ 
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
      *
      * @param Int/ OrderModifier
+     * @param integer $modifier
      *
-     * @return bool
+     * @return boolean|null
      */
     public function addModifier($modifier)
     {
@@ -857,7 +857,7 @@ 
      *
      * @param string - $countryCode
      *
-     * @return bool
+     * @return boolean|null
      **/
     public function setCountry($countryCode)
     {
@@ -879,6 +879,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
      **/
@@ -1021,7 +1022,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')
@@ -1047,7 +1048,7 @@ 
     /**
      * Gets an existing order item based on buyable and passed parameters.
      *
-     * @param DataObject $buyable
+     * @param BuyableModel $buyable
      * @param array      $parameters
      *
      * @return OrderItem | null
@@ -1073,7 +1074,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
      */