PatchHistory.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Setup\Patch;

use Magento\Framework\App\ResourceConnection;

class PatchHistory
{
    const TABLE_NAME = 'patch_list';

    const CLASS_NAME = "patch_name";

    const SCHEMA_PATCH_TYPE = 'schema';

    const DATA_PATCH_TYPE = 'data';

    private $patchesRegistry = null;

    private $resourceConnection;

    public function __construct(ResourceConnection $resourceConnection)
    {
        $this->resourceConnection = $resourceConnection;
    }

    private function getAppliedPatches()
    {
        if ($this->patchesRegistry === null) {
            $adapter = $this->resourceConnection->getConnection();
            $filterSelect = $adapter
                ->select()
                ->from($this->resourceConnection->getTableName(self::TABLE_NAME), self::CLASS_NAME);
            $this->patchesRegistry = $adapter->fetchCol($filterSelect);
        }

        return $this->patchesRegistry;
    }

    public function fixPatch($patchName)
    {
        if ($this->isApplied($patchName)) {
            throw new \LogicException(sprintf("Patch %s cannot be applied twice", $patchName));
        }

        $adapter = $this->resourceConnection->getConnection();
        $adapter->insert($this->resourceConnection->getTableName(self::TABLE_NAME), [self::CLASS_NAME => $patchName]);
    }

    public function revertPatchFromHistory($patchName)
    {
        if (!$this->isApplied($patchName)) {
            throw new \LogicException(
                sprintf("Patch %s should be applied, before you can revert it", $patchName)
            );
        }

        $adapter = $this->resourceConnection->getConnection();
        $adapter->delete(
            $this->resourceConnection->getTableName(self::TABLE_NAME),
            [self::CLASS_NAME . "= ?" => $patchName]
        );
    }

    public function isApplied($patchName)
    {
        return in_array($patchName, $this->getAppliedPatches());
    }
}