sunnysideup / silverstripe-ecommerce

code/model/Order.php

Doc Comments +16 added lines, -11 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
      */
@@ -1680,7 +1681,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)
     {
@@ -2141,7 +2142,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)
     {
@@ -2339,7 +2340,7 @@ 
      *
      * @param Member (optional) $member
      *
-     * @return bool
+     * @return boolean|null
      **/
     public function canViewAdminStuff($member = null)
     {
@@ -2392,7 +2393,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
      **/
@@ -2759,6 +2760,10 @@ 
     {
         return $this->getTitle($dateFormat, $includeName);
     }
+
+    /**
+     * @param string $dateFormat
+     */
     public function getTitle($dateFormat = null, $includeName = false)
     {
         if ($this->exists()) {
@@ -2822,7 +2827,7 @@ 
     /**
      * Returns the subtotal of the items for this order.
      *
-     * @return float
+     * @return integer
      */
     public function SubTotal()
     {
@@ -2888,7 +2893,7 @@ 
     /**
      * Returns the total cost of an order including the additional charges or deductions of its modifiers.
      *
-     * @return float
+     * @return integer
      */
     public function Total()
     {
@@ -3353,7 +3358,7 @@ 
     /**
      * Submission Log for this Order (if any).
      *
-     * @return DateTime
+     * @return DBField
      **/
     public function OrderDate()
     {
@@ -3538,7 +3543,7 @@ 
     /**
      * Converts the Order into HTML, based on the Order Template.
      *
-     * @return HTML Object
+     * @return DBField Object
      **/
     public function ConvertToHTML()
     {
@@ -3602,7 +3607,7 @@ 
      * In templates, it is used like this:
      * $EcommerceConfigAjax.TableID.
      *
-     * @return EcommerceConfigAjax
+     * @return EcommerceConfigAjaxDefinitions
      **/
     public function AJAXDefinitions()
     {

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/model/process/OrderStep.php

Doc Comments +11 added lines, -5 removed lines

@@ -651,7 +651,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -670,7 +670,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if run correctly.
      **/
@@ -714,6 +714,7 @@ 
      *
      * @param string $code:       the name of the step to check
      * @param bool   $orIsEqualTo if set to true, this method will return TRUE if the step being checked is the current one
+     * @param string $code
      *
      * @return bool
      **/
@@ -966,6 +967,11 @@ 
         return $this->hasCustomerMessage() ?  _t('OrderStep.YES', 'Yes') :  _t('OrderStep.NO', 'No');
     }
 
+    /**
+     * @param Order $order
+     *
+     * @return boolean|string
+     */
     public function CalculatedEmailSubject($order = null)
     {
         return $this->EmailSubject;
@@ -979,7 +985,7 @@ 
     /**
      * Formatted answer for "hasCustomerMessage".
      *
-     * @return string
+     * @return DBField
      */
     public function ShowAsSummary()
     {
@@ -989,7 +995,7 @@ 
     /**
      *
      *
-     * @return string
+     * @return DBField
      */
     public function getShowAsSummary()
     {
@@ -1049,7 +1055,7 @@ 
     /**
      * Formatted answer for "hasCustomerMessage".
      *
-     * @return string
+     * @return DBField
      */
     public function NameAndDescription()
     {

code/model/process/OrderSteps/OrderStep_Sent.php

Doc Comments +9 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -89,9 +89,9 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
-     * @return bool - true if run correctly.
+     * @return boolean|null - true if run correctly.
      **/
     public function doStep(Order $order)
     {
@@ -163,6 +163,9 @@ 
         return _t('OrderStep.SENT_DESCRIPTION', 'During this step we record the delivery details for the order such as the courrier ticket number and whatever else is relevant.');
     }
 
+    /**
+     * @param Order $order
+     */
     public function CalculatedEmailSubject($order = null)
     {
         $v = null;
@@ -176,6 +179,9 @@ 
         return $v;
     }
 
+    /**
+     * @param Order $order
+     */
     public function CalculatedCustomerMessage($order = null)
     {
         $v = null;

code/forms/OrderForm_Feedback.php

Doc Comments +6 added lines, -2 removed lines

@@ -44,7 +44,7 @@ 
     /**
      * @param array        $data The form request data submitted
      * @param Form         $form The {@link Form} this was submitted on
-     * @param HTTPRequest  $request The {@link Form} this was submitted on
+     * @param SS_HTTPRequest  $request The {@link Form} this was submitted on
      */
     public function dofeedback(array $data, Form $form, SS_HTTPRequest $request)
     {
@@ -75,7 +75,6 @@ 
     /**
      * saves the form into session.
      *
-     * @param array $data - data from form.
      */
     public function saveDataToSession()
     {
@@ -83,6 +82,11 @@ 
         Session::set("FormInfo.{$this->FormName()}.data", $data);
     }
 
+    /**
+     * @param string $value
+     *
+     * @return string
+     */
     protected function getValueFromOrderConfirmationPage($value)
     {
         if ($page = $this->getOrderConfirmationPage()) {

code/model/process/OrderSteps/OrderStep_SentInvoice.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
      * NOTE: must have a payment (even if it is a fake payment).
      * The reason for this is if people pay straight away then they want to see the payment shown on their invoice.
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/

code/model/process/OrderSteps/OrderStep_Submitted.php

Doc Comments +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -67,7 +67,7 @@ 
     /**
      * Add a member to the order - in case he / she is not a shop admin.
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if run correctly.
      **/

code/forms/ProductSearchForm.php

Doc Comments +1 added lines, -1 removed lines

@@ -555,8 +555,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/model/extensions/EcommerceRole.php

Doc Comments +3 added lines, -1 removed lines

@@ -147,6 +147,7 @@ 
      * tells us if the current member is in the Shop Administrators Group.
      *
      * @param Member | Null $member
+     * @param DataObject $member
      *
      * @return bool
      */
@@ -166,6 +167,7 @@ 
      * tells us if the current member is in the Shop Administrators Group.
      *
      * @param Member | Null $member
+     * @param DataObject $member
      *
      * @return bool
      */
@@ -185,6 +187,7 @@ 
      * tells us if the current member can process the orders
      *
      * @param Member | Null $member
+     * @param DataObject $member
      *
      * @return bool
      */
@@ -442,7 +445,6 @@ 
     }
 
     /**
-     * @param bool $additionalFields: add extra fields.
      *
      * @return FieldList
      */