sunnysideup / silverstripe-ecommerce

code/tasks/EcommerceTaskArchiveAllOrdersWithItems.php

Doc Comments +5 added lines

@@ -100,6 +100,11 @@
         }
     }
 
+    /**
+     * @param DataObject $lastOrderStep
+     * @param string $orderStatusLogClassName
+     * @param integer $offset
+     */
     public function getOrdersForCreateSubmissionLogForArchivedOrders($lastOrderStep, $orderStatusLogClassName, $offset)
     {
         return Order::get()

code/CartPage.php

Doc Comments +8 added lines, -2 removed lines

@@ -215,6 +215,7 @@ 
      * Returns the "new order" link.
      *
      * @param int | String $orderID - not used in CartPage
+     * @param integer $orderID
      *
      * @return string (URLSegment)
      */
@@ -227,6 +228,7 @@ 
      * Returns the "copy order" link.
      *
      * @param int | String $orderID - not used in CartPage
+     * @param integer $orderID
      *
      * @return string (URLSegment)
      */
@@ -240,7 +242,7 @@ 
      *
      * @param int|string $orderID ID of the order
      *
-     * @return int | String (URLSegment)
+     * @return string | String (URLSegment)
      */
     public static function get_order_link($orderID)
     {
@@ -382,6 +384,10 @@ 
      * @todo: check if we need this....!
      **/
     private $message = '';
+
+    /**
+     * @param string $s
+     */
     public static function set_message($s)
     {
         $sessionCode = EcommerceConfig::get('CartPage_Controller', 'session_code');
@@ -703,7 +709,7 @@ 
 
 
     /**
-     * @return string
+     * @return DBField
      **/
     public function Message()
     {

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()
     {
@@ -468,6 +468,7 @@ 
      * link to edit the record.
      *
      * @param string | Null $action - e.g. edit
+     * @param string $action
      *
      * @return string
      */
@@ -1420,7 +1421,7 @@ 
      * Has the order been paid?
      * TODO: why do we check if there is a total at all?
      *
-     * @return Boolean (object)
+     * @return string (object)
      */
     public function IsPaidNice()
     {
@@ -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()
     {