PatchRevertableInterface.php 718 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
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Framework\Setup\Patch;

/**
 * Revertable means, that patch can be reverted
 *
 * All patches (@see PatchInterface) that implement this interfaces should have next values:
 * - do not use application layer: like Serilizer, Collections, etc
 * - use only some DML operations: INSERT, UPDATE
 * - DELETE DML operation is prohibited, because it can cause triggering foreign keys constraints
 * - all schema patches are not revertable
 */
interface PatchRevertableInterface
{
    /**
     * Rollback all changes, done by this patch
     *
     * @return void
     */
    public function revert();
}