Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[32015] Marked Catalog*, Checkout, Cms, ConfigurableProduct interfaces as API #32175

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
* ],
* ...
* ];
*
* @api
*/
interface LayerBuilderInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

/**
* Add additional joins, attributes, and clauses to a category collection.
*
* @api
*/
interface CollectionProcessorInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Provides product prices
*
* @api
*/
interface ProviderInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

/**
* Add additional joins, attributes, and clauses to a product collection.
*
* @api
*/
interface CollectionProcessorInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -12,6 +13,8 @@

/**
* Search for products by criteria
*
* @api
*/
interface ProductQueryInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@

use Magento\Catalog\Model\ResourceModel\Product\Collection;

/**
* Product filter interface
*
* @api
*/
interface ProductFilterInterface
{
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
/**
* Manage additional tables used while building new index to preserve
* index tables until the process finishes.
*
* @api
*/
interface IndexerTableSwapperInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\CatalogSearch\Model\ResourceModel\Fulltext\Collection;

use Magento\Framework\Api\Search\SearchCriteria;

/**
* Resolve specific attributes for search criteria.
*
* @api
*/
interface SearchCriteriaResolverInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\CatalogSearch\Model\Search;

use Magento\Framework\Data\Collection;

/**
* Search collection provider.
*
* @api
*/
interface ItemCollectionProviderInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

/**
Expand All @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Limits number of times a user can initiate payment processing.
*
* @api
*/
interface PaymentProcessingRateLimiterInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
3 changes: 3 additions & 0 deletions app/code/Magento/Checkout/CustomerData/ItemPoolInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Checkout\CustomerData;

use Magento\Quote\Model\Quote\Item;

/**
* Item pool interface
*
* @api
*/
interface ItemPoolInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

/**
* Custom layout update file to be used for the specific CMS page.
*
* @api
*/
interface CustomLayoutSelectedInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

/**
* Manage custom layout files for CMS pages.
*
* @api
*/
interface CustomLayoutManagerInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

/**
* Access to "custom layout" page property.
*
* @api
*/
interface CustomLayoutRepositoryInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

/**
* Validate a page repository
*
* @api
*/
interface ValidatorInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Cms/Ui/Component/AddFilterInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Provides extension point to add additional filters to search criteria.
*
* @api
*/
interface AddFilterInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -11,6 +13,8 @@

/**
* Interface to build select for retrieving configurable options.
*
* @api
*/
interface OptionSelectBuilderInterface
{
Expand Down