Merge branch 'release'

* release: Update documentation release 1.2.4 CHG: updated changelog CHG: removed legacy tracking code CHG: added userId parameter to methods Update XmlConfiguration.php
FACT-Finder · Jul 11, 2016 · fbea6c2 · fbea6c2
2 parents 69d4426 + 80613a1
commit fbea6c2
Show file tree

Hide file tree

Showing 171 changed files with 3,009 additions and 3,027 deletions.
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
@@ -1,3 +1,8 @@
+Version 1.2.4
+    - Added userId parameter to TrackingAdapter methods doTrackingFromRequest/setupTrackingFromRequest
+    - Extended constructor in order to support not only file based XMLConfiguration by @asdfklgash
+    - Removed legacy tracking code
+
 Version 1.2.3
     - Fixed wrong function name called by @ marfis
     - Moved methods getError and getStacktrace to AbstractAdapter

diff --git a/docs/classes/FACTFinder.Adapter.AbstractAdapter.html b/docs/classes/FACTFinder.Adapter.AbstractAdapter.html
diff --git a/docs/classes/FACTFinder.Adapter.Compare.html b/docs/classes/FACTFinder.Adapter.Compare.html
diff --git a/docs/classes/FACTFinder.Adapter.Import.html b/docs/classes/FACTFinder.Adapter.Import.html
diff --git a/docs/classes/FACTFinder.Adapter.ProductCampaign.html b/docs/classes/FACTFinder.Adapter.ProductCampaign.html
diff --git a/docs/classes/FACTFinder.Adapter.Recommendation.html b/docs/classes/FACTFinder.Adapter.Recommendation.html
diff --git a/docs/classes/FACTFinder.Adapter.Search.html b/docs/classes/FACTFinder.Adapter.Search.html
diff --git a/docs/classes/FACTFinder.Adapter.SimilarRecords.html b/docs/classes/FACTFinder.Adapter.SimilarRecords.html
diff --git a/docs/classes/FACTFinder.Adapter.Suggest.html b/docs/classes/FACTFinder.Adapter.Suggest.html
diff --git a/docs/classes/FACTFinder.Adapter.TagCloud.html b/docs/classes/FACTFinder.Adapter.TagCloud.html
diff --git a/docs/classes/FACTFinder.Adapter.Tracking.html b/docs/classes/FACTFinder.Adapter.Tracking.html
diff --git a/docs/classes/FACTFinder.Core.AbstractConfiguration.html b/docs/classes/FACTFinder.Core.AbstractConfiguration.html
diff --git a/docs/classes/FACTFinder.Core.AbstractEncodingConverter.html b/docs/classes/FACTFinder.Core.AbstractEncodingConverter.html
diff --git a/docs/classes/FACTFinder.Core.ArrayConfiguration.html b/docs/classes/FACTFinder.Core.ArrayConfiguration.html
diff --git a/docs/classes/FACTFinder.Core.Client.RequestParser.html b/docs/classes/FACTFinder.Core.Client.RequestParser.html
diff --git a/docs/classes/FACTFinder.Core.Client.UrlBuilder.html b/docs/classes/FACTFinder.Core.Client.UrlBuilder.html
diff --git a/docs/classes/FACTFinder.Core.ConfigurationInterface.html b/docs/classes/FACTFinder.Core.ConfigurationInterface.html
diff --git a/docs/classes/FACTFinder.Core.IConvEncodingConverter.html b/docs/classes/FACTFinder.Core.IConvEncodingConverter.html
diff --git a/docs/classes/FACTFinder.Core.ManualConfiguration.html b/docs/classes/FACTFinder.Core.ManualConfiguration.html
diff --git a/docs/classes/FACTFinder.Core.ParametersConverter.html b/docs/classes/FACTFinder.Core.ParametersConverter.html
diff --git a/docs/classes/FACTFinder.Core.Server.AbstractDataProvider.html b/docs/classes/FACTFinder.Core.Server.AbstractDataProvider.html
diff --git a/docs/classes/FACTFinder.Core.Server.ConnectionData.html b/docs/classes/FACTFinder.Core.Server.ConnectionData.html
diff --git a/docs/classes/FACTFinder.Core.Server.EasyCurlDataProvider.html b/docs/classes/FACTFinder.Core.Server.EasyCurlDataProvider.html
diff --git a/docs/classes/FACTFinder.Core.Server.EasyCurlRequestFactory.html b/docs/classes/FACTFinder.Core.Server.EasyCurlRequestFactory.html
diff --git a/docs/classes/FACTFinder.Core.Server.FileSystemDataProvider.html b/docs/classes/FACTFinder.Core.Server.FileSystemDataProvider.html
diff --git a/docs/classes/FACTFinder.Core.Server.FileSystemRequestFactory.html b/docs/classes/FACTFinder.Core.Server.FileSystemRequestFactory.html
diff --git a/docs/classes/FACTFinder.Core.Server.MultiCurlDataProvider.html b/docs/classes/FACTFinder.Core.Server.MultiCurlDataProvider.html
diff --git a/docs/classes/FACTFinder.Core.Server.MultiCurlRequestFactory.html b/docs/classes/FACTFinder.Core.Server.MultiCurlRequestFactory.html
diff --git a/docs/classes/FACTFinder.Core.Server.NullResponse.html b/docs/classes/FACTFinder.Core.Server.NullResponse.html
diff --git a/docs/classes/FACTFinder.Core.Server.Request.html b/docs/classes/FACTFinder.Core.Server.Request.html
diff --git a/docs/classes/FACTFinder.Core.Server.RequestFactoryInterface.html b/docs/classes/FACTFinder.Core.Server.RequestFactoryInterface.html
diff --git a/docs/classes/FACTFinder.Core.Server.Response.html b/docs/classes/FACTFinder.Core.Server.Response.html
diff --git a/docs/classes/FACTFinder.Core.Server.UrlBuilder.html b/docs/classes/FACTFinder.Core.Server.UrlBuilder.html
diff --git a/docs/classes/FACTFinder.Core.Utf8EncodingConverter.html b/docs/classes/FACTFinder.Core.Utf8EncodingConverter.html
diff --git a/docs/classes/FACTFinder.Core.XmlConfiguration.html b/docs/classes/FACTFinder.Core.XmlConfiguration.html
diff --git a/docs/classes/FACTFinder.Data.AdvisorAnswer.html b/docs/classes/FACTFinder.Data.AdvisorAnswer.html
diff --git a/docs/classes/FACTFinder.Data.AdvisorQuestion.html b/docs/classes/FACTFinder.Data.AdvisorQuestion.html
diff --git a/docs/classes/FACTFinder.Data.AfterSearchNavigation.html b/docs/classes/FACTFinder.Data.AfterSearchNavigation.html
diff --git a/docs/classes/FACTFinder.Data.ArticleNumberSearchStatus.html b/docs/classes/FACTFinder.Data.ArticleNumberSearchStatus.html
diff --git a/docs/classes/FACTFinder.Data.BreadCrumb.html b/docs/classes/FACTFinder.Data.BreadCrumb.html
diff --git a/docs/classes/FACTFinder.Data.BreadCrumbTrail.html b/docs/classes/FACTFinder.Data.BreadCrumbTrail.html
diff --git a/docs/classes/FACTFinder.Data.BreadCrumbType.html b/docs/classes/FACTFinder.Data.BreadCrumbType.html
diff --git a/docs/classes/FACTFinder.Data.Campaign.html b/docs/classes/FACTFinder.Data.Campaign.html
diff --git a/docs/classes/FACTFinder.Data.CampaignIterator.html b/docs/classes/FACTFinder.Data.CampaignIterator.html
diff --git a/docs/classes/FACTFinder.Data.Filter.html b/docs/classes/FACTFinder.Data.Filter.html
diff --git a/docs/classes/FACTFinder.Data.FilterGroup.html b/docs/classes/FACTFinder.Data.FilterGroup.html
diff --git a/docs/classes/FACTFinder.Data.FilterSelectionType.html b/docs/classes/FACTFinder.Data.FilterSelectionType.html
diff --git a/docs/classes/FACTFinder.Data.FilterStyle.html b/docs/classes/FACTFinder.Data.FilterStyle.html
diff --git a/docs/classes/FACTFinder.Data.FilterType.html b/docs/classes/FACTFinder.Data.FilterType.html
diff --git a/docs/classes/FACTFinder.Data.Item.html b/docs/classes/FACTFinder.Data.Item.html
diff --git a/docs/classes/FACTFinder.Data.Page.html b/docs/classes/FACTFinder.Data.Page.html
diff --git a/docs/classes/FACTFinder.Data.Paging.html b/docs/classes/FACTFinder.Data.Paging.html
diff --git a/docs/classes/FACTFinder.Data.Record.html b/docs/classes/FACTFinder.Data.Record.html
diff --git a/docs/classes/FACTFinder.Data.Result.html b/docs/classes/FACTFinder.Data.Result.html
diff --git a/docs/classes/FACTFinder.Data.ResultsPerPageOptions.html b/docs/classes/FACTFinder.Data.ResultsPerPageOptions.html
diff --git a/docs/classes/FACTFinder.Data.SearchParameters.html b/docs/classes/FACTFinder.Data.SearchParameters.html
diff --git a/docs/classes/FACTFinder.Data.SearchStatus.html b/docs/classes/FACTFinder.Data.SearchStatus.html
diff --git a/docs/classes/FACTFinder.Data.SingleWordSearchItem.html b/docs/classes/FACTFinder.Data.SingleWordSearchItem.html
diff --git a/docs/classes/FACTFinder.Data.SliderFilter.html b/docs/classes/FACTFinder.Data.SliderFilter.html
diff --git a/docs/classes/FACTFinder.Data.Sorting.html b/docs/classes/FACTFinder.Data.Sorting.html
diff --git a/docs/classes/FACTFinder.Data.SuggestQuery.html b/docs/classes/FACTFinder.Data.SuggestQuery.html
diff --git a/docs/classes/FACTFinder.Data.TagQuery.html b/docs/classes/FACTFinder.Data.TagQuery.html
diff --git a/docs/classes/FACTFinder.Loader.html b/docs/classes/FACTFinder.Loader.html
diff --git a/docs/classes/FACTFinder.Util.Curl.html b/docs/classes/FACTFinder.Util.Curl.html
diff --git a/docs/classes/FACTFinder.Util.CurlHandle.html b/docs/classes/FACTFinder.Util.CurlHandle.html
diff --git a/docs/classes/FACTFinder.Util.CurlInterface.html b/docs/classes/FACTFinder.Util.CurlInterface.html
diff --git a/docs/classes/FACTFinder.Util.CurlMultiHandle.html b/docs/classes/FACTFinder.Util.CurlMultiHandle.html
diff --git a/docs/classes/FACTFinder.Util.CurlStub.html b/docs/classes/FACTFinder.Util.CurlStub.html
diff --git a/docs/classes/FACTFinder.Util.Log4PhpLogger.html b/docs/classes/FACTFinder.Util.Log4PhpLogger.html
diff --git a/docs/classes/FACTFinder.Util.LoggerInterface.html b/docs/classes/FACTFinder.Util.LoggerInterface.html
diff --git a/docs/classes/FACTFinder.Util.NullLogger.html b/docs/classes/FACTFinder.Util.NullLogger.html
diff --git a/docs/classes/FACTFinder.Util.Parameters.html b/docs/classes/FACTFinder.Util.Parameters.html
diff --git a/docs/classes/FACTFinder.Util.Pimple.html b/docs/classes/FACTFinder.Util.Pimple.html
diff --git a/docs/files/Adapter.AbstractAdapter.html b/docs/files/Adapter.AbstractAdapter.html
diff --git a/docs/files/Adapter.Compare.html b/docs/files/Adapter.Compare.html
diff --git a/docs/files/Adapter.Import.html b/docs/files/Adapter.Import.html
diff --git a/docs/files/Adapter.ProductCampaign.html b/docs/files/Adapter.ProductCampaign.html
diff --git a/docs/files/Adapter.Recommendation.html b/docs/files/Adapter.Recommendation.html
diff --git a/docs/files/Adapter.Search.html b/docs/files/Adapter.Search.html
diff --git a/docs/files/Adapter.SimilarRecords.html b/docs/files/Adapter.SimilarRecords.html
diff --git a/docs/files/Adapter.Suggest.html b/docs/files/Adapter.Suggest.html
diff --git a/docs/files/Adapter.TagCloud.html b/docs/files/Adapter.TagCloud.html
diff --git a/docs/files/Adapter.Tracking.html b/docs/files/Adapter.Tracking.html
diff --git a/docs/files/Adapter/Search.php.txt b/docs/files/Adapter/Search.php.txt
@@ -135,13 +135,11 @@ class Search extends AbstractAdapter
         //init default values
         $records      = array();
         $resultCount = 0;
-        $refKey = null;
 
         $jsonData = $this->getResponseContent();
 
         if ($this->isValidResponse($jsonData)) {
             $searchResultData = $jsonData['searchResult'];
-            $refKey = $searchResultData['refKey'];
 
             if (!empty($searchResultData['records']))
             {
@@ -168,7 +166,6 @@ class Search extends AbstractAdapter
         return FF::getInstance(
             'Data\Result',
             $records,
-            $refKey,
             $resultCount
         );
     }

diff --git a/docs/files/Adapter/Tracking.php.txt b/docs/files/Adapter/Tracking.php.txt
@@ -41,20 +41,24 @@ class Tracking extends AbstractAdapter
      * not available, it will try to use session_id() to fetch one.
      *
      * @param string $sid session id
+     * @param string $userId id of user
      * @return bool Success?
      */
-    public function doTrackingFromRequest($sid = null)
+    public function doTrackingFromRequest($sid = null, $userId = null)
     {
-        $this->setupTrackingFromRequest($sid);
+        $this->setupTrackingFromRequest($sid, $userId);
         return $this->applyTracking();
     }
 
     /**
      * Use this method directly if you want to separate the setup from sending
      * the request. This is particularly useful when using the
      * MultiCurlRequestFactory.
+     *
+     * @param string $sid session id
+     * @param string $userId id of user
      */
-    public function setupTrackingFromRequest($sid = null)
+    public function setupTrackingFromRequest($sid = null, $userId = null)
     {
         if (strlen($sid) > 0)
             $this->parameters['sid'] = $sid;
@@ -63,6 +67,9 @@ class Tracking extends AbstractAdapter
         ) {
             $this->parameters['sid'] = session_id();
         }
+
+        if (strlen($userId) > 0)
+            $this->parameters['userId'] = $userId;
     }
 
     /**
@@ -80,7 +87,7 @@ class Tracking extends AbstractAdapter
      * @param string $title title of product (optional - is empty by default)
      * @param int $pageSize size of the page where the product was found (optional - is 12 by default)
      * @param int $origPageSize original size of the page before the user could have changed it (optional - is set equals to $page by default)
-     * @param string $userid id of user (optional if modul personalisation is not used)
+     * @param string $userId id of user (optional if modul personalisation is not used)
      * @return boolean $success
      */
     public function trackClick(
@@ -96,10 +103,10 @@ class Tracking extends AbstractAdapter
         $title = '',
         $pageSize = 12,
         $origPageSize = -1,
-        $userid = null
+        $userId = null
     ) {
         $this->setupClickTracking($id, $query, $pos, $masterId, $sid, $cookieId, $origPos, $page,
-                                  $simi, $title, $pageSize, $origPageSize, $userid);
+                                  $simi, $title, $pageSize, $origPageSize, $userId);
         return $this->applyTracking();
     }
 
@@ -121,7 +128,7 @@ class Tracking extends AbstractAdapter
         $title = '',
         $pageSize = 12,
         $origPageSize = -1,
-        $userid = null
+        $userId = null
     ) {
         if (strlen($sid) == 0) $sid = session_id();
         if ($origPos == -1) $origPos = $pos;
@@ -140,7 +147,7 @@ class Tracking extends AbstractAdapter
             'origPageSize'  => $origPageSize,
         );
 
-        if (strlen($userid) > 0) $params['userId'] = $userid;
+        if (strlen($userId) > 0) $params['userId'] = $userId;
         if (strlen($cookieId) > 0) $params['cookieId'] = $cookieId;
         if (strlen($masterId) > 0) $params['masterId'] = $masterId;
 
@@ -159,7 +166,7 @@ class Tracking extends AbstractAdapter
      * @param string $cookieId cookie id (optional)
      * @param int $count number of items purchased for each product (optional - default 1)
      * @param float $price this is the single unit price (optional)
-     * @param string $userid id of user (optional if modul personalisation is not used)
+     * @param string $userId id of user (optional if modul personalisation is not used)
      * @return boolean $success
      */
     public function trackCart(
@@ -171,9 +178,9 @@ class Tracking extends AbstractAdapter
         $cookieId = null,
         $count = 1,
         $price = null,
-        $userid = null
+        $userId = null
     ) {
-        $this->setupCartTracking($id, $masterId, $title, $query, $sid, $cookieId, $count, $price, $userid);
+        $this->setupCartTracking($id, $masterId, $title, $query, $sid, $cookieId, $count, $price, $userId);
         return $this->applyTracking();
     }
 
@@ -191,7 +198,7 @@ class Tracking extends AbstractAdapter
         $cookieId = null,
         $count = 1,
         $price = null,
-        $userid = null
+        $userId = null
     ) {
         if (strlen($sid) == 0) $sid = session_id();
         $params = array(
@@ -203,7 +210,7 @@ class Tracking extends AbstractAdapter
         );
 
         if (strlen($price) > 0) $params['price'] = $price;
-        if (strlen($userid) > 0) $params['userId'] = $userid;
+        if (strlen($userId) > 0) $params['userId'] = $userId;
         if (strlen($cookieId) > 0) $params['cookieId'] = $cookieId;
         if (strlen($masterId) > 0) $params['masterId'] = $masterId;
         if (strlen($query) > 0) $params['query'] = $query;
@@ -223,7 +230,7 @@ class Tracking extends AbstractAdapter
      * @param string $cookieId cookie id (optional)
      * @param int $count number of items purchased for each product (optional - default 1)
      * @param float $price this is the single unit price (optional)
-     * @param string $userid id of user (optional if modul personalisation is not used)
+     * @param string $userId id of user (optional if modul personalisation is not used)
      * @return boolean $success
      */
     public function trackCheckout(
@@ -235,9 +242,9 @@ class Tracking extends AbstractAdapter
         $cookieId = null,
         $count = 1,
         $price = null,
-        $userid = null
+        $userId = null
     ) {
-        $this->setupCheckoutTracking($id, $masterId, $title, $query, $sid, $cookieId, $count, $price, $userid);
+        $this->setupCheckoutTracking($id, $masterId, $title, $query, $sid, $cookieId, $count, $price, $userId);
         return $this->applyTracking();
     }
 
@@ -255,7 +262,7 @@ class Tracking extends AbstractAdapter
         $cookieId = null,
         $count = 1,
         $price = null,
-        $userid = null
+        $userId = null
     ) {
         if (strlen($sid) == 0) $sid = session_id();
         $params = array(
@@ -268,7 +275,7 @@ class Tracking extends AbstractAdapter
         );
 
         if (strlen($price) > 0) $params['price'] = $price;
-        if (strlen($userid) > 0) $params['userId'] = $userid;
+        if (strlen($userId) > 0) $params['userId'] = $userId;
         if (strlen($cookieId) > 0) $params['cookieId'] = $cookieId;
         if (strlen($query) > 0) $params['query'] = $query;
         if (strlen($masterId) > 0) $params['masterId'] = $masterId;
@@ -285,7 +292,7 @@ class Tracking extends AbstractAdapter
      * @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)
+     * @param string $userId id of user (optional if modul personalisation is not used)
      * @return boolean $success
      */
     public function trackRecommendationClick(
@@ -294,9 +301,9 @@ class Tracking extends AbstractAdapter
         $masterId = null,
         $sid = null,
         $cookieId = null,
-        $userid = null
+        $userId = null
     ) {
-        $this->setupRecommendationClickTracking($id, $mainId, $masterId, $sid, $cookieId, $userid);
+        $this->setupRecommendationClickTracking($id, $mainId, $masterId, $sid, $cookieId, $userId);
         return $this->applyTracking();
     }
 
@@ -311,7 +318,7 @@ class Tracking extends AbstractAdapter
         $masterId = null,
         $sid = null,
         $cookieId = null,
-        $userid = null
+        $userId = null
     ) {
         if (strlen($sid) == 0) $sid = session_id();
         $params = array(
@@ -323,7 +330,7 @@ class Tracking extends AbstractAdapter
             'event'     => 'recommendationClick'
         );
 
-        if (strlen($userid) > 0) $params['userId'] = $userid;
+        if (strlen($userId) > 0) $params['userId'] = $userId;
         if (strlen($cookieId) > 0) $params['cookieId'] = $cookieId;
         if (strlen($masterId) > 0) $params['masterId'] = $masterId;
 
@@ -336,15 +343,15 @@ class Tracking extends AbstractAdapter
      *
      * @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 who logged in
+     * @param string $userId id of user who logged in
      * @return boolean $success
      */
     public function trackLogin(
         $sid = null,
         $cookieId = null,
-        $userid = null
+        $userId = null
     ) {
-        $this->setupLoginTracking($sid, $cookieId, $userid);
+        $this->setupLoginTracking($sid, $cookieId, $userId);
         return $this->applyTracking();
     }
 
@@ -356,12 +363,12 @@ class Tracking extends AbstractAdapter
     public function setupLoginTracking(
         $sid = null,
         $cookieId = null,
-        $userid = null
+        $userId = null
     ) {
         if (strlen($sid) == 0) $sid = session_id();
         $params = array(
             'sid'       => $sid,
-            'userId'    => $userid,
+            'userId'    => $userId,
             'event'     => 'login'
         );