Merge pull request #7571 from magento-commerce/api-changes-develop

[Lynx] Add Missing API Declaration
magento · Apr 19, 2022 · 76ca822 · 76ca822
2 parents 66bb1e1 + 040dbee
commit 76ca822
Show file tree

Hide file tree

Showing 728 changed files with 1,961 additions and 240 deletions.
diff --git a/app/code/Magento/AdvancedSearch/Block/SearchDataInterface.php b/app/code/Magento/AdvancedSearch/Block/SearchDataInterface.php
@@ -3,11 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\AdvancedSearch\Block;
 
 /**
  * Interface \Magento\AdvancedSearch\Block\SearchDataInterface
  *
+ * @api
  */
 interface SearchDataInterface
 {

diff --git a/app/code/Magento/Analytics/Api/Data/LinkInterface.php b/app/code/Magento/Analytics/Api/Data/LinkInterface.php
@@ -3,10 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Analytics\Api\Data;
 
 /**
  * Represents link with collected data and initialized vector for decryption.
+ *
+ * @api
  */
 interface LinkInterface
 {

diff --git a/app/code/Magento/Analytics/Api/LinkProviderInterface.php b/app/code/Magento/Analytics/Api/LinkProviderInterface.php
@@ -3,10 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Analytics\Api;
 
 /**
  * Provides link to file with collected report data.
+ *
+ * @api
  */
 interface LinkProviderInterface
 {

diff --git a/app/code/Magento/Analytics/Model/Connector/CommandInterface.php b/app/code/Magento/Analytics/Model/Connector/CommandInterface.php
@@ -3,11 +3,15 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Analytics\Model\Connector;
 
 /**
  * Introduces family of integration calls.
  * Each implementation represents call to external service.
+ *
+ * @api
  */
 interface CommandInterface
 {

diff --git a/app/code/Magento/Analytics/Model/ExportDataHandlerInterface.php b/app/code/Magento/Analytics/Model/ExportDataHandlerInterface.php
@@ -3,10 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Analytics\Model;
 
 /**
  * The interface represents the type of classes that handling of a new data collection for MBI.
+ *
+ * @api
  */
 interface ExportDataHandlerInterface
 {

diff --git a/app/code/Magento/Analytics/Model/ReportWriterInterface.php b/app/code/Magento/Analytics/Model/ReportWriterInterface.php
@@ -3,6 +3,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Analytics\Model;
 
 use Magento\Framework\Filesystem\Directory\WriteInterface;
@@ -14,6 +16,8 @@
  * Executes export of collected data
  * Iterates registered providers @see etc/analytics.xml
  * Collects data (to TMP folder)
+ *
+ * @api
  */
 interface ReportWriterInterface
 {

diff --git a/app/code/Magento/Analytics/ReportXml/DB/Assembler/AssemblerInterface.php b/app/code/Magento/Analytics/ReportXml/DB/Assembler/AssemblerInterface.php
@@ -3,6 +3,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Analytics\ReportXml\DB\Assembler;
 
 use Magento\Analytics\ReportXml\DB\SelectBuilder;
@@ -13,6 +15,8 @@
  * Introduces family of SQL assemblers
  * Each assembler populates SelectBuilder with config information
  * @see usage examples at \Magento\Analytics\ReportXml\QueryFactory
+ *
+ * @api
  */
 interface AssemblerInterface
 {

diff --git a/app/code/Magento/Analytics/ReportXml/DB/SelectBuilder.php b/app/code/Magento/Analytics/ReportXml/DB/SelectBuilder.php
@@ -13,6 +13,8 @@
  * Responsible for Select object creation, works as a builder. Returns Select as result;
  *
  * Used in SQL assemblers.
+ *
+ * @api
  */
 class SelectBuilder
 {

diff --git a/app/code/Magento/Backend/Model/Image/UploadResizeConfigInterface.php b/app/code/Magento/Backend/Model/Image/UploadResizeConfigInterface.php
@@ -11,6 +11,8 @@
  * Interface UploadResizeConfigInterface
  *
  * Used to retrieve configuration for frontend image uploader
+ *
+ * @api
  */
 interface UploadResizeConfigInterface
 {

diff --git a/app/code/Magento/Backend/Model/Search/Config/Structure/ElementBuilderInterface.php b/app/code/Magento/Backend/Model/Search/Config/Structure/ElementBuilderInterface.php
@@ -3,10 +3,17 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Backend\Model\Search\Config\Structure;
 
 use Magento\Config\Model\Config\StructureElementInterface;
 
+/**
+ * Element builder interface
+ *
+ * @api
+ */
 interface ElementBuilderInterface
 {
     /**

diff --git a/app/code/Magento/Bundle/Pricing/Adjustment/BundleCalculatorInterface.php b/app/code/Magento/Bundle/Pricing/Adjustment/BundleCalculatorInterface.php
@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Bundle\Pricing\Adjustment;
 
@@ -11,6 +12,8 @@
 
 /**
  * Bundle calculator interface
+ *
+ * @api
  */
 interface BundleCalculatorInterface extends CalculatorInterface
 {

diff --git a/app/code/Magento/CardinalCommerce/Model/Response/JwtParserInterface.php b/app/code/Magento/CardinalCommerce/Model/Response/JwtParserInterface.php
@@ -3,11 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\CardinalCommerce\Model\Response;
 
 /**
  * Parses content of CardinalCommerce response JWT.
+ *
+ * @api
  */
 interface JwtParserInterface
 {

diff --git a/app/code/Magento/CardinalCommerce/Model/Response/JwtPayloadValidatorInterface.php b/app/code/Magento/CardinalCommerce/Model/Response/JwtPayloadValidatorInterface.php
@@ -3,11 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\CardinalCommerce\Model\Response;
 
 /**
  * Validates payload of CardinalCommerce response JWT.
+ *
+ * @api
  */
 interface JwtPayloadValidatorInterface
 {

diff --git a/app/code/Magento/Catalog/Block/Adminhtml/Product/Edit/Button/Generic.php b/app/code/Magento/Catalog/Block/Adminhtml/Product/Edit/Button/Generic.php
@@ -3,6 +3,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Catalog\Block\Adminhtml\Product\Edit\Button;
 
 use Magento\Catalog\Api\Data\ProductInterface;
@@ -12,6 +14,8 @@
 
 /**
  * Class Generic
+ *
+ * @api
  */
 class Generic implements ButtonProviderInterface
 {

diff --git a/app/code/Magento/Catalog/Block/Product/AwareInterface.php b/app/code/Magento/Catalog/Block/Product/AwareInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Class Product Aware interface
+ *
+ * @api
  */
 interface AwareInterface
 {

diff --git a/app/code/Magento/Catalog/Block/Product/ImageFactory.php b/app/code/Magento/Catalog/Block/Product/ImageFactory.php
@@ -18,6 +18,8 @@
 
 /**
  * Create imageBlock from product and view.xml
+ *
+ * @api
  */
 class ImageFactory
 {

diff --git a/app/code/Magento/Catalog/Block/Product/ReviewRendererInterface.php b/app/code/Magento/Catalog/Block/Product/ReviewRendererInterface.php
@@ -9,6 +9,7 @@
 /**
  * Interface \Magento\Catalog\Block\Product\ReviewRendererInterface
  *
+ * @api
  */
 interface ReviewRendererInterface
 {

diff --git a/app/code/Magento/Catalog/Controller/Adminhtml/Product.php b/app/code/Magento/Catalog/Controller/Adminhtml/Product.php
@@ -3,12 +3,17 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Catalog\Controller\Adminhtml;
 
 use Magento\Backend\App\Action;
 
 /**
  * Catalog product controller
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.NumberOfChildren)
  */
 abstract class Product extends \Magento\Backend\App\Action

diff --git a/...e/Magento/Catalog/Controller/Adminhtml/Product/Initialization/Helper/HandlerInterface.php b/...e/Magento/Catalog/Controller/Adminhtml/Product/Initialization/Helper/HandlerInterface.php
@@ -8,6 +8,7 @@
 /**
  * Interface \Magento\Catalog\Controller\Adminhtml\Product\Initialization\Helper\HandlerInterface
  *
+ * @api
  */
 interface HandlerInterface
 {

diff --git a/app/code/Magento/Catalog/Controller/Product/View/ViewInterface.php b/app/code/Magento/Catalog/Controller/Product/View/ViewInterface.php
@@ -6,6 +6,8 @@
 
 /**
  * Marker interface for controllers on product view page
+ *
+ * @api
  */
 namespace Magento\Catalog\Controller\Product\View;
 

diff --git a/app/code/Magento/Catalog/Model/Attribute/LockValidatorInterface.php b/app/code/Magento/Catalog/Model/Attribute/LockValidatorInterface.php
@@ -10,6 +10,7 @@
 /**
  * Interface \Magento\Catalog\Model\Attribute\LockValidatorInterface
  *
+ * @api
  */
 interface LockValidatorInterface
 {

diff --git a/app/code/Magento/Catalog/Model/Config.php b/app/code/Magento/Catalog/Model/Config.php
@@ -11,6 +11,7 @@
 /**
  * Catalog config model.
  *
+ * @api
  * @SuppressWarnings(PHPMD.LongVariable)
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)

diff --git a/app/code/Magento/Catalog/Model/Config/Source/ProductPriceOptionsInterface.php b/app/code/Magento/Catalog/Model/Config/Source/ProductPriceOptionsInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface ProductPriceOptionsInterface
+ *
+ * @api
  */
 interface ProductPriceOptionsInterface extends OptionSourceInterface
 {

diff --git a/app/code/Magento/Catalog/Model/Entity/Product/Attribute/Group/AttributeMapperInterface.php b/app/code/Magento/Catalog/Model/Entity/Product/Attribute/Group/AttributeMapperInterface.php
@@ -12,6 +12,7 @@
 /**
  * Interface \Magento\Catalog\Model\Entity\Product\Attribute\Group\AttributeMapperInterface
  *
+ * @api
  */
 interface AttributeMapperInterface
 {

diff --git a/app/code/Magento/Catalog/Model/Indexer/Product/Flat/TableDataInterface.php b/app/code/Magento/Catalog/Model/Indexer/Product/Flat/TableDataInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface TableDataInterface
+ *
+ * @api
  */
 interface TableDataInterface
 {

diff --git a/app/code/Magento/Catalog/Model/Layer/CollectionFilterInterface.php b/app/code/Magento/Catalog/Model/Layer/CollectionFilterInterface.php
@@ -9,6 +9,7 @@
 /**
  * Interface \Magento\Catalog\Model\Layer\CollectionFilterInterface
  *
+ * @api
  */
 interface CollectionFilterInterface
 {

diff --git a/app/code/Magento/Catalog/Model/Layer/Filter/Item.php b/app/code/Magento/Catalog/Model/Layer/Filter/Item.php
@@ -3,14 +3,15 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model\Layer\Filter;
 
 /**
  * Filter item model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
-namespace Magento\Catalog\Model\Layer\Filter;
-
 class Item extends \Magento\Framework\DataObject
 {
     /**

diff --git a/app/code/Magento/Catalog/Model/Layer/FilterableAttributeListInterface.php b/app/code/Magento/Catalog/Model/Layer/FilterableAttributeListInterface.php
@@ -9,6 +9,7 @@
 /**
  * Interface \Magento\Catalog\Model\Layer\FilterableAttributeListInterface
  *
+ * @api
  */
 interface FilterableAttributeListInterface
 {

diff --git a/app/code/Magento/Catalog/Model/Layer/ItemCollectionProviderInterface.php b/app/code/Magento/Catalog/Model/Layer/ItemCollectionProviderInterface.php
@@ -10,6 +10,7 @@
 /**
  * Interface \Magento\Catalog\Model\Layer\ItemCollectionProviderInterface
  *
+ * @api
  */
 interface ItemCollectionProviderInterface
 {

diff --git a/app/code/Magento/Catalog/Model/Layer/Resolver.php b/app/code/Magento/Catalog/Model/Layer/Resolver.php
@@ -4,8 +4,16 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
+declare(strict_types=1);
+
 namespace Magento\Catalog\Model\Layer;
 
+/**
+ * Layer Resolver
+ *
+ * @api
+ */
 class Resolver
 {
     const CATALOG_LAYER_CATEGORY = 'category';

diff --git a/app/code/Magento/Catalog/Model/Layer/StateKeyInterface.php b/app/code/Magento/Catalog/Model/Layer/StateKeyInterface.php
@@ -9,6 +9,7 @@
 /**
  * Interface \Magento\Catalog\Model\Layer\StateKeyInterface
  *
+ * @api
  */
 interface StateKeyInterface
 {

diff --git a/app/code/Magento/Catalog/Model/Product/Condition/ConditionInterface.php b/app/code/Magento/Catalog/Model/Product/Condition/ConditionInterface.php
@@ -12,6 +12,7 @@
 /**
  * Interface \Magento\Catalog\Model\Product\Condition\ConditionInterface
  *
+ * @api
  */
 interface ConditionInterface
 {

diff --git a/app/code/Magento/Catalog/Model/Product/Configuration/Item/Option/OptionInterface.php b/app/code/Magento/Catalog/Model/Product/Configuration/Item/Option/OptionInterface.php
@@ -7,6 +7,7 @@
 /**
  * Interface of product configurational item option
  *
+ * @api
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 namespace Magento\Catalog\Model\Product\Configuration\Item\Option;