sunnysideup / silverstripe-ecommerce

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
      */

code/search/filters/OrderFilters_AroundDateFilter.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
     protected $additionalDaysPerMonth = 1;
 
     /**
-     *@return SQLQuery
+     *@return DataQuery
      **/
     public function apply(DataQuery $query)
     {

code/forms/fields/EcommerceSearchHistoryFormField.php

Doc Comments +5 added lines

@@ -56,6 +56,7 @@ 
 
     /**
      * @param int
+     * @param integer $days
      *
      * @return EcommerceSearchHistoryFormField
      */
@@ -68,6 +69,7 @@ 
 
     /**
      * @param int
+     * @param integer $count
      *
      * @return EcommerceSearchHistoryFormField
      */
@@ -80,6 +82,7 @@ 
 
     /**
      * @param int
+     * @param boolean $b
      *
      * @return EcommerceSearchHistoryFormField
      */
@@ -92,6 +95,7 @@ 
 
     /**
      * @param int
+     * @param integer $count
      *
      * @return EcommerceSearchHistoryFormField
      */
@@ -104,6 +108,7 @@ 
 
     /**
      * @param int
+     * @param integer $number
      *
      * @return EcommerceSearchHistoryFormField
      */

code/ProductGroup.php

Doc Comments +5 added lines, -6 removed lines

@@ -372,7 +372,7 @@ 
      * by either type (e.g. FILER) or variable (e.g dbFieldName)
      * or both.
      *
-     * @param string $typeOfVariableName FILTER | SORT | DISPLAY or sessionName, getVariable, etc...
+     * @param string $typeOrVariable FILTER | SORT | DISPLAY or sessionName, getVariable, etc...
      * @param string $variable:          sessionName, getVariable, etc...
      *
      * @return array | String
@@ -1608,9 +1608,8 @@ 
 
     /**
      *
-     * @param string $name
-     * @param string $filterKey
      *
+     * @param string $cacheKey
      * @return string
      */
     public function cacheKey($cacheKey)
@@ -2253,7 +2252,7 @@ 
      *
      * This is different from IsSearchResults.
      *
-     * @return bool
+     * @return boolean|null
      */
     public function ActiveSearchTerm()
     {
@@ -2319,7 +2318,7 @@ 
      * Is there a special sort operating at the moment?
      * Is the current sort the default one (return inverse!)?
      *
-     * @return bool
+     * @return boolean|null
      */
     public function HasSort()
     {
@@ -2742,7 +2741,7 @@ 
      *
      * @param SS_List
      *
-     * @return PaginatedList
+     * @return ProductGroup_Controller|null
      */
     protected function paginateList(SS_List $list)
     {

code/api/ShoppingCart.php

Doc Comments +19 added lines, -18 removed lines

@@ -359,8 +359,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)
@@ -407,7 +407,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
      *
@@ -437,8 +437,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
@@ -475,7 +475,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
@@ -502,9 +502,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...
      *
@@ -569,7 +568,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
@@ -631,7 +630,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()
     {
@@ -695,7 +694,7 @@ 
      *
      * @param OrderModifier $modifier
      *
-     * @return bool | null
+     * @return boolean|null | null
      */
     public function removeModifier(OrderModifier $modifier)
     {
@@ -727,8 +726,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)
     {
@@ -856,7 +856,7 @@ 
      * @param Order $oldOrder
      * @param Order $newOrder
      *
-     * @return Ordeer (the new order)
+     * @return Order (the new order)
      */
     public function CopyOrderOnly($oldOrder, $newOrder)
     {
@@ -907,7 +907,7 @@ 
      *
      * @param string - $countryCode
      *
-     * @return bool
+     * @return boolean|null
      **/
     public function setCountry($countryCode)
     {
@@ -929,6 +929,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
      **/
@@ -1071,7 +1072,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')
@@ -1097,7 +1098,7 @@ 
     /**
      * Gets an existing order item based on buyable and passed parameters.
      *
-     * @param DataObject $buyable
+     * @param BuyableModel $buyable
      * @param array      $parameters
      *
      * @return OrderItem | null
@@ -1122,7 +1123,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
      */