sunnysideup / silverstripe-ecommerce

code/interfaces/BuyableModel.php

Doc Comments +5 added lines, -1 removed lines

@@ -112,7 +112,7 @@ 
     /**
      * You can set an alternative class name for order item using this method.
      *
-     * @param string $ClassName
+     * @param string $className
      **/
     public function setAlternativeClassNameForOrderItem($className);
 
@@ -248,6 +248,10 @@ 
      * @return Money
      */
     public function CalculatedPriceAsMoney();
+
+    /**
+     * @return Money
+     */
     public function getCalculatedPriceAsMoney();
 
     //CRUD SETTINGS

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/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/Order.php

Doc Comments +18 added lines, -13 removed lines

@@ -192,7 +192,7 @@ 
      * @param bool (optional) $b
      * @param int (optional)  $orderID
      *
-     * @return bool
+     * @return boolean|null
      */
     public static function set_needs_recalculating($b = true, $orderID = 0)
     {
@@ -264,7 +264,7 @@ 
     /**
      * This function returns the OrderSteps.
      *
-     * @return ArrayList (OrderSteps)
+     * @return DataList (OrderSteps)
      **/
     public static function get_order_status_options()
     {
@@ -453,6 +453,7 @@ 
      * link to edit the record.
      *
      * @param string | Null $action - e.g. edit
+     * @param string $action
      *
      * @return string
      */
@@ -1159,7 +1160,7 @@ 
      * @param Member $member - the user cancelling the order
      * @param string $reason - the reason the order is cancelled
      *
-     * @return OrderStatusLog_Cancel
+     * @return integer
      */
     public function Cancel(Member $member, $reason = '')
     {
@@ -1594,7 +1595,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)
     {
@@ -1690,9 +1691,9 @@ 
      *
      * @param string        $emailClassName     - the class name of the email you wish to send
      * @param string        $subject            - email subject
-     * @param bool          $copyToAdmin        - true by default, whether it should send a copy to the admin
      * @param bool          $resend             - sends the email even it has been sent before.
      * @param bool | string $adminOnlyOrToEmail - sends the email to the ADMIN ONLY, if you provide an email, it will go to the email...
+     * @param string $message
      *
      * @return bool TRUE for success, FALSE for failure (not tested)
      */
@@ -1811,7 +1812,7 @@ 
      * @param string $message        - the additional message
      * @param string $emailClassName - template to use.
      *
-     * @return array (Message, Order, EmailLogo, ShopPhysicalAddress)
+     * @return string (Message, Order, EmailLogo, ShopPhysicalAddress)
      */
     public function renderOrderInEmailFormat($message = '', $emailClassName)
     {
@@ -2054,7 +2055,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)
     {
@@ -2252,7 +2253,7 @@ 
      *
      * @param Member (optional) $member
      *
-     * @return bool
+     * @return boolean|null
      **/
     public function canViewAdminStuff($member = null)
     {
@@ -2305,7 +2306,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
      **/
@@ -2651,6 +2652,10 @@ 
     {
         return $this->getTitle($dateFormat, $includeName);
     }
+
+    /**
+     * @param string $dateFormat
+     */
     public function getTitle($dateFormat = null, $includeName = false)
     {
         if ($this->exists()) {
@@ -2714,7 +2719,7 @@ 
     /**
      * Returns the subtotal of the items for this order.
      *
-     * @return float
+     * @return integer
      */
     public function SubTotal()
     {
@@ -2780,7 +2785,7 @@ 
     /**
      * Returns the total cost of an order including the additional charges or deductions of its modifiers.
      *
-     * @return float
+     * @return integer
      */
     public function Total()
     {
@@ -3410,7 +3415,7 @@ 
     /**
      * Converts the Order into HTML, based on the Order Template.
      *
-     * @return HTML Object
+     * @return DBField Object
      **/
     public function ConvertToHTML()
     {
@@ -3474,7 +3479,7 @@ 
      * In templates, it is used like this:
      * $EcommerceConfigAjax.TableID.
      *
-     * @return EcommerceConfigAjax
+     * @return EcommerceConfigAjaxDefinitions
      **/
     public function AJAXDefinitions()
     {

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()
     {