OperationInterface.php 977 Bytes
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace Magento\Framework\Setup\Declaration\Schema;

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

/**
 * Schema operation interface.
 */
interface OperationInterface
{
    /**
     * Retrieve operation identifier key.
     *
     * @return string
     */
    public function getOperationName();

    /**
     * Is operation destructive flag.
     *
     * Destructive operations can make system unstable.
     *
     * For example, if operation is destructive it can remove table or column created not with
     * declarative schema (for example with old migration script).
     *
     * @return bool
     */
    public function isOperationDestructive();

    /**
     * Apply change of any type.
     *
     * @param  ElementHistory $elementHistory
     * @return Statement[]
     */
    public function doOperation(ElementHistory $elementHistory);
}