Merge remote-tracking branch 'mainline/develop' into MAGETWO-70191-PR-1563

Oleksii Korshenko · Oleksii Korshenko · commit 48493c16a6a9 · 2017-06-27T10:29:30.000-05:00
diff --git a/Block/Adminhtml/System/Config/TestConnection.php b/Block/Adminhtml/System/Config/TestConnection.php
@@ -7,7 +7,7 @@
 
 /**
  * Search engine test connection block
- *
+ * @api
  */
 class TestConnection extends \Magento\Config\Block\System\Config\Form\Field
 {
diff --git a/Model/Adminhtml/Search/Grid/Options.php b/Model/Adminhtml/Search/Grid/Options.php
@@ -7,6 +7,9 @@
  */
 namespace Magento\AdvancedSearch\Model\Adminhtml\Search\Grid;
 
+/**
+ * @api
+ */
 class Options implements \Magento\Framework\Option\ArrayInterface
 {
     /**
diff --git a/Model/Client/ClientFactoryInterface.php b/Model/Client/ClientFactoryInterface.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\AdvancedSearch\Model\Client;
 
+/**
+ * @api
+ */
 interface ClientFactoryInterface
 {
     /**
diff --git a/Model/Client/ClientInterface.php b/Model/Client/ClientInterface.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\AdvancedSearch\Model\Client;
 
+/**
+ * @api
+ */
 interface ClientInterface
 {
     /**
diff --git a/Model/Client/ClientOptionsInterface.php b/Model/Client/ClientOptionsInterface.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\AdvancedSearch\Model\Client;
 
+/**
+ * @api
+ */
 interface ClientOptionsInterface
 {
     /**
diff --git a/Model/Client/ClientResolver.php b/Model/Client/ClientResolver.php
@@ -8,6 +8,9 @@
 use \Magento\Framework\ObjectManagerInterface;
 use \Magento\Framework\App\Config\ScopeConfigInterface;
 
+/**
+ * @api
+ */
 class ClientResolver
 {
     /**
diff --git a/Model/Recommendations/DataProvider.php b/Model/Recommendations/DataProvider.php
@@ -12,8 +12,22 @@
 
 class DataProvider implements SuggestedQueriesInterface
 {
+    /**
+     * @deprecated
+     * @see SuggestedQueriesInterface::SEARCH_RECOMMENDATIONS_ENABLED
+     */
     const CONFIG_IS_ENABLED = 'catalog/search/search_recommendations_enabled';
+
+    /**
+     * @deprecated
+     * @see SuggestedQueriesInterface::SEARCH_RECOMMENDATIONS_COUNT_RESULTS_ENABLED
+     */
     const CONFIG_RESULTS_COUNT_ENABLED = 'catalog/search/search_recommendations_count_results_enabled';
+
+    /**
+     * @deprecated
+     * @see SuggestedQueriesInterface::SEARCH_RECOMMENDATIONS_COUNT
+     */
     const CONFIG_RESULTS_COUNT = 'catalog/search/search_recommendations_count';
 
     /**
diff --git a/Model/ResourceModel/Index.php b/Model/ResourceModel/Index.php
@@ -11,6 +11,9 @@
 use Magento\Framework\EntityManager\MetadataPool;
 use Magento\Catalog\Api\Data\CategoryInterface;
 
+/**
+ * @api
+ */
 class Index extends AbstractDb
 {
     /**
diff --git a/Model/ResourceModel/Recommendations.php b/Model/ResourceModel/Recommendations.php
@@ -9,6 +9,7 @@
  * Catalog search recommendations resource model
  *
  * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Recommendations extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 {
diff --git a/Model/ResourceModel/Search/Grid/Collection.php b/Model/ResourceModel/Search/Grid/Collection.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\AdvancedSearch\Model\ResourceModel\Search\Grid;
 
+/**
+ * @api
+ */
 class Collection extends \Magento\Search\Model\ResourceModel\Query\Collection
 {
     /**
diff --git a/Model/SuggestedQueriesInterface.php b/Model/SuggestedQueriesInterface.php
@@ -7,8 +7,27 @@
 
 use Magento\Search\Model\QueryInterface;
 
+/**
+ * @api
+ */
 interface SuggestedQueriesInterface
 {
+    /**#@+
+     * Recommendations settings config paths
+     */
+    const SEARCH_RECOMMENDATIONS_ENABLED = 'catalog/search/search_recommendations_enabled';
+    const SEARCH_RECOMMENDATIONS_COUNT_RESULTS_ENABLED = 'catalog/search/search_recommendations_count_results_enabled';
+    const SEARCH_RECOMMENDATIONS_COUNT = 'catalog/search/search_recommendations_count';
+    /**#@-*/
+
+    /**#@+
+     * Suggestions settings config paths
+     */
+    const SEARCH_SUGGESTION_COUNT = 'catalog/search/search_suggestion_count';
+    const SEARCH_SUGGESTION_COUNT_RESULTS_ENABLED = 'catalog/search/search_suggestion_count_results_enabled';
+    const SEARCH_SUGGESTION_ENABLED = 'catalog/search/search_suggestion_enabled';
+    /**#@-*/
+
     /**
      * @param QueryInterface $query
      * @return \Magento\Search\Model\QueryResult[]
diff --git a/view/adminhtml/web/js/testconnection.js b/view/adminhtml/web/js/testconnection.js
@@ -2,6 +2,10 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
+/**
+ * @api
+ */
 define([
     'jquery',
     'Magento_Ui/js/modal/alert',

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Search engine test connection block`
`10`		`- *`
	`10`	`+ * @api`
`11`	`11`	`*/`
`12`	`12`	`class TestConnection extends \Magento\Config\Block\System\Config\Form\Field`
`13`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`	`*/`
`8`	`8`	`namespace Magento\AdvancedSearch\Model\Adminhtml\Search\Grid;`
`9`	`9`
	`10`	`+/**`
	`11`	`+ * @api`
	`12`	`+ */`
`10`	`13`	`class Options implements \Magento\Framework\Option\ArrayInterface`
`11`	`14`	`{`
`12`	`15`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\AdvancedSearch\Model\Client;`
`7`	`7`
	`8`	`+/**`
	`9`	`+ * @api`
	`10`	`+ */`
`8`	`11`	`interface ClientFactoryInterface`
`9`	`12`	`{`
`10`	`13`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,9 @@`
`8`	`8`	`use \Magento\Framework\ObjectManagerInterface;`
`9`	`9`	`use \Magento\Framework\App\Config\ScopeConfigInterface;`
`10`	`10`
	`11`	`+/**`
	`12`	`+ * @api`
	`13`	`+ */`
`11`	`14`	`class ClientResolver`
`12`	`15`	`{`
`13`	`16`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@`
`11`	`11`	`use Magento\Framework\EntityManager\MetadataPool;`
`12`	`12`	`use Magento\Catalog\Api\Data\CategoryInterface;`
`13`	`13`
	`14`	`+/**`
	`15`	`+ * @api`
	`16`	`+ */`
`14`	`17`	`class Index extends AbstractDb`
`15`	`18`	`{`
`16`	`19`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`* Catalog search recommendations resource model`
`10`	`10`	`*`
`11`	`11`	`* @author Magento Core Team <[email protected]>`
	`12`	`+ * @api`
`12`	`13`	`*/`
`13`	`14`	`class Recommendations extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb`
`14`	`15`	`{`