sunnysideup / silverstripe-ecommerce

code/model/process/OrderStep.php

Doc Comments +6 added lines, -5 removed lines

@@ -594,7 +594,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -613,7 +613,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if run correctly.
      **/
@@ -655,6 +655,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
      **/
@@ -902,7 +903,7 @@ 
     /**
      * Formatted answer for "hasCustomerMessage".
      *
-     * @return string
+     * @return DBField
      */
     public function ShowAsSummary()
     {
@@ -912,7 +913,7 @@ 
     /**
      *
      *
-     * @return string
+     * @return DBField
      */
     public function getShowAsSummary()
     {
@@ -972,7 +973,7 @@ 
     /**
      * Formatted answer for "hasCustomerMessage".
      *
-     * @return string
+     * @return DBField
      */
     public function NameAndDescription()
     {

code/model/process/OrderSteps/OrderStep_Confirmed.php

Doc Comments +3 added lines, -3 removed lines

@@ -30,7 +30,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -47,7 +47,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if run correctly.
      **/
@@ -61,7 +61,7 @@ 
      *
      * @param DataObject $order Order
      *
-     * @return DataObject | Null - DataObject = OrderStep
+     * @return OrderStep|null | Null - DataObject = OrderStep
      **/
     public function nextStep(Order $order)
     {

code/model/process/OrderSteps/OrderStep_Paid.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/model/process/OrderSteps/OrderStep_Sent.php

Doc Comments +3 added lines, -3 removed lines

@@ -48,7 +48,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -65,9 +65,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)
     {

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_SentReceipt.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/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/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)
     {