sunnysideup / silverstripe-ecommerce

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

code/api/ShoppingCart.php

Doc Comments +18 added lines, -17 removed lines

@@ -350,8 +350,8 @@ 
      * Adds any number of items to the cart.
      * Returns the order item on succes OR false on failure.
      *
-     * @param DataObject $buyable    - the buyable (generally a product) being added to the cart
-     * @param float      $quantity   - number of items add.
+     * @param BuyableModel $buyable    - the buyable (generally a product) being added to the cart
+     * @param integer      $quantity   - number of items add.
      * @param mixed      $parameters - array of parameters to target a specific order item. eg: group=1, length=5
      *                                 if you make it a form, it will save the form into the orderitem
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
@@ -398,7 +398,7 @@ 
      *
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
      *
-     * @param DataObject $buyable    - the buyable (generally a product) being added to the cart
+     * @param BuyableModel $buyable    - the buyable (generally a product) being added to the cart
      * @param float      $quantity   - number of items add.
      * @param array      $parameters - array of parameters to target a specific order item. eg: group=1, length=5
      *
@@ -428,8 +428,8 @@ 
      *
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
      *
-     * @param DataObject $buyable    - the buyable (generally a product) being added to the cart
-     * @param float      $quantity   - number of items add.
+     * @param BuyableModel $buyable    - the buyable (generally a product) being added to the cart
+     * @param integer      $quantity   - number of items add.
      * @param array      $parameters - array of parameters to target a specific order item. eg: group=1, length=5
      *
      * @return false | OrderItem | null
@@ -467,7 +467,7 @@ 
      *
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
      *
-     * @param OrderItem $buyable    - the buyable (generally a product) being added to the cart
+     * @param BuyableModel $buyable    - the buyable (generally a product) being added to the cart
      * @param array     $parameters - array of parameters to target a specific order item. eg: group=1, length=5
      *
      * @return bool | item | null - successfully removed
@@ -494,9 +494,8 @@ 
     /**
      * Checks and prepares variables for a quantity change (add, edit, remove) for an Order Item.
      *
-     * @param DataObject    $buyable             - the buyable (generally a product) being added to the cart
-     * @param float         $quantity            - number of items add.
-     * @param bool          $mustBeExistingItems - if false, the Order Item gets created if it does not exist - if TRUE the order item is searched for and an error shows if there is no Order item.
+     * @param BuyableModel    $buyable             - the buyable (generally a product) being added to the cart
+     * @param bool          $mustBeExistingItem - if false, the Order Item gets created if it does not exist - if TRUE the order item is searched for and an error shows if there is no Order item.
      * @param array | Form  $parameters          - array of parameters to target a specific order item. eg: group=1, length=5*
      *                                           - form saved into item...
      *
@@ -564,7 +563,7 @@ 
      * we do not need things like "canPurchase" here, because that is with the "addBuyable" method.
      * NOTE: does not write!
      *
-     * @param DataObject $buyable
+     * @param BuyableModel $buyable
      * @param array      $parameters
      *
      * @return OrderItem
@@ -626,7 +625,7 @@ 
     /**
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
      *
-     * @return bool | null
+     * @return boolean|null | null
      */
     public function save()
     {
@@ -690,7 +689,7 @@ 
      *
      * @param OrderModifier $modifier
      *
-     * @return bool | null
+     * @return boolean|null | null
      */
     public function removeModifier(OrderModifier $modifier)
     {
@@ -722,8 +721,9 @@ 
      * returns null if the current user does not allow order manipulation or saving (e.g. session disabled)
      *
      * @param Int/ OrderModifier
+     * @param integer $modifier
      *
-     * @return bool
+     * @return boolean|null
      */
     public function addModifier($modifier)
     {
@@ -857,7 +857,7 @@ 
      *
      * @param string - $countryCode
      *
-     * @return bool
+     * @return boolean|null
      **/
     public function setCountry($countryCode)
     {
@@ -879,6 +879,7 @@ 
      * sets region in order so that modifiers can be recalculated, etc...
      *
      * @param int | String - $regionID you can use the ID or the code.
+     * @param integer $regionID
      *
      * @return bool
      **/
@@ -1021,7 +1022,7 @@ 
     /**
      * Stores a message that can later be returned via ajax or to $form->sessionMessage();.
      *
-     * @param $message - the message, which could be a notification of successful action, or reason for failure
+     * @param string $message - the message, which could be a notification of successful action, or reason for failure
      * @param $type - please use good, bad, warning
      */
     public function addMessage($message, $status = 'good')
@@ -1047,7 +1048,7 @@ 
     /**
      * Gets an existing order item based on buyable and passed parameters.
      *
-     * @param DataObject $buyable
+     * @param BuyableModel $buyable
      * @param array      $parameters
      *
      * @return OrderItem | null
@@ -1073,7 +1074,7 @@ 
     /**
      * Removes parameters that aren't in the default array, merges with default parameters, and converts raw2SQL.
      *
-     * @param array $parameters
+     * @param array $params
      *
      * @return cleaned array
      */

code/model/process/OrderProcessQueue.php

Doc Comments +4 added lines, -5 removed lines

@@ -152,7 +152,7 @@ 
      * META METHOD: Add an order to the job list if it does not exist already.
      *
      * @param Order $order
-     * @param Int   $deferInSeconds
+     * @param Int   $deferTimeInSeconds
      */
     public function AddOrderToQueue($order, $deferTimeInSeconds)
     {
@@ -184,7 +184,7 @@ 
      *
      *
      * @param  Order $order optional
-     * @return boolean | string
+     * @return boolean|string | string
      */
     public function process($order = null)
     {
@@ -244,7 +244,7 @@ 
      *
      * @param  Order $order
      *
-     * @return null |   OrderProcessQueue
+     * @return DataObject |   OrderProcessQueue
      */
     public function getQueueObject($order)
     {
@@ -301,7 +301,6 @@ 
 
     /**
      * META METHOD: all orders with a queue object
-     * @param int $id force this Order to be processed
      * @param int $limit total number of orders that can be retrieved at any one time
      *
      * @return DataList (of orders)
@@ -467,7 +466,7 @@ 
 
     /**
      * sort phrase for orders, based in order IDs...
-     * @param  array $orderIds
+     * @param  array $orderIDs
      * @return string
      */
     protected function sortPhraseForOrderIDs($orderIDs)

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 +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/forms/ProductSearchForm.php

Doc Comments +2 added lines, -2 removed lines

@@ -495,7 +495,7 @@ 
      * can be executed one after the other, each
      * being less specific than the last...
      *
-     * @return array
+     * @return boolean
      */
     protected function addToResults($listToAdd)
     {
@@ -518,8 +518,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/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()
     {