sunnysideup / silverstripe-ecommerce

code/model/process/OrderSteps/OrderStep_Created.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/

code/search/filters/EcommercePaymentFilters.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
 class OrderEmailRecordFilters_MultiOptionsetStatusIDFilter extends ExactMatchFilter
 {
     /**
-     *@return SQLQuery
+     *@return DataQuery
      **/
     public function apply(DataQuery $query)
     {

code/model/Order.php

Doc Comments +17 added lines, -12 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)
     {
@@ -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/process/OrderStep.php

Doc Comments +1 added lines, -25 removed lines

@@ -1318,28 +1318,4 @@
         foreach ($steps as $step) {
             if (!$step->Description) {
                 $step->Description = $step->myDescription();
-                $step->write();
-            }
-        }
-    }
-
-    /**
-     * returns the standard EcommerceDBConfig for use within OrderSteps.
-     *
-     * @return EcommerceDBConfig
-     */
-    protected function EcomConfig()
-    {
-        return EcommerceDBConfig::current_ecommerce_db_config();
-    }
-
-    /**
-     * Explains the current order step.
-     *
-     * @return string
-     */
-    protected function myDescription()
-    {
-        return _t('OrderStep.DESCRIPTION', 'No description has been provided for this step.');
-    }
-}
+                $step->write
\ No newline at end of file

code/model/process/OrderSteps/OrderStep_Sent.php

Doc Comments +2 added lines, -2 removed lines

@@ -26,7 +26,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -43,7 +43,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if run correctly.
      **/

code/tasks/EcommerceTaskArchiveAllOrdersWithItems.php

Doc Comments +4 added lines

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