From 884de0739170a5077093178b2653d3019f0938c4 Mon Sep 17 00:00:00 2001 From: Oleh Usik Date: Mon, 15 Feb 2021 18:40:36 +0200 Subject: [PATCH 1/2] marked as api --- .../Product/LayeredNavigation/LayerBuilderInterface.php | 2 ++ .../DataProvider/Category/CollectionProcessorInterface.php | 2 ++ .../Model/Resolver/Product/Price/ProviderInterface.php | 2 ++ .../DataProvider/Product/CollectionProcessorInterface.php | 2 ++ .../Model/Resolver/Products/Query/ProductQueryInterface.php | 3 +++ .../Model/Export/ProductFilterInterface.php | 5 +++++ .../Model/Indexer/IndexerTableSwapperInterface.php | 2 ++ .../Model/Adapter/Aggregation/RequestCheckerInterface.php | 4 ++++ .../Advanced/ProductCollectionPrepareStrategyInterface.php | 4 ++++ .../Fulltext/Collection/SearchCriteriaResolverInterface.php | 3 +++ .../Fulltext/Collection/SearchResultApplierInterface.php | 3 +++ .../Fulltext/Collection/TotalRecordsResolverInterface.php | 3 +++ .../Model/Search/ItemCollectionProviderInterface.php | 3 +++ .../CatalogUrlRewrite/Model/Map/DatabaseMapInterface.php | 4 ++++ .../CatalogUrlRewrite/Model/Map/HashMapInterface.php | 6 ++++-- .../Checkout/Api/PaymentProcessingRateLimiterInterface.php | 2 ++ .../Checkout/Controller/Express/RedirectLoginInterface.php | 3 +++ .../Magento/Checkout/CustomerData/ItemPoolInterface.php | 3 +++ .../Model/AgreementsProviderInterface.php | 4 ++++ .../CustomLayout/Data/CustomLayoutSelectedInterface.php | 2 ++ .../Magento/Cms/Model/Page/CustomLayoutManagerInterface.php | 2 ++ .../Cms/Model/Page/CustomLayoutRepositoryInterface.php | 2 ++ .../Magento/Cms/Model/PageRepository/ValidatorInterface.php | 2 ++ app/code/Magento/Cms/Ui/Component/AddFilterInterface.php | 2 ++ .../Attribute/OptionSelectBuilderInterface.php | 4 ++++ 25 files changed, 72 insertions(+), 2 deletions(-) diff --git a/app/code/Magento/CatalogGraphQl/DataProvider/Product/LayeredNavigation/LayerBuilderInterface.php b/app/code/Magento/CatalogGraphQl/DataProvider/Product/LayeredNavigation/LayerBuilderInterface.php index bd55bc6938b39..5ac24a6adc36e 100644 --- a/app/code/Magento/CatalogGraphQl/DataProvider/Product/LayeredNavigation/LayerBuilderInterface.php +++ b/app/code/Magento/CatalogGraphQl/DataProvider/Product/LayeredNavigation/LayerBuilderInterface.php @@ -26,6 +26,8 @@ * ], * ... * ]; + * + * @api */ interface LayerBuilderInterface { diff --git a/app/code/Magento/CatalogGraphQl/Model/Resolver/Categories/DataProvider/Category/CollectionProcessorInterface.php b/app/code/Magento/CatalogGraphQl/Model/Resolver/Categories/DataProvider/Category/CollectionProcessorInterface.php index 5e79064e9acfa..6906e71cb043f 100644 --- a/app/code/Magento/CatalogGraphQl/Model/Resolver/Categories/DataProvider/Category/CollectionProcessorInterface.php +++ b/app/code/Magento/CatalogGraphQl/Model/Resolver/Categories/DataProvider/Category/CollectionProcessorInterface.php @@ -13,6 +13,8 @@ /** * Add additional joins, attributes, and clauses to a category collection. + * + * @api */ interface CollectionProcessorInterface { diff --git a/app/code/Magento/CatalogGraphQl/Model/Resolver/Product/Price/ProviderInterface.php b/app/code/Magento/CatalogGraphQl/Model/Resolver/Product/Price/ProviderInterface.php index 99459daf045a5..018d2029fd6d6 100644 --- a/app/code/Magento/CatalogGraphQl/Model/Resolver/Product/Price/ProviderInterface.php +++ b/app/code/Magento/CatalogGraphQl/Model/Resolver/Product/Price/ProviderInterface.php @@ -12,6 +12,8 @@ /** * Provides product prices + * + * @api */ interface ProviderInterface { diff --git a/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/DataProvider/Product/CollectionProcessorInterface.php b/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/DataProvider/Product/CollectionProcessorInterface.php index 18e249ff23ac7..6e2ff7c7da660 100644 --- a/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/DataProvider/Product/CollectionProcessorInterface.php +++ b/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/DataProvider/Product/CollectionProcessorInterface.php @@ -13,6 +13,8 @@ /** * Add additional joins, attributes, and clauses to a product collection. + * + * @api */ interface CollectionProcessorInterface { diff --git a/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/Query/ProductQueryInterface.php b/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/Query/ProductQueryInterface.php index fca6f3d4f7770..1ebb847784a8a 100644 --- a/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/Query/ProductQueryInterface.php +++ b/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/Query/ProductQueryInterface.php @@ -3,6 +3,7 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); namespace Magento\CatalogGraphQl\Model\Resolver\Products\Query; @@ -12,6 +13,8 @@ /** * Search for products by criteria + * + * @api */ interface ProductQueryInterface { diff --git a/app/code/Magento/CatalogImportExport/Model/Export/ProductFilterInterface.php b/app/code/Magento/CatalogImportExport/Model/Export/ProductFilterInterface.php index 30985f3dc8cd7..c8d39fa522966 100644 --- a/app/code/Magento/CatalogImportExport/Model/Export/ProductFilterInterface.php +++ b/app/code/Magento/CatalogImportExport/Model/Export/ProductFilterInterface.php @@ -9,6 +9,11 @@ use Magento\Catalog\Model\ResourceModel\Product\Collection; +/** + * Product filter interface + * + * @api + */ interface ProductFilterInterface { /** diff --git a/app/code/Magento/CatalogRule/Model/Indexer/IndexerTableSwapperInterface.php b/app/code/Magento/CatalogRule/Model/Indexer/IndexerTableSwapperInterface.php index 2f37e680949ae..9171425409d23 100644 --- a/app/code/Magento/CatalogRule/Model/Indexer/IndexerTableSwapperInterface.php +++ b/app/code/Magento/CatalogRule/Model/Indexer/IndexerTableSwapperInterface.php @@ -10,6 +10,8 @@ /** * Manage additional tables used while building new index to preserve * index tables until the process finishes. + * + * @api */ interface IndexerTableSwapperInterface { diff --git a/app/code/Magento/CatalogSearch/Model/Adapter/Aggregation/RequestCheckerInterface.php b/app/code/Magento/CatalogSearch/Model/Adapter/Aggregation/RequestCheckerInterface.php index 7efe708a5755f..723073a3b0002 100644 --- a/app/code/Magento/CatalogSearch/Model/Adapter/Aggregation/RequestCheckerInterface.php +++ b/app/code/Magento/CatalogSearch/Model/Adapter/Aggregation/RequestCheckerInterface.php @@ -3,12 +3,16 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\CatalogSearch\Model\Adapter\Aggregation; use Magento\Framework\Search\RequestInterface; /** * RequestCheckerInterface provides the interface to work with query checkers. + * + * @api */ interface RequestCheckerInterface { diff --git a/app/code/Magento/CatalogSearch/Model/Advanced/ProductCollectionPrepareStrategyInterface.php b/app/code/Magento/CatalogSearch/Model/Advanced/ProductCollectionPrepareStrategyInterface.php index 23719a6713a32..727a410bf23b9 100644 --- a/app/code/Magento/CatalogSearch/Model/Advanced/ProductCollectionPrepareStrategyInterface.php +++ b/app/code/Magento/CatalogSearch/Model/Advanced/ProductCollectionPrepareStrategyInterface.php @@ -3,12 +3,16 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\CatalogSearch\Model\Advanced; use Magento\Catalog\Model\ResourceModel\Product\Collection; /** * Strategy interface for preparing product collection. + * + * @api */ interface ProductCollectionPrepareStrategyInterface { diff --git a/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/SearchCriteriaResolverInterface.php b/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/SearchCriteriaResolverInterface.php index 047fa7f71e400..05422a13741c3 100644 --- a/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/SearchCriteriaResolverInterface.php +++ b/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/SearchCriteriaResolverInterface.php @@ -3,6 +3,7 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); namespace Magento\CatalogSearch\Model\ResourceModel\Fulltext\Collection; @@ -10,6 +11,8 @@ /** * Resolve specific attributes for search criteria. + * + * @api */ interface SearchCriteriaResolverInterface { diff --git a/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/SearchResultApplierInterface.php b/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/SearchResultApplierInterface.php index 1b3e2a6bbac71..29db40e5bcbc9 100644 --- a/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/SearchResultApplierInterface.php +++ b/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/SearchResultApplierInterface.php @@ -3,11 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); namespace Magento\CatalogSearch\Model\ResourceModel\Fulltext\Collection; /** * Resolve specific attributes for search criteria. + * + * @api */ interface SearchResultApplierInterface { diff --git a/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/TotalRecordsResolverInterface.php b/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/TotalRecordsResolverInterface.php index 190450f9606bc..eff23f3c00711 100644 --- a/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/TotalRecordsResolverInterface.php +++ b/app/code/Magento/CatalogSearch/Model/ResourceModel/Fulltext/Collection/TotalRecordsResolverInterface.php @@ -3,11 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); namespace Magento\CatalogSearch\Model\ResourceModel\Fulltext\Collection; /** * Resolve total records count. + * + * @api */ interface TotalRecordsResolverInterface { diff --git a/app/code/Magento/CatalogSearch/Model/Search/ItemCollectionProviderInterface.php b/app/code/Magento/CatalogSearch/Model/Search/ItemCollectionProviderInterface.php index db02d5ac5f519..57c81bface24d 100644 --- a/app/code/Magento/CatalogSearch/Model/Search/ItemCollectionProviderInterface.php +++ b/app/code/Magento/CatalogSearch/Model/Search/ItemCollectionProviderInterface.php @@ -4,6 +4,7 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); namespace Magento\CatalogSearch\Model\Search; @@ -11,6 +12,8 @@ /** * Search collection provider. + * + * @api */ interface ItemCollectionProviderInterface { diff --git a/app/code/Magento/CatalogUrlRewrite/Model/Map/DatabaseMapInterface.php b/app/code/Magento/CatalogUrlRewrite/Model/Map/DatabaseMapInterface.php index 7ce55b0f2765f..ab9feaf5567bd 100644 --- a/app/code/Magento/CatalogUrlRewrite/Model/Map/DatabaseMapInterface.php +++ b/app/code/Magento/CatalogUrlRewrite/Model/Map/DatabaseMapInterface.php @@ -3,6 +3,8 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\CatalogUrlRewrite\Model\Map; /** @@ -11,6 +13,8 @@ * Is used to get data by a unique key from a temporary table in mysql to prevent memory usage * It internally holds the knowledge the creation of the actual data and it initializes itself when we call getData * We should always call destroyTableAdapter when we don't need anymore the temporary tables + * + * @api */ interface DatabaseMapInterface { diff --git a/app/code/Magento/CatalogUrlRewrite/Model/Map/HashMapInterface.php b/app/code/Magento/CatalogUrlRewrite/Model/Map/HashMapInterface.php index 69595c82d8655..ce87c785f81b7 100644 --- a/app/code/Magento/CatalogUrlRewrite/Model/Map/HashMapInterface.php +++ b/app/code/Magento/CatalogUrlRewrite/Model/Map/HashMapInterface.php @@ -3,9 +3,9 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ -namespace Magento\CatalogUrlRewrite\Model\Map; +declare(strict_types=1); -use Magento\Framework\DB\Select; +namespace Magento\CatalogUrlRewrite\Model\Map; /** * Interface for a hash data map @@ -15,6 +15,8 @@ * The map, upon initialization, might have a dependency on some other DataMapInterfaces * The map has to free memory after we're done using it * We need to destroy those maps too when calling resetData + * + * @api */ interface HashMapInterface { diff --git a/app/code/Magento/Checkout/Api/PaymentProcessingRateLimiterInterface.php b/app/code/Magento/Checkout/Api/PaymentProcessingRateLimiterInterface.php index d81b79fc8e201..8af18c623d7a4 100644 --- a/app/code/Magento/Checkout/Api/PaymentProcessingRateLimiterInterface.php +++ b/app/code/Magento/Checkout/Api/PaymentProcessingRateLimiterInterface.php @@ -12,6 +12,8 @@ /** * Limits number of times a user can initiate payment processing. + * + * @api */ interface PaymentProcessingRateLimiterInterface { diff --git a/app/code/Magento/Checkout/Controller/Express/RedirectLoginInterface.php b/app/code/Magento/Checkout/Controller/Express/RedirectLoginInterface.php index a5777766c3949..e2ed0efc82b96 100644 --- a/app/code/Magento/Checkout/Controller/Express/RedirectLoginInterface.php +++ b/app/code/Magento/Checkout/Controller/Express/RedirectLoginInterface.php @@ -3,11 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Checkout\Controller\Express; /** * Interface \Magento\Checkout\Controller\Express\RedirectLoginInterface * + * @api */ interface RedirectLoginInterface { diff --git a/app/code/Magento/Checkout/CustomerData/ItemPoolInterface.php b/app/code/Magento/Checkout/CustomerData/ItemPoolInterface.php index 95c62a7436e52..7f29828e992f8 100644 --- a/app/code/Magento/Checkout/CustomerData/ItemPoolInterface.php +++ b/app/code/Magento/Checkout/CustomerData/ItemPoolInterface.php @@ -3,6 +3,7 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); namespace Magento\Checkout\CustomerData; @@ -10,6 +11,8 @@ /** * Item pool interface + * + * @api */ interface ItemPoolInterface { diff --git a/app/code/Magento/CheckoutAgreements/Model/AgreementsProviderInterface.php b/app/code/Magento/CheckoutAgreements/Model/AgreementsProviderInterface.php index eac3e44dc0de8..1175baa0d56ff 100644 --- a/app/code/Magento/CheckoutAgreements/Model/AgreementsProviderInterface.php +++ b/app/code/Magento/CheckoutAgreements/Model/AgreementsProviderInterface.php @@ -3,10 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\CheckoutAgreements\Model; /** * Interface AgreementsProviderInterface + * + * @api */ interface AgreementsProviderInterface { diff --git a/app/code/Magento/Cms/Model/Page/CustomLayout/Data/CustomLayoutSelectedInterface.php b/app/code/Magento/Cms/Model/Page/CustomLayout/Data/CustomLayoutSelectedInterface.php index 68bac57e98d56..8be2af29a9263 100644 --- a/app/code/Magento/Cms/Model/Page/CustomLayout/Data/CustomLayoutSelectedInterface.php +++ b/app/code/Magento/Cms/Model/Page/CustomLayout/Data/CustomLayoutSelectedInterface.php @@ -10,6 +10,8 @@ /** * Custom layout update file to be used for the specific CMS page. + * + * @api */ interface CustomLayoutSelectedInterface { diff --git a/app/code/Magento/Cms/Model/Page/CustomLayoutManagerInterface.php b/app/code/Magento/Cms/Model/Page/CustomLayoutManagerInterface.php index 6f15fcef7f8f4..29da6b3cedb81 100644 --- a/app/code/Magento/Cms/Model/Page/CustomLayoutManagerInterface.php +++ b/app/code/Magento/Cms/Model/Page/CustomLayoutManagerInterface.php @@ -14,6 +14,8 @@ /** * Manage custom layout files for CMS pages. + * + * @api */ interface CustomLayoutManagerInterface { diff --git a/app/code/Magento/Cms/Model/Page/CustomLayoutRepositoryInterface.php b/app/code/Magento/Cms/Model/Page/CustomLayoutRepositoryInterface.php index 80eb39b7ab20f..e390e957e826f 100644 --- a/app/code/Magento/Cms/Model/Page/CustomLayoutRepositoryInterface.php +++ b/app/code/Magento/Cms/Model/Page/CustomLayoutRepositoryInterface.php @@ -14,6 +14,8 @@ /** * Access to "custom layout" page property. + * + * @api */ interface CustomLayoutRepositoryInterface { diff --git a/app/code/Magento/Cms/Model/PageRepository/ValidatorInterface.php b/app/code/Magento/Cms/Model/PageRepository/ValidatorInterface.php index ff5c7648a9fa2..333c82c4f8c14 100644 --- a/app/code/Magento/Cms/Model/PageRepository/ValidatorInterface.php +++ b/app/code/Magento/Cms/Model/PageRepository/ValidatorInterface.php @@ -13,6 +13,8 @@ /** * Validate a page repository + * + * @api */ interface ValidatorInterface { diff --git a/app/code/Magento/Cms/Ui/Component/AddFilterInterface.php b/app/code/Magento/Cms/Ui/Component/AddFilterInterface.php index 406b40fbc1647..d4c3338b4ca71 100644 --- a/app/code/Magento/Cms/Ui/Component/AddFilterInterface.php +++ b/app/code/Magento/Cms/Ui/Component/AddFilterInterface.php @@ -12,6 +12,8 @@ /** * Provides extension point to add additional filters to search criteria. + * + * @api */ interface AddFilterInterface { diff --git a/app/code/Magento/ConfigurableProduct/Model/ResourceModel/Attribute/OptionSelectBuilderInterface.php b/app/code/Magento/ConfigurableProduct/Model/ResourceModel/Attribute/OptionSelectBuilderInterface.php index 400d89b836e5e..c33fbc86fa823 100644 --- a/app/code/Magento/ConfigurableProduct/Model/ResourceModel/Attribute/OptionSelectBuilderInterface.php +++ b/app/code/Magento/ConfigurableProduct/Model/ResourceModel/Attribute/OptionSelectBuilderInterface.php @@ -3,6 +3,8 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\ConfigurableProduct\Model\ResourceModel\Attribute; use Magento\Eav\Model\Entity\Attribute\AbstractAttribute; @@ -11,6 +13,8 @@ /** * Interface to build select for retrieving configurable options. + * + * @api */ interface OptionSelectBuilderInterface { From 0fddaec38b149d913a715a0cf97da0729b441497 Mon Sep 17 00:00:00 2001 From: Oleh Usik Date: Thu, 25 Feb 2021 15:40:52 +0200 Subject: [PATCH 2/2] minor adjustments --- .../CatalogGraphQl/Model/Resolver/Products/SearchResult.php | 2 ++ app/code/Magento/GraphQl/Model/Query/ContextInterface.php | 2 ++ .../Magento/Framework/Api/Search/AggregationInterface.php | 4 ++++ .../Magento/Framework/GraphQl/Schema/Type/ResolveInfo.php | 2 ++ 4 files changed, 10 insertions(+) diff --git a/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/SearchResult.php b/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/SearchResult.php index e4a137413b4c5..6b5c8b126832c 100644 --- a/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/SearchResult.php +++ b/app/code/Magento/CatalogGraphQl/Model/Resolver/Products/SearchResult.php @@ -11,6 +11,8 @@ /** * Container for a product search holding the item result and the array in the GraphQL-readable product type format. + * + * @api */ class SearchResult { diff --git a/app/code/Magento/GraphQl/Model/Query/ContextInterface.php b/app/code/Magento/GraphQl/Model/Query/ContextInterface.php index 84b36064e2824..ba532c7191dfe 100644 --- a/app/code/Magento/GraphQl/Model/Query/ContextInterface.php +++ b/app/code/Magento/GraphQl/Model/Query/ContextInterface.php @@ -16,6 +16,8 @@ * * GraphQL will pass the same instance of this interface to each field resolver, so these resolvers could have * shared access to the same data for ease of implementation purposes. + * + * @api */ interface ContextInterface extends BaseContextInterface, ExtensibleDataInterface { diff --git a/lib/internal/Magento/Framework/Api/Search/AggregationInterface.php b/lib/internal/Magento/Framework/Api/Search/AggregationInterface.php index 5f02006b1f1a3..fa72a2573dfd0 100644 --- a/lib/internal/Magento/Framework/Api/Search/AggregationInterface.php +++ b/lib/internal/Magento/Framework/Api/Search/AggregationInterface.php @@ -3,10 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\Api\Search; /** * Faceted data + * + * @api */ interface AggregationInterface { diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/Type/ResolveInfo.php b/lib/internal/Magento/Framework/GraphQl/Schema/Type/ResolveInfo.php index fe479c9a0bae6..19f573a3c28ae 100644 --- a/lib/internal/Magento/Framework/GraphQl/Schema/Type/ResolveInfo.php +++ b/lib/internal/Magento/Framework/GraphQl/Schema/Type/ResolveInfo.php @@ -9,6 +9,8 @@ /** * Wrapper for GraphQl ResolveInfo + * + * @api */ class ResolveInfo extends \GraphQL\Type\Definition\ResolveInfo {