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

Mark Framework Interfaces as API part 3 #32156

Merged
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
4 changes: 4 additions & 0 deletions lib/internal/Magento/Framework/Api/CriteriaInterface.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\Api;

/**
* Interface CriteriaInterface
*
* @api
*/
interface CriteriaInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

declare(strict_types=1);

namespace Magento\Framework\Async;

/**
* Described deferred operation that can be canceled.
*
* @api
*/
interface CancelableDeferredInterface extends DeferredInterface
{
Expand Down
3 changes: 2 additions & 1 deletion lib/internal/Magento/Framework/Async/DeferredInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

declare(strict_types=1);

namespace Magento\Framework\Async;

/**
* Describes a value that will be available at later time.
*
* @api
*/
interface DeferredInterface
{
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\Framework\Autoload;

/**
* Interface for an autoloader class that allows the dynamic modification of PSR-0 and PSR-4 mappings
*
* @api
*/
interface AutoloaderInterface
{
Expand Down
8 changes: 4 additions & 4 deletions lib/internal/Magento/Framework/Backup/SourceFileInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Backup;

/**
* Interface for work with archives
*
* @author Magento Core Team <core@magentocommerce.com>
* @api
*/

namespace Magento\Framework\Backup;

interface SourceFileInterface
{

Expand Down
5 changes: 3 additions & 2 deletions lib/internal/Magento/Framework/Cache/ConfigInterface.php
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
<?php
/**
* Cache configuration model. Provides cache configuration data to the application
*
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Cache;

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

/**
* Notifier for stale cache retrieval detection
*
* @api
*/
interface StaleCacheNotifierInterface
{
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\Code\Generator;

/**
* Interface \Magento\Framework\Code\Generator\CodeGeneratorInterface
*
* @api
*/
interface CodeGeneratorInterface extends \Laminas\Code\Generator\GeneratorInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

/**
* Interface for minification adapters
*/
namespace Magento\Framework\Code\Minifier;

/**
* Interface \Magento\Framework\Code\Minifier\AdapterInterface
*
* @api
*/
interface AdapterInterface
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
<?php
/**
*
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Code\Reader;

/**
* Interface \Magento\Framework\Code\Reader\ClassReaderInterface
*
* @api
*/
interface ClassReaderInterface
{
Expand Down
3 changes: 3 additions & 0 deletions lib/internal/Magento/Framework/Code/ValidatorInterface.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\Code;

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

namespace Magento\Framework\Component;

/**
* Component Registrar Interface
*
* @api
*/
interface ComponentRegistrarInterface
{
/**
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\Crontab;

use Magento\Framework\Exception\LocalizedException;

/**
* Interface \Magento\Framework\Crontab\CrontabManagerInterface
*
* @api
*/
interface CrontabManagerInterface
{
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\Crontab;

/**
* Interface \Magento\Framework\Crontab\TasksProviderInterface
*
* @api
*/
interface TasksProviderInterface
{
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\Framework\Css\PreProcessor;

/**
* Error handler interface
*
* @api
*/
interface ErrorHandlerInterface
{
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\Framework\DB\DataConverter;

/**
* Convert from one format to another
*
* @api
*/
interface DataConverterInterface
{
Expand Down
4 changes: 4 additions & 0 deletions lib/internal/Magento/Framework/DB/LoggerInterface.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\DB;

/**
* DB logger interface
*
* @api
*/
interface LoggerInterface
{
Expand Down
4 changes: 4 additions & 0 deletions lib/internal/Magento/Framework/DB/MapperInterface.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\DB;

/**
* Interface MapperInterface
*
* @api
*/
interface MapperInterface
{
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\Framework\DB\Query;

/**
* Batch Iterator interface
*
* @api
*/
interface BatchIteratorInterface extends \Iterator
{
Expand Down
6 changes: 5 additions & 1 deletion lib/internal/Magento/Framework/DB/QueryInterface.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\DB;

/**
* Class QueryInterface
* Interface QueryInterface
*
* @api
*/
interface QueryInterface
{
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\DB\Select;

use Magento\Framework\DB\Select;

/**
* Modify query, add custom conditions
*
* @api
*/
interface QueryModifierInterface
{
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\DB\Select;

use Magento\Framework\DB\Select;

/**
* Interface RendererInterface
*
* @api
*/
interface RendererInterface
{
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\Framework\DB\Sequence;

/**
* Interface represents sequence
*
* @api
*/
interface SequenceInterface
{
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\Framework\DB\Sql;

/**
Expand All @@ -11,11 +13,15 @@
* Defines interface was implemented in Zend_Db_Expr.
* Interface for SQL Expressions for DB Adapter/Select.
* By using this interface a developer can strictly control type for code that manages an Expression directly.
*
* @api
*/
interface ExpressionInterface
{
/**
* @return string The string of the SQL expression stored in this object.
* The string of the SQL expression stored in this object.
*
* @return string
*/
public function __toString();
}
Loading