Skip to content

[32029][To 2.4-develop] Mark Framework interfaces as API part 5 #32729

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

Merged
merged 2 commits into from
Apr 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
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 @@ -12,6 +12,8 @@

/**
* Deferred HTTP response.
*
* @api
*/
interface HttpResponseDeferredInterface extends CancelableDeferredInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/HTTP/AsyncClient/Request.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

/**
* Request to send.
*
* @api
*/
class Request
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/HTTP/AsyncClient/Response.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

/**
* Http response.
*
* @api
*/
class Response
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/HTTP/AsyncClientInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

/**
* Asynchronous HTTP client.
*
* @api
*/
interface AsyncClientInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
/**
* Image abstract adapter
*
* @file Abstract.php
* @author Magento Core Team <[email protected]>
* @api
* @SuppressWarnings(PHPMD.TooManyFields)
*/
abstract class AbstractAdapter implements AdapterInterface
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\Framework\Image\Adapter;

/**
* Interface \Magento\Framework\Image\Adapter\AdapterInterface
*
* @api
*/
interface AdapterInterface
{
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\Framework\Image\Adapter;

/**
* Interface \Magento\Framework\Image\Adapter\ConfigInterface
*
* @api
*/
interface ConfigInterface
{
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\Framework\Indexer\Config;

use Magento\Framework\Exception\NoSuchEntityException;

/**
* Provides an information about indexers dependencies.
*
* @api
*/
interface DependencyInfoProviderInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Indexer\Table;

/**
* Interface \Magento\Framework\Indexer\Table\StrategyInterface
*
* @api
*/
interface StrategyInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Interception;

/**
* Interface \Magento\Framework\Interception\ConfigInterface
*
* @api
*/
interface ConfigInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Interception configuration loader interface.
*
* @api
*/
interface ConfigLoaderInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Interception config writer interface.
*
* @api
*/
interface ConfigWriterInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Interception;

/**
* Interface \Magento\Framework\Interception\DefinitionInterface
*
* @api
*/
interface DefinitionInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Interception;

/**
* Interface for any class that is intercepting another Magento class.
*
* This interface exposes the parent method of the interception class, which allows the caller to bypass
* the interception logic.
*
* @api
*/
interface InterceptorInterface
{
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\Framework\Interception\ObjectManager;

/**
* Interface \Magento\Framework\Interception\ObjectManager\ConfigInterface
*
* @api
*/
interface ConfigInterface extends \Magento\Framework\ObjectManager\ConfigInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Interception;

/**
* Interface \Magento\Framework\Interception\PluginListInterface
*
* @api
*/
interface PluginListInterface
{
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\Framework\Locale;

use Magento\Framework\View\DesignInterface;

/**
* Interface for classes that fetching codes of available locales for the concrete theme.
*
* @api
*/
interface AvailableLocalesInterface
{
Expand Down
4 changes: 4 additions & 0 deletions lib/internal/Magento/Framework/Locale/OptionInterface.php
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\Framework\Locale;

/**
* Interface for classes that return array of locales.
*
* @api
*/
interface OptionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/Mail/Address.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Class Address
*
* @api
*/
class Address
{
Expand Down
3 changes: 3 additions & 0 deletions lib/internal/Magento/Framework/Mail/EmailMessageInterface.php
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\Framework\Mail;

/**
* Interface EmailMessageInterface
*
* @api
*/
interface EmailMessageInterface extends MailMessageInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/Mail/MimeInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Mail;

/**
* Interface MimeInterface used providing constants
*
* @api
* @see \Laminas\Mime\Mime
*/
interface MimeInterface
Expand Down
3 changes: 3 additions & 0 deletions lib/internal/Magento/Framework/Mail/MimeMessageInterface.php
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\Framework\Mail;

/**
* Interface MimeMessageInterface
*
* @api
*/
interface MimeMessageInterface
{
Expand Down
3 changes: 3 additions & 0 deletions lib/internal/Magento/Framework/Mail/MimePartInterface.php
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\Framework\Mail;

/**
* Interface representing a MIME part.
*
* @api
*/
interface MimePartInterface
{
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\Framework\Message;

Expand All @@ -11,6 +12,7 @@
/**
* Interface \Magento\Framework\Message\ExceptionMessageFactoryInterface
*
* @api
*/
interface ExceptionMessageFactoryInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/**
* Interface \Magento\Framework\ObjectManager\ConfigCacheInterface
*
* @api
*/
interface ConfigCacheInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/**
* Interface \Magento\Framework\ObjectManager\RelationsInterface
*
* @api
*/
interface RelationsInterface
{
Expand Down