sunnysideup / silverstripe-ecommerce

code/Product.php

Doc Comments +10 added lines, -6 removed lines

@@ -322,7 +322,7 @@ 
     /**
      * Used in getCSMFields.
      *
-     * @return GridField
+     * @return UploadField
      **/
     protected function getAdditionalImagesField()
     {
@@ -337,7 +337,7 @@ 
     /**
      * Used in getCSMFields.
      *
-     * @return GridField
+     * @return UploadField
      **/
     protected function getAdditionalFilesField()
     {
@@ -626,7 +626,7 @@ 
     /**
      * returns the default image of the product.
      *
-     * @return Image | Null
+     * @return string | Null
      */
     public function DefaultImage()
     {
@@ -661,7 +661,7 @@ 
     /**
      * @TODO: complete
      *
-     * @param string $compontent - the has many relationship you are looking at, e.g. OrderAttribute
+     * @param string $component - the has many relationship you are looking at, e.g. OrderAttribute
      *
      * @return DataList (CHECK!)
      */
@@ -752,7 +752,7 @@ 
     /**
      * You can set an alternative class name for order item using this method.
      *
-     * @param string $ClassName
+     * @param string $className
      **/
     public function setAlternativeClassNameForOrderItem($className)
     {
@@ -879,6 +879,7 @@ 
      * set new specific new quantity for buyable's orderitem.
      *
      * @param float
+     * @param integer $quantity
      *
      * @return string (Link)
      */
@@ -970,7 +971,7 @@ 
      * In templates, it is used like this:
      * $EcommerceConfigAjax.TableID.
      *
-     * @return EcommerceConfigAjax
+     * @return EcommerceConfigAjaxDefinitions
      **/
     public function AJAXDefinitions()
     {
@@ -1023,6 +1024,9 @@ 
 
     private static $_calculated_price_cache = array();
 
+    /**
+     * @return double
+     */
     public function getCalculatedPrice()
     {
         if (! isset(self::$_calculated_price_cache[$this->ID])) {

code/ProductGroup.php

Doc Comments +6 added lines, -7 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
@@ -1528,9 +1528,8 @@ 
 
     /**
      *
-     * @param string $name
-     * @param string $filterKey
      *
+     * @param string $cacheKey
      * @return string
      */
     public function cacheKey($cacheKey)
@@ -1827,7 +1826,7 @@ 
      * This is the call that is made from the template...
      * The actual final products being shown.
      *
-     * @return PaginatedList
+     * @return DataList
      **/
     public function Products()
     {
@@ -2151,7 +2150,7 @@ 
      *
      * This is different from IsSearchResults.
      *
-     * @return bool
+     * @return boolean|null
      */
     public function ActiveSearchTerm()
     {
@@ -2217,7 +2216,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()
     {
@@ -2599,7 +2598,7 @@ 
      *
      * @param SS_List
      *
-     * @return PaginatedList
+     * @return ProductGroup_Controller|null
      */
     protected function paginateList(SS_List $list)
     {

code/search/filters/OrderEmailRecordFilters.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/search/filters/OrderFilters.php

Doc Comments +5 added lines, -5 removed lines

@@ -28,7 +28,7 @@ 
     private $divider = 3;
 
     /**
-     *@return SQLQuery
+     *@return DataQuery
      **/
     public function apply(DataQuery $query)
     {
@@ -73,7 +73,7 @@ 
 class OrderFilters_MemberAndAddress extends ExactMatchFilter
 {
     /**
-     *@return SQLQuery
+     *@return DataQuery
      **/
     public function apply(DataQuery $query)
     {
@@ -146,7 +146,7 @@ 
 class OrderFilters_MultiOptionsetStatusIDFilter extends ExactMatchFilter
 {
     /**
-     *@return SQLQuery
+     *@return DataQuery
      **/
     public function apply(DataQuery $query)
     {
@@ -181,7 +181,7 @@ 
 class OrderFilters_HasBeenCancelled extends ExactMatchFilter
 {
     /**
-     *@return SQLQuery
+     *@return DataQuery
      **/
     public function apply(DataQuery $query)
     {
@@ -216,7 +216,7 @@ 
 class OrderFilters_MustHaveAtLeastOnePayment extends ExactMatchFilter
 {
     /**
-     *@return SQLQuery
+     *@return DataQuery
      **/
     public function apply(DataQuery $query)
     {

code/tasks/EcommerceTaskArchiveAllOrdersWithItems.php

Doc Comments +5 added lines

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

code/tasks/EcommerceTaskCleanupProducts.php

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
 
     protected $deleteFirst = true;
 
+    /**
+     * @param boolean $b
+     */
     public function setDeleteFirst($b)
     {
         $this->deleteFirst = $b;

code/tasks/EcommerceTaskMigration.php

Doc Comments +3 added lines, -1 removed lines

@@ -196,8 +196,10 @@
      *
      * @param string - $field - name of the field to be tested
      * @param string - $table - name of the table to be tested
+     * @param string $table
+     * @param string $field
      *
-     * @return bool
+     * @return boolean|null
      */
     protected function makeFieldObsolete($table, $field, $format = '')
     {

code/tasks/EcommerceTaskOrderItemsPerCustomer.php

Doc Comments +3 added lines

@@ -69,6 +69,9 @@
         }
     }
 
+    /**
+     * @param DataList $orderItems
+     */
     public function generateExportFileData($email, $date, $orderItems)
     {
         $separator = ',';

code/tasks/EcommerceTaskTryToFinaliseOrders.php

Doc Comments +4 added lines

@@ -92,6 +92,10 @@
         $this->doNotSendEmails = false;
     }
 
+    /**
+     * @param integer|null $limit
+     * @param integer|null $startAt
+     */
     protected function tryToFinaliseOrders($orders, $limit, $startAt)
     {
         $orders = $orders->limit($limit, $startAt);