sunnysideup / silverstripe-ecommerce

code/forms/ProductSearchForm.php

Doc Comments +2 added lines, -3 removed lines

@@ -489,7 +489,7 @@ 
      * can be executed one after the other, each
      * being less specific than the last...
      *
-     * @return array
+     * @return boolean
      */
     private function addToResults($listToAdd)
     {
@@ -512,8 +512,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
      */
@@ -553,7 +553,6 @@ 
     /**
      * saves the form into session.
      *
-     * @param array $data - data from form.
      */
     public function saveDataToSession()
     {

code/interfaces/EcommercePaymentSupportedMethodsProviderInterface.php

Doc Comments +1 added lines

@@ -13,6 +13,7 @@
     /**
      * assign the right payment gateways for the user
      * @param string (optional) $gateway
+     * @return void
      */
     public static function assign_payment_gateway($gateway = "");
 }

code/model/address/EcommerceRegion.php

Doc Comments -1 removed lines

@@ -185,7 +185,6 @@
     /**
      * checks if a code is allowed.
      *
-     * @param string $code - e.g. NZ, NSW, or CO
      *
      * @return bool
      */

code/model/address/OrderAddress.php

Doc Comments +5 added lines, -1 removed lines

@@ -132,6 +132,9 @@ 
      */
     protected $_canView = null;
 
+    /**
+     * @param DataObject $member
+     */
     public function canCreate($member = null)
     {
         if (! $member) {
@@ -353,6 +356,7 @@ 
      * makes selected fields into read only using the $this->readOnlyFields array.
      *
      * @param FieldList | Composite $fields
+     * @param CompositeField $fields
      *
      * @return FieldList
      */
@@ -420,7 +424,7 @@ 
      * Casted variable
      * returns the full strng of the record.
      *
-     * @return string
+     * @return HTMLText
      */
     public function FullString()
     {

code/model/extensions/EcommerceRole.php

Doc Comments +4 added lines, -2 removed lines

@@ -142,6 +142,7 @@ 
      * tells us if the current member is in the Shop Administrators Group.
      *
      * @param Member | Null $member
+     * @param DataObject $member
      *
      * @return bool
      */
@@ -161,6 +162,7 @@ 
      * tells us if the current member is in the Shop Administrators Group.
      *
      * @param Member | Null $member
+     * @param DataObject $member
      *
      * @return bool
      */
@@ -180,6 +182,7 @@ 
      * tells us if the current member can process the orders
      *
      * @param Member | Null $member
+     * @param DataObject $member
      *
      * @return bool
      */
@@ -416,7 +419,6 @@ 
     }
 
     /**
-     * @param bool $additionalFields: add extra fields.
      *
      * @return FieldList
      */
@@ -503,7 +505,7 @@ 
      * Return which member fields should be required on {@link OrderForm}
      * and {@link ShopAccountForm}.
      *
-     * @return array
+     * @return string[]
      */
     public function getEcommerceRequiredFields()
     {

code/model/extensions/EcommerceSiteTreeExtension.php

Doc Comments +1 added lines, -1 removed lines

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

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/OrderAttribute.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/OrderItem.php

Doc Comments +10 added lines, -2 removed lines

@@ -300,7 +300,7 @@ 
      * standard SS method.
      *
      * @param BuyableModel $buyable
-     * @param float        $quantity
+     * @param integer        $quantity
      *
      * @return FieldList
      **/
@@ -492,6 +492,10 @@ 
     {
         return $this->getUnitPrice($recalculate);
     }
+
+    /**
+     * @return double
+     */
     public function getUnitPrice($recalculate = false)
     {
         if ($this->priceHasBeenFixed($recalculate) && !$recalculate) {
@@ -534,6 +538,10 @@ 
     {
         return $this->getTotal();
     }
+
+    /**
+     * @return double
+     */
     public function getTotal($recalculate = false)
     {
         if ($this->priceHasBeenFixed()) {
@@ -580,7 +588,7 @@ 
     }
 
     /**
-     * @return Field (EcomQuantityField)
+     * @return EcomQuantityField (EcomQuantityField)
      **/
     public function QuantityField()
     {