CHG: php doc improvements

FACT-Finder · Jun 20, 2016 · 79eb39e · 79eb39e
1 parent 31977db
commit 79eb39e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/FACTFinder/Adapter/AbstractAdapter.php b/FACTFinder/Adapter/AbstractAdapter.php
@@ -60,7 +60,7 @@ abstract class AbstractAdapter
     private $error = null;
 
     /**
-     * @var object The last stack trace.
+     * @var string The last stack trace.
      */
     private $stackTrace = null;
 

diff --git a/FACTFinder/Adapter/Tracking.php b/FACTFinder/Adapter/Tracking.php
@@ -68,11 +68,11 @@ public function setupTrackingFromRequest($sid = null)
     /**
      * Track a detail click on a product.
      *
-     * @param string $id id of product
+     * @param string $id tracking id of product (see field with the role "Product number for tracking")
      * @param string $sid session id (if empty, then try to set using the function session_id() )
      * @param string $query query which led to the product
      * @param int $pos position of product in the search result
-     * @param string $masterid masterId of product if variant
+     * @param string $masterId master id of the product (see field with the role "Master article number")
      * @param string $cookieId cookie id (optional)
      * @param int $origPos original position of product in the search result. this data is delivered by FACT-Finder (optional - is set equals to $position by default)
      * @param int $page page number where the product was clicked (optional - is 1 by default)
@@ -151,8 +151,8 @@ public function setupClickTracking(
     /**
      * Track a product which was added to the cart.
      *
-     * @param string $id id of product
-     * @param string $masterid masterId of product if variant
+     * @param string $id tracking id of product (see field with the role "Product number for tracking")
+     * @param string $masterId master id of the product (see field with the role "Master article number")
      * @param string $tile title of product (optional - is empty by default)
      * @param string $query query which led to the product (only if module Semantic Enhancer is used)
      * @param string $sid session id (if empty, then try to set using the function session_id() )
@@ -215,8 +215,8 @@ public function setupCartTracking(
     /**
      * Track a product which was purchased.
      *
-     * @param string $id id of product
-     * @param string $masterid masterId of product if variant
+     * @param string $id tracking id of product (see field with the role "Product number for tracking")
+     * @param string $masterId master id of the product (see field with the role "Master article number")
      * @param string $tile title of product (optional - is empty by default)
      * @param string $query query which led to the product (only if module Semantic Enhancer is used)
      * @param string $sid session id (if empty, then try to set using the function session_id() )
@@ -280,9 +280,9 @@ public function setupCheckoutTracking(
     /**
      * Track a click on a recommended product.
      *
-     * @param string $id id of product
+     * @param string $id tracking id of product (see field with the role "Product number for tracking")
      * @param int $mainId ID of the product for which the clicked-upon item was recommended
-     * @param string $masterid masterId of product if variant
+     * @param string $masterId master id of the product (see field with the role "Master article number")
      * @param string $sid session id (if empty, then try to set using the function session_id() )
      * @param string $cookieId cookie id (optional)
      * @param string $userid id of user (optional if modul personalisation is not used)