Mark Framework Interfaces as API part 3

mrtuvn · mrtuvn · commit eedf8fcf596f · 2021-04-03T08:59:41.000+07:00
fix static


update


update


fix non-public references 


revert change return value interface
diff --git a/lib/internal/Magento/Framework/Api/CriteriaInterface.php b/lib/internal/Magento/Framework/Api/CriteriaInterface.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;
 
 /**
  * Interface CriteriaInterface
+ *
+ * @api
  */
 interface CriteriaInterface
 {
diff --git a/lib/internal/Magento/Framework/Async/CancelableDeferredInterface.php b/lib/internal/Magento/Framework/Async/CancelableDeferredInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/Async/DeferredInterface.php b/lib/internal/Magento/Framework/Async/DeferredInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/Autoload/AutoloaderInterface.php b/lib/internal/Magento/Framework/Autoload/AutoloaderInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/Backup/SourceFileInterface.php b/lib/internal/Magento/Framework/Backup/SourceFileInterface.php
@@ -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
 {
 
diff --git a/lib/internal/Magento/Framework/Cache/ConfigInterface.php b/lib/internal/Magento/Framework/Cache/ConfigInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/Cache/StaleCacheNotifierInterface.php b/lib/internal/Magento/Framework/Cache/StaleCacheNotifierInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/Code/Generator/CodeGeneratorInterface.php b/lib/internal/Magento/Framework/Code/Generator/CodeGeneratorInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/Code/Minifier/AdapterInterface.php b/lib/internal/Magento/Framework/Code/Minifier/AdapterInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/Code/Reader/ClassReaderInterface.php b/lib/internal/Magento/Framework/Code/Reader/ClassReaderInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/Code/ValidatorInterface.php b/lib/internal/Magento/Framework/Code/ValidatorInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/Component/ComponentRegistrarInterface.php b/lib/internal/Magento/Framework/Component/ComponentRegistrarInterface.php
@@ -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
 {
     /**
diff --git a/lib/internal/Magento/Framework/Crontab/CrontabManagerInterface.php b/lib/internal/Magento/Framework/Crontab/CrontabManagerInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/Crontab/TasksProviderInterface.php b/lib/internal/Magento/Framework/Crontab/TasksProviderInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/Css/PreProcessor/ErrorHandlerInterface.php b/lib/internal/Magento/Framework/Css/PreProcessor/ErrorHandlerInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/DB/DataConverter/DataConverterInterface.php b/lib/internal/Magento/Framework/DB/DataConverter/DataConverterInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/DB/LoggerInterface.php b/lib/internal/Magento/Framework/DB/LoggerInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/DB/MapperInterface.php b/lib/internal/Magento/Framework/DB/MapperInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/DB/Query/BatchIteratorInterface.php b/lib/internal/Magento/Framework/DB/Query/BatchIteratorInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/DB/QueryInterface.php b/lib/internal/Magento/Framework/DB/QueryInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/DB/Select/QueryModifierInterface.php b/lib/internal/Magento/Framework/DB/Select/QueryModifierInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/DB/Select/RendererInterface.php b/lib/internal/Magento/Framework/DB/Select/RendererInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/DB/Sequence/SequenceInterface.php b/lib/internal/Magento/Framework/DB/Sequence/SequenceInterface.php
@@ -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
 {
diff --git a/lib/internal/Magento/Framework/DB/Sql/ExpressionInterface.php b/lib/internal/Magento/Framework/DB/Sql/ExpressionInterface.php
@@ -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;
 
 /**
@@ -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();
 }
diff --git a/lib/internal/Magento/Framework/Data/Collection/Db/FetchStrategyInterface.php b/lib/internal/Magento/Framework/Data/Collection/Db/FetchStrategyInterface.php
diff --git a/lib/internal/Magento/Framework/Data/Collection/EntityFactoryInterface.php b/lib/internal/Magento/Framework/Data/Collection/EntityFactoryInterface.php
diff --git a/lib/internal/Magento/Framework/Data/CollectionDataSourceInterface.php b/lib/internal/Magento/Framework/Data/CollectionDataSourceInterface.php
diff --git a/lib/internal/Magento/Framework/Data/CollectionModifierInterface.php b/lib/internal/Magento/Framework/Data/CollectionModifierInterface.php
diff --git a/lib/internal/Magento/Framework/Data/SearchResultInterface.php b/lib/internal/Magento/Framework/Data/SearchResultInterface.php
diff --git a/lib/internal/Magento/Framework/Data/SearchResultProcessorInterface.php b/lib/internal/Magento/Framework/Data/SearchResultProcessorInterface.php
diff --git a/lib/internal/Magento/Framework/Data/ValueSourceInterface.php b/lib/internal/Magento/Framework/Data/ValueSourceInterface.php
diff --git a/lib/internal/Magento/Framework/DataObject/IdentityGeneratorInterface.php b/lib/internal/Magento/Framework/DataObject/IdentityGeneratorInterface.php
diff --git a/lib/internal/Magento/Framework/DataObject/IdentityInterface.php b/lib/internal/Magento/Framework/DataObject/IdentityInterface.php
diff --git a/lib/internal/Magento/Framework/DataObject/IdentityValidatorInterface.php b/lib/internal/Magento/Framework/DataObject/IdentityValidatorInterface.php
diff --git a/lib/internal/Magento/Framework/DataObject/KeyValueObjectInterface.php b/lib/internal/Magento/Framework/DataObject/KeyValueObjectInterface.php

Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,14 @@`
`3`	`3`	`* Copyright © Magento, Inc. All rights reserved.`
`4`	`4`	`* See COPYING.txt for license details.`
`5`	`5`	`*/`
	`6`	`+declare(strict_types=1);`
	`7`	`+`
`6`	`8`	`namespace Magento\Framework\Code\Generator;`
`7`	`9`
`8`	`10`	`/**`
`9`	`11`	`* Interface \Magento\Framework\Code\Generator\CodeGeneratorInterface`
`10`	`12`	`*`
	`13`	`+ * @api`
`11`	`14`	`*/`
`12`	`15`	`interface CodeGeneratorInterface extends \Laminas\Code\Generator\GeneratorInterface`
`13`	`16`	`{`