Skip to content

[32033][To 2.4-develop] Marked Framework Setup interfaces as API #32733

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
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 @@ -3,12 +3,16 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Setup;

use Magento\Framework\App\DeploymentConfig;

/**
* Interface for handling options in deployment configuration tool
*
* @api
*/
interface ConfigOptionsListInterface
{
Expand Down
4 changes: 4 additions & 0 deletions lib/internal/Magento/Framework/Setup/DataCacheInterface.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\Setup;

/**
* Data setup cache
*
* @api
*/
interface DataCacheInterface
{
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\Setup\Declaration\Schema\DataSavior;

Expand All @@ -11,6 +12,8 @@
/**
* This interface allows to dump data during declarative installation process
* and revert changes with applying previously saved data, if something goes wrong
*
* @api
*/
interface DataSaviorInterface
{
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\Setup\Declaration\Schema\DataSavior;

/**
* Allows to access dump, that can be persisted in any file format or in database
*
* @api
*/
interface DumpAccessorInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
* This approach is correct from prospective of declaration but is not so fast as ALTER TABLE is.
* So if you need to perform some renaming operations quickly, please use raw SQL dump instead, that can be taken with
* help of --dry-run mode
*
* @api
*/
interface DDLTriggerInterface
{
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\Setup\Declaration\Schema\Db;

Expand All @@ -13,6 +14,8 @@
* For example, from VARCHAR(255) to:
* 'type' => 'varchar'
* 'length' => 255
*
* @api
*/
interface DbDefinitionProcessorInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Setup\Declaration\Schema\Db;

/**
* This class is responsible for read different schema
* structural elements: indexes, constraints, table names and columns.
*
* @api
*/
interface DbSchemaReaderInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Setup\Declaration\Schema\Db;

/**
* This class is responsible for read different schema structural elements: indexes, constraints,
* table names and columns.
*
* @api
*/
interface DbSchemaWriterInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
* Statement aggregator.
*
* Statements are concatenated conditionally, decides which statements go separately and which may be concatenated.
*
* @api
*/
class StatementAggregator
{
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\Setup\Declaration\Schema\Declaration;

use Magento\Framework\Setup\Declaration\Schema\Dto\Schema;

/**
* This class is responsible for basic validation rules.
*
* @api
*/
interface ValidationInterface
{
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\Setup\Declaration\Schema\Diff;

Expand All @@ -11,6 +12,8 @@
/**
* DiffInterface is type of classes, that holds all information
* that need to be changed from one installation to another.
*
* @api
*/
interface DiffInterface
{
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\Setup\Declaration\Schema\Dto\Columns;

/**
* Provides default value for column.
*
* @api
*/
interface ColumnDefaultAwareInterface
{
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\Setup\Declaration\Schema\Dto\Columns;

/**
* Provides auto_increment flag for column.
*
* @api
*/
interface ColumnIdentityAwareInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,15 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Setup\Declaration\Schema\Dto\Columns;

/**
* Provides nullable flag for element.
* If column element implement this interface, then it will have NULL or NOT NULL flag in column definition.
*
* @api
*/
interface ColumnNullableAwareInterface
{
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\Setup\Declaration\Schema\Dto\Columns;

/**
* Unsigned flag provider for element.
* If column element implement this interface, then it will have UNSIGNED flag in column
* definition.
*
* @api
*/
interface ColumnUnsignedAwareInterface
{
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\Setup\Declaration\Schema\Dto;

/**
* Element diff provider interface.
*
* This interface provides all params, that should participate in elements comparison.
*
* @api
*/
interface ElementDiffAwareInterface
{
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\Setup\Declaration\Schema\Dto\Factories;

use Magento\Framework\Setup\Declaration\Schema\Dto\ElementInterface;

/**
* DTO Element Factory Interface.
*
* @api
*/
interface FactoryInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
* Schema DTO element.
*
* Aggregation root for all structural elements. Provides access to tables by their names.
*
* @api
*/
class Schema
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
* Table structural element
* Aggregate inside itself: columns, constraints and indexes
* Resource is also specified on this strucural element
*
* @api
*/
class Table extends GenericElement implements
ElementInterface,
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\Setup\Declaration\Schema\Dto;

/**
* Table DTO Element interface.
*
* This interface can be used for elements that hold tables, like constraints.
*
* @api
*/
interface TableElementInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
* Element history container.
*
* This class holds history about element modifications.
*
* @api
*/
class ElementHistory
{
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\Setup\Declaration\Schema;

use Magento\Framework\Setup\Declaration\Schema\Db\Statement;

/**
* Schema operation interface.
*
* @api
*/
interface OperationInterface
{
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\Setup\Declaration\Schema;

Expand All @@ -14,6 +15,8 @@
* Used to fetch schema object with data from either db or XML file.
*
* Declaration has 2 schema builders, that build schema from db and from XML.
*
* @api
*/
interface SchemaConfigInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,15 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Framework\Setup\Patch;

/**
* This interface describe script, that atomic operations with data (DML, DQL) in SQL database
* This is wrapper for @see PatchInterface in order to define what kind of patch we have
*
* @api
*/
interface DataPatchInterface extends PatchInterface
{
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\Setup\Patch;

/**
Expand All @@ -14,6 +16,8 @@
* Patch1
*
* Here you see dependency of Patch1 to Patch2
*
* @api
*/
interface DependentPatchInterface
{
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\Setup\Patch;

/**
* Means that patch can`t be run in transaction
*
* @api
*/
interface NonTransactionableInterface
{
Expand Down
Loading