Merge pull request #1029 from magento-engcom/develop-prs-isolated

vrann · web-flow · commit 45dce690f9bc · 2017-04-17T22:32:45.000-05:00
[Engcom] SSL for AMQP and @api annotations for URLRewrite and Indexer
diff --git a/app/code/Magento/Catalog/Model/Category.php b/app/code/Magento/Catalog/Model/Category.php
@@ -116,6 +116,7 @@ class Category extends \Magento\Catalog\Model\AbstractModel implements
      * URL rewrite model
      *
      * @var \Magento\UrlRewrite\Model\UrlRewrite
+     * @deprecated since 2.2.0
      */
     protected $_urlRewrite;
 
diff --git a/app/code/Magento/CatalogUrlRewrite/Model/Map/DatabaseMapInterface.php b/app/code/Magento/CatalogUrlRewrite/Model/Map/DatabaseMapInterface.php
@@ -5,8 +5,6 @@
  */
 namespace Magento\CatalogUrlRewrite\Model\Map;
 
-use Magento\Framework\DB\Select;
-
 /**
  * Interface for a mysql data type of a map
  *
diff --git a/app/code/Magento/Indexer/Model/Processor/Handler.php b/app/code/Magento/Indexer/Model/Processor/Handler.php
diff --git a/app/code/Magento/UrlRewrite/Model/MergeDataProvider.php b/app/code/Magento/UrlRewrite/Model/MergeDataProvider.php
@@ -11,6 +11,7 @@
  * This class is to be used as a container for new generated url rewrites by adding new ones using merge method
  * Removes duplicates for a set/array of Url Rewrites based on the unique key of the url_rewrites table
  *
+ * @api
  */
 class MergeDataProvider
 {
diff --git a/app/code/Magento/UrlRewrite/Model/StorageInterface.php b/app/code/Magento/UrlRewrite/Model/StorageInterface.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\UrlRewrite\Model;
 
+/**
+ * @api
+ */
 interface StorageInterface extends UrlFinderInterface, UrlPersistInterface
 {
 }
diff --git a/app/code/Magento/UrlRewrite/Model/UrlFinderInterface.php b/app/code/Magento/UrlRewrite/Model/UrlFinderInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Url Finder Interface
+ * @api
  */
 interface UrlFinderInterface
 {
diff --git a/app/code/Magento/UrlRewrite/Model/UrlPersistInterface.php b/app/code/Magento/UrlRewrite/Model/UrlPersistInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Url Persist Interface
+ * @api
  */
 interface UrlPersistInterface
 {
diff --git a/app/code/Magento/UrlRewrite/Service/V1/Data/UrlRewrite.php b/app/code/Magento/UrlRewrite/Service/V1/Data/UrlRewrite.php
@@ -11,6 +11,7 @@
 
 /**
  * Data abstract class for url storage
+ * @api
  */
 class UrlRewrite extends AbstractSimpleObject
 {
diff --git a/lib/internal/Magento/Framework/Indexer/ActionFactory.php b/lib/internal/Magento/Framework/Indexer/ActionFactory.php
@@ -5,8 +5,6 @@
  */
 namespace Magento\Framework\Indexer;
 
-use Magento\Framework\Indexer\ActionInterface;
-
 class ActionFactory
 {
     /**
diff --git a/lib/internal/Magento/Framework/Indexer/ActionInterface.php b/lib/internal/Magento/Framework/Indexer/ActionInterface.php
@@ -6,7 +6,7 @@
 namespace Magento\Framework\Indexer;
 
 /**
- * @api
+ * @api Implement custom Action Interface
  */
 interface ActionInterface
 {
diff --git a/lib/internal/Magento/Framework/Indexer/BatchProviderInterface.php b/lib/internal/Magento/Framework/Indexer/BatchProviderInterface.php
@@ -13,6 +13,8 @@
  *
  * Can be used during indexation process to split large amount of data into batches
  * and process them one by one in order to reduce memory consumption and improve overall performance.
+ *
+ * @api retrieve Batches when implementing custom Indexer\Action
  */
 interface BatchProviderInterface
 {
diff --git a/lib/internal/Magento/Framework/Indexer/FieldsetInterface.php b/lib/internal/Magento/Framework/Indexer/FieldsetInterface.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Framework\Indexer;
 
+/**
+ * @api Implement custom Fieldset
+ */
 interface FieldsetInterface
 {
     /**
diff --git a/lib/internal/Magento/Framework/Indexer/FieldsetPool.php b/lib/internal/Magento/Framework/Indexer/FieldsetPool.php
@@ -7,6 +7,9 @@
 
 use Magento\Framework\ObjectManagerInterface;
 
+/**
+ * @api Retrieve Fieldset when implementing custom Indexer\Action
+ */
 class FieldsetPool
 {
     /**
diff --git a/lib/internal/Magento/Framework/Indexer/FilterInterface.php b/lib/internal/Magento/Framework/Indexer/FilterInterface.php
diff --git a/lib/internal/Magento/Framework/Indexer/HandlerInterface.php b/lib/internal/Magento/Framework/Indexer/HandlerInterface.php
@@ -7,6 +7,9 @@
 
 use Magento\Framework\App\ResourceConnection\SourceProviderInterface;
 
+/**
+ * @api Implement custom Handler
+ */
 interface HandlerInterface
 {
     /**
diff --git a/lib/internal/Magento/Framework/Indexer/HandlerPool.php b/lib/internal/Magento/Framework/Indexer/HandlerPool.php
@@ -8,6 +8,9 @@
 use Magento\Framework\Indexer\Handler\DefaultHandler;
 use Magento\Framework\ObjectManagerInterface;
 
+/**
+ * @api Instantiate save handler when implementing custom Indexer\Action
+ */
 class HandlerPool
 {
     /**
diff --git a/lib/internal/Magento/Framework/Indexer/IndexerRegistry.php b/lib/internal/Magento/Framework/Indexer/IndexerRegistry.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Framework\Indexer;
 
+/**
+ * @api Retrieve indexer by id, for example when indexer need to be invalidated
+ */
 class IndexerRegistry
 {
     /**
diff --git a/lib/internal/Magento/Framework/Indexer/SaveHandlerFactory.php b/lib/internal/Magento/Framework/Indexer/SaveHandlerFactory.php
@@ -9,6 +9,9 @@
 use Magento\Framework\ObjectManagerInterface;
 use Magento\Framework\Indexer\SaveHandler\IndexerInterface as SaveHandlerInterface;
 
+/**
+ * @api Instantiate save handler when implementing custom Indexer\Action
+ */
 class SaveHandlerFactory
 {
     /**
diff --git a/lib/internal/Magento/Framework/Indexer/StateInterface.php b/lib/internal/Magento/Framework/Indexer/StateInterface.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Framework\Indexer;
 
+/**
+ * @api Retrieve status of the Indexer
+ */
 interface StateInterface
 {
     /**
diff --git a/lib/internal/Magento/Framework/Indexer/Table/Strategy.php b/lib/internal/Magento/Framework/Indexer/Table/Strategy.php
@@ -5,10 +5,6 @@
  */
 namespace Magento\Framework\Indexer\Table;
 
-/**
- * Class Strategy
- * @package Magento\Indexer
- */
 class Strategy implements StrategyInterface
 {
     /**
diff --git a/lib/internal/Magento/Framework/Indexer/Table/StrategyInterface.php b/lib/internal/Magento/Framework/Indexer/Table/StrategyInterface.php
@@ -6,10 +6,6 @@
 
 namespace Magento\Framework\Indexer\Table;
 
-/**
- * Interface StrategyInterface
- * @package Magento\Indexer
- */
 interface StrategyInterface
 {
     const IDX_SUFFIX = '_idx';
diff --git a/lib/internal/Magento/Framework/Mview/View/SubscriptionFactory.php b/lib/internal/Magento/Framework/Mview/View/SubscriptionFactory.php
@@ -5,11 +5,6 @@
  */
 namespace Magento\Framework\Mview\View;
 
-/**
- * Class SubscriptionFactory
- * @package Magento\Framework\Mview\View
- *
- */
 class SubscriptionFactory extends AbstractFactory
 {
     /**

Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,7 @@ class Category extends \Magento\Catalog\Model\AbstractModel implements`
`116`	`116`	`* URL rewrite model`
`117`	`117`	`*`
`118`	`118`	`* @var \Magento\UrlRewrite\Model\UrlRewrite`
	`119`	`+ * @deprecated since 2.2.0`
`119`	`120`	`*/`
`120`	`121`	`protected $_urlRewrite;`
`121`	`122`
Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,6 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\CatalogUrlRewrite\Model\Map;`
`7`	`7`
`8`		`-use Magento\Framework\DB\Select;`
`9`		`-`
`10`	`8`	`/**`
`11`	`9`	`* Interface for a mysql data type of a map`
`12`	`10`	`*`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`	`* This class is to be used as a container for new generated url rewrites by adding new ones using merge method`
`12`	`12`	`* Removes duplicates for a set/array of Url Rewrites based on the unique key of the url_rewrites table`
`13`	`13`	`*`
	`14`	`+ * @api`
`14`	`15`	`*/`
`15`	`16`	`class MergeDataProvider`
`16`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\UrlRewrite\Model;`
`7`	`7`
	`8`	`+/**`
	`9`	`+ * @api`
	`10`	`+ */`
`8`	`11`	`interface StorageInterface extends UrlFinderInterface, UrlPersistInterface`
`9`	`12`	`{`
`10`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Url Finder Interface`
	`10`	`+ * @api`
`10`	`11`	`*/`
`11`	`12`	`interface UrlFinderInterface`
`12`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Url Persist Interface`
	`10`	`+ * @api`
`10`	`11`	`*/`
`11`	`12`	`interface UrlPersistInterface`
`12`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,6 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\Framework\Indexer;`
`7`	`7`
`8`		`-use Magento\Framework\Indexer\ActionInterface;`
`9`		`-`
`10`	`8`	`class ActionFactory`
`11`	`9`	`{`
`12`	`10`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`namespace Magento\Framework\Indexer;`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * @api`
	`9`	`+ * @api Implement custom Action Interface`
`10`	`10`	`*/`
`11`	`11`	`interface ActionInterface`
`12`	`12`	`{`