sunnysideup / silverstripe-ecommerce

code/model/process/OrderSteps/OrderStep_Sent.php

Doc Comments +9 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -89,9 +89,9 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
-     * @return bool - true if run correctly.
+     * @return boolean|null - true if run correctly.
      **/
     public function doStep(Order $order)
     {
@@ -163,6 +163,9 @@ 
         return _t('OrderStep.SENT_DESCRIPTION', 'During this step we record the delivery details for the order such as the courrier ticket number and whatever else is relevant.');
     }
 
+    /**
+     * @param Order $order
+     */
     public function CalculatedEmailSubject($order = null)
     {
         $v = null;
@@ -176,6 +179,9 @@ 
         return $v;
     }
 
+    /**
+     * @param Order $order
+     */
     public function CalculatedCustomerMessage($order = null)
     {
         $v = null;

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