Deprecate site_url param (#104)

* deprecate site_url * version composer * composer.lock
doofinder · Mar 13, 2023 · c3021fa · c3021fa
1 parent 0999eca
commit c3021fa
Show file tree

Hide file tree

Showing 11 changed files with 93 additions and 49 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [7.0.4] - 2023-03-13
+### Changed
+- Deprecated "site_url" field in Search Engine object
+
 ## [7.0.3] - 2022-11-21
 ### Changed
 - Updated the "Installation & Usage" section of the readmes

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
   "name": "doofinder/php-doofinder",
-  "version": "7.0.3",
+  "version": "7.0.4",
   "type": "library",
   "description": "Doofinder PHP API Client",
   "keywords": [

diff --git a/composer.lock b/composer.lock
diff --git a/doc/classes/Doofinder-Management-ManagementClient.html b/doc/classes/Doofinder-Management-ManagementClient.html
@@ -1096,7 +1096,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
 'currency' =&gt; string, // Default: &quot;EUR&quot; (&quot;AED&quot;, &quot;ARS&quot;, &quot;AUD&quot;, &quot;BAM&quot;, &quot;BDT&quot;, &quot;BGN&quot;, &quot;BOB&quot;, &quot;BRL&quot;, &quot;BYN&quot;, &quot;CAD&quot;, &quot;CHF&quot;, &quot;CLP&quot;, &quot;CNY&quot;, &quot;COP&quot;, &quot;CZK&quot;, &quot;DKK&quot;, &quot;DOP&quot;, &quot;EGP&quot;, &quot;EUR&quot;, &quot;GBP&quot;, &quot;HKD&quot;, &quot;HRK&quot;, &quot;HUF&quot;, &quot;IDR&quot;, &quot;ILS&quot;, &quot;INR&quot;, &quot;IRR&quot;, &quot;ISK&quot;, &quot;JPY&quot;, &quot;KRW&quot;, &quot;KWD&quot;, &quot;MXN&quot;, &quot;MYR&quot;, &quot;NOK&quot;, &quot;NZD&quot;, &quot;PEN&quot;, &quot;PLN&quot;, &quot;RON&quot;, &quot;RSD&quot;, &quot;RUB&quot;, &quot;SAR&quot;, &quot;SEK&quot;, &quot;TRY&quot;, &quot;TWD&quot;, &quot;UAH&quot;, &quot;USD&quot;, &quot;VEF&quot;, &quot;VND&quot;, &quot;XPF&quot;, &quot;ZAR&quot;)
 'language' =&gt; string, // (&quot;ar&quot;, &quot;hy&quot;, &quot;eu&quot;, &quot;pt-br&quot;, &quot;bg&quot;, &quot;ca&quot;, &quot;cs&quot;, &quot;da&quot;, &quot;nl&quot;, &quot;en&quot;, &quot;fi&quot;, &quot;fr&quot;, &quot;de&quot;, &quot;el&quot;, &quot;hi&quot;, &quot;hu&quot;, &quot;id&quot;, &quot;it&quot;, &quot;no&quot;, &quot;pt&quot;, &quot;ro&quot;, &quot;ru&quot;, &quot;es&quot;, &quot;sv&quot;, &quot;tr&quot;),
 'name' =&gt; string,
-'site_url' =&gt; string|null,
+'site_url' =&gt; string|null, // Deprecated
 'stopwords' =&gt; boolean Default: false,
 'platform' =&gt; string, // Default: (&quot;api&quot;, &quot;api&quot;, &quot;shopify&quot;, &quot;woocommerce&quot;, &quot;bigcommerce&quot;, &quot;crawler&quot;, &quot;ecommerce&quot;, &quot;ekm&quot;, &quot;file&quot;, &quot;magento&quot;, &quot;magento2&quot;, &quot;opencart&quot;, &quot;oscommerce&quot;, &quot;prestashop&quot;, &quot;shopify&quot;),
 'has_grouping' =&gt; boolean, // Default: false
@@ -1121,7 +1121,7 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
 'currency' =&gt; string,
 'language' =&gt; string,
 'name' =&gt; string,
-'site_url' =&gt; string|null,
+'site_url' =&gt; string|null, // Deprecated
 'stopwords' =&gt; boolean Default: false,
 'platform' =&gt; string,
 'has_grouping' =&gt; boolean,

diff --git a/doc/classes/Doofinder-Management-Model-SearchEngine.html b/doc/classes/Doofinder-Management-Model-SearchEngine.html
@@ -384,7 +384,7 @@ <h4 class="phpdocumentor-element__name" id="property_hasGrouping">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">65</span>
+    <span class="phpdocumentor-element-found-in__line">66</span>
 
     </aside>
 
@@ -576,7 +576,7 @@ <h4 class="phpdocumentor-element__name" id="property_platform">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">60</span>
+    <span class="phpdocumentor-element-found-in__line">61</span>
 
     </aside>
 
@@ -629,7 +629,7 @@ <h4 class="phpdocumentor-element__name" id="property_searchUrl">
             phpdocumentor-element
             -property
             -private
-                                                        "
+                        -deprecated                                "
 >
     <h4 class="phpdocumentor-element__name" id="property_siteUrl">
         $siteUrl
@@ -640,12 +640,12 @@ <h4 class="phpdocumentor-element__name" id="property_siteUrl">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">50</span>
+    <span class="phpdocumentor-element-found-in__line">51</span>
 
     </aside>
 
 
-    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
     <span class="phpdocumentor-signature__visibility">private</span>
         <span class="phpdocumentor-signature__type">string|null</span>
     <span class="phpdocumentor-signature__name">$siteUrl</span>
@@ -654,6 +654,20 @@ <h4 class="phpdocumentor-element__name" id="property_siteUrl">
 
 
 
+    <h5 class="phpdocumentor-tag-list__heading" id="tags">
+        Tags
+        <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
+    </h5>
+    <dl class="phpdocumentor-tag-list">
+                                    <dt class="phpdocumentor-tag-list__entry">
+                    <span class="phpdocumentor-tag__name">deprecated</span>
+                </dt>
+                <dd class="phpdocumentor-tag-list__definition">
+                                            <span class="phpdocumentor-tag-link">7.0.4</span>
+
+
+                                    </dd>
+                        </dl>
 
 </article>
                     <article
@@ -672,7 +686,7 @@ <h4 class="phpdocumentor-element__name" id="property_stopwords">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">55</span>
+    <span class="phpdocumentor-element-found-in__line">56</span>
 
     </aside>
 
@@ -708,7 +722,7 @@ <h4 class="phpdocumentor-element__name" id="method_createFromArray">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">97</span>
+    <span class="phpdocumentor-element-found-in__line">98</span>
 
     </aside>
 
@@ -750,7 +764,7 @@ <h4 class="phpdocumentor-element__name" id="method_getCurrency">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">117</span>
+    <span class="phpdocumentor-element-found-in__line">118</span>
 
     </aside>
 
@@ -782,7 +796,7 @@ <h4 class="phpdocumentor-element__name" id="method_getHashid">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">125</span>
+    <span class="phpdocumentor-element-found-in__line">126</span>
 
     </aside>
 
@@ -814,7 +828,7 @@ <h4 class="phpdocumentor-element__name" id="method_getIndices">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">133</span>
+    <span class="phpdocumentor-element-found-in__line">134</span>
 
     </aside>
 
@@ -846,7 +860,7 @@ <h4 class="phpdocumentor-element__name" id="method_getLanguage">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">149</span>
+    <span class="phpdocumentor-element-found-in__line">150</span>
 
     </aside>
 
@@ -878,7 +892,7 @@ <h4 class="phpdocumentor-element__name" id="method_getName">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">157</span>
+    <span class="phpdocumentor-element-found-in__line">158</span>
 
     </aside>
 
@@ -910,7 +924,7 @@ <h4 class="phpdocumentor-element__name" id="method_getPlatform">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">189</span>
+    <span class="phpdocumentor-element-found-in__line">191</span>
 
     </aside>
 
@@ -942,7 +956,7 @@ <h4 class="phpdocumentor-element__name" id="method_getSearchUrl">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">165</span>
+    <span class="phpdocumentor-element-found-in__line">166</span>
 
     </aside>
 
@@ -965,7 +979,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
         class="phpdocumentor-element
             -method
             -public
-                                                        "
+            -deprecated                                            "
 >
     <h4 class="phpdocumentor-element__name" id="method_getSiteUrl">
         getSiteUrl()
@@ -974,18 +988,32 @@ <h4 class="phpdocumentor-element__name" id="method_getSiteUrl">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">173</span>
+    <span class="phpdocumentor-element-found-in__line">175</span>
 
     </aside>
 
 
-    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
     <span class="phpdocumentor-signature__visibility">public</span>
                 <span class="phpdocumentor-signature__name">getSiteUrl</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
 
 
 
 
+    <h5 class="phpdocumentor-tag-list__heading" id="tags">
+        Tags
+        <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
+    </h5>
+    <dl class="phpdocumentor-tag-list">
+                                    <dt class="phpdocumentor-tag-list__entry">
+                    <span class="phpdocumentor-tag__name">deprecated</span>
+                </dt>
+                <dd class="phpdocumentor-tag-list__definition">
+                                            <span class="phpdocumentor-tag-link">7.0.4</span>
+
+
+                                    </dd>
+                        </dl>
 
         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
     <span class="phpdocumentor-signature__response_type">string|null</span>
@@ -1006,7 +1034,7 @@ <h4 class="phpdocumentor-element__name" id="method_isHasGrouping">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">197</span>
+    <span class="phpdocumentor-element-found-in__line">199</span>
 
     </aside>
 
@@ -1038,7 +1066,7 @@ <h4 class="phpdocumentor-element__name" id="method_isInactive">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">141</span>
+    <span class="phpdocumentor-element-found-in__line">142</span>
 
     </aside>
 
@@ -1070,7 +1098,7 @@ <h4 class="phpdocumentor-element__name" id="method_isStopwords">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">181</span>
+    <span class="phpdocumentor-element-found-in__line">183</span>
 
     </aside>
 
@@ -1102,7 +1130,7 @@ <h4 class="phpdocumentor-element__name" id="method_jsonSerialize">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">205</span>
+    <span class="phpdocumentor-element-found-in__line">207</span>
 
     </aside>
 
@@ -1134,7 +1162,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Management/Model/SearchEngine.php"><a href="files/src-management-model-searchengine.html"><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">67</span>
+    <span class="phpdocumentor-element-found-in__line">68</span>
 
     </aside>
 

diff --git a/doc/reports/deprecated.html b/doc/reports/deprecated.html
@@ -99,10 +99,32 @@ <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Fil
     <div class="phpdocumentor-row">
         <h2 class="phpdocumentor-content__title">Deprecated</h2>
 
+                <h3>Table of Contents</h3>
+        <table class="phpdocumentor-table_of_contents">
+                            <tr>
+                    <td class="phpdocumentor-cell"><a href="reports/deprecated.html#src/Management/Model/SearchEngine.php">src/Management/Model/SearchEngine.php</a></td>
+                </tr>
+                    </table>
 
-                    <div class="phpdocumentor-admonition phpdocumentor-admonition--success">
-                No deprecated elements have been found in this project.
-            </div>
+                    <a id="src/Management/Model/SearchEngine.php"></a>
+            <h3><abbr title="src/Management/Model/SearchEngine.php">SearchEngine.php</abbr></h3>
+            <table>
+                <tr>
+                    <th class="phpdocumentor-heading">Line</th>
+                    <th class="phpdocumentor-heading">Element</th>
+                    <th class="phpdocumentor-heading">Reason</th>
+                </tr>
+                                                            <tr>
+                            <td class="phpdocumentor-cell">175</td>
+                            <td class="phpdocumentor-cell"><a href="classes/Doofinder-Management-Model-SearchEngine.html#method_getSiteUrl"><abbr title="\Doofinder\Management\Model\SearchEngine::getSiteUrl()">SearchEngine::getSiteUrl()</abbr></a></td>
+                            <td class="phpdocumentor-cell"></td>
+                        </tr>
+                                                                                <tr>
+                            <td class="phpdocumentor-cell">51</td>
+                            <td class="phpdocumentor-cell"><a href="classes/Doofinder-Management-Model-SearchEngine.html#property_siteUrl"><abbr title="\Doofinder\Management\Model\SearchEngine::$siteUrl">SearchEngine::$siteUrl</abbr></a></td>
+                            <td class="phpdocumentor-cell"></td>
+                        </tr>
+                                                </table>
             </div>
                 <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
     <section class="phpdocumentor-search-results__dialog">

diff --git a/src/Management/ManagementClient.php b/src/Management/ManagementClient.php
@@ -67,7 +67,7 @@ public static function create($host, $token, $userId)
      *  'currency' => string,
      *  'language' => string,
      *  'name' => string,
-     *  'site_url' => string|null,
+     *  'site_url' => string|null, // Deprecated
      *  'stopwords' => boolean Default: false,
      *  'platform' => string,
      *  'has_grouping' => boolean,
@@ -77,7 +77,7 @@ public static function create($host, $token, $userId)
      *  'currency' => string, // Default: "EUR" ("AED", "ARS", "AUD", "BAM", "BDT", "BGN", "BOB", "BRL", "BYN", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "DOP", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "IRR", "ISK", "JPY", "KRW", "KWD", "MXN", "MYR", "NOK", "NZD", "PEN", "PLN", "RON", "RSD", "RUB", "SAR", "SEK", "TRY", "TWD", "UAH", "USD", "VEF", "VND", "XPF", "ZAR")
      *  'language' => string, // ("ar", "hy", "eu", "pt-br", "bg", "ca", "cs", "da", "nl", "en", "fi", "fr", "de", "el", "hi", "hu", "id", "it", "no", "pt", "ro", "ru", "es", "sv", "tr"),
      *  'name' => string,
-     *  'site_url' => string|null,
+     *  'site_url' => string|null, // Deprecated
      *  'stopwords' => boolean Default: false,
      *  'platform' => string, // Default: ("api", "api", "shopify", "woocommerce", "bigcommerce", "crawler", "ecommerce", "ekm", "file", "magento", "magento2", "opencart", "oscommerce", "prestashop", "shopify"),
      *  'has_grouping' => boolean, // Default: false