sunnysideup / silverstripe-ecommerce

code/model/Order.php

Doc Comments +16 added lines, -11 removed lines

@@ -194,7 +194,7 @@ 
      * @param bool (optional) $b
      * @param int (optional)  $orderID
      *
-     * @return bool
+     * @return boolean|null
      */
     public static function set_needs_recalculating($b = true, $orderID = 0)
     {
@@ -266,7 +266,7 @@ 
     /**
      * This function returns the OrderSteps.
      *
-     * @return ArrayList (OrderSteps)
+     * @return DataList (OrderSteps)
      **/
     public static function get_order_status_options()
     {
@@ -465,6 +465,7 @@ 
      * link to edit the record.
      *
      * @param string | Null $action - e.g. edit
+     * @param string $action
      *
      * @return string
      */
@@ -1396,7 +1397,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()
     {
@@ -1651,7 +1652,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)
     {
@@ -2112,7 +2113,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)
     {
@@ -2310,7 +2311,7 @@ 
      *
      * @param Member (optional) $member
      *
-     * @return bool
+     * @return boolean|null
      **/
     public function canViewAdminStuff($member = null)
     {
@@ -2363,7 +2364,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
      **/
@@ -2709,6 +2710,10 @@ 
     {
         return $this->getTitle($dateFormat, $includeName);
     }
+
+    /**
+     * @param string $dateFormat
+     */
     public function getTitle($dateFormat = null, $includeName = false)
     {
         if ($this->exists()) {
@@ -2772,7 +2777,7 @@ 
     /**
      * Returns the subtotal of the items for this order.
      *
-     * @return float
+     * @return integer
      */
     public function SubTotal()
     {
@@ -2838,7 +2843,7 @@ 
     /**
      * Returns the total cost of an order including the additional charges or deductions of its modifiers.
      *
-     * @return float
+     * @return integer
      */
     public function Total()
     {
@@ -3468,7 +3473,7 @@ 
     /**
      * Converts the Order into HTML, based on the Order Template.
      *
-     * @return HTML Object
+     * @return DBField Object
      **/
     public function ConvertToHTML()
     {
@@ -3532,7 +3537,7 @@ 
      * In templates, it is used like this:
      * $EcommerceConfigAjax.TableID.
      *
-     * @return EcommerceConfigAjax
+     * @return EcommerceConfigAjaxDefinitions
      **/
     public function AJAXDefinitions()
     {

code/forms/OrderForm_Feedback.php

Doc Comments +6 added lines, -2 removed lines

@@ -46,7 +46,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)
     {
@@ -77,7 +77,6 @@ 
     /**
      * saves the form into session.
      *
-     * @param array $data - data from form.
      */
     public function saveDataToSession()
     {
@@ -85,6 +84,11 @@ 
         Session::set("FormInfo.{$this->FormName()}.data", $data);
     }
 
+    /**
+     * @param string $value
+     *
+     * @return string
+     */
     protected function getValueFromOrderConfirmationPage($value)
     {
         if($page = $this->getOrderConfirmationPage()) {

code/OrderConfirmationPage.php

Doc Comments +2 added lines, -3 removed lines

@@ -296,7 +296,6 @@ 
      * Return a link to view the order on this page.
      *
      * @param int|string $orderID                ID of the order
-     * @param string     $type                   - the type of email you want to send.
      * @param bool       $actuallySendEmail      - do we actually send the email
      * @param int        $alternativeOrderStepID - OrderStep to use
      *
@@ -335,7 +334,7 @@ 
      *
      * @param bool $isCurrentStep
      *
-     * @return Checkout_StepDescription
+     * @return CheckoutPage_StepDescription
      */
     public function CurrentCheckoutStep($isCurrentStep = false)
     {
@@ -687,7 +686,7 @@ 
      * checking to see if IsFeedbackEnabled is true
      * first of all.
      *
-     * @return OrderForm_Feedback
+     * @return OrderConfirmationPage_Controller|null
      */
     public function FeedbackForm()
     {