OldDbValidator.php 2.34 KB
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 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\Framework\Setup;

use Composer\Package\Version\VersionParser;
use Magento\Framework\Module\DbVersionInfo;

/**
 * Old Validator for database
 *
 * Used in order to support backward compatability of modules that are installed
 * in old way (with Install/Upgrade Schema/Data scripts)
 */
class OldDbValidator implements UpToDateValidatorInterface
{
    /**
     * @var DbVersionInfo
     */
    private $dbVersionInfo;

    /**
     * @param DbVersionInfo $dbVersionInfo
     */
    public function __construct(DbVersionInfo $dbVersionInfo)
    {
        $this->dbVersionInfo = $dbVersionInfo;
    }

    /**
     * @inheritdoc
     */
    public function getNotUpToDateMessage(): string
    {
        $genericMessage = '<info>The module code base doesn\'t match the DB schema and data.</info>' .
            PHP_EOL .
            '<info>Some modules use code versions newer or older than the database.</info>';
        $messages = [];
        $versionParser = new VersionParser();
        $codebaseUpdateNeeded = false;
        foreach ($this->dbVersionInfo->getDbVersionErrors() as $error) {
            if (!$codebaseUpdateNeeded && $error[DbVersionInfo::KEY_CURRENT] !== 'none') {
                // check if module code base update is needed
                $currentVersion = $versionParser->parseConstraints($error[DbVersionInfo::KEY_CURRENT]);
                $requiredVersion = $versionParser->parseConstraints('>' . $error[DbVersionInfo::KEY_REQUIRED]);
                if ($requiredVersion->matches($currentVersion)) {
                    $codebaseUpdateNeeded = true;
                }

                $messages[] = sprintf(
                    "<info>%20s %10s: %11s  ->  %-11s</info>",
                    $error[DbVersionInfo::KEY_MODULE],
                    $error[DbVersionInfo::KEY_TYPE],
                    $error[DbVersionInfo::KEY_CURRENT],
                    $error[DbVersionInfo::KEY_REQUIRED]
                );
            }
        }

        return implode(PHP_EOL, $messages) . ($codebaseUpdateNeeded ? $genericMessage : '');
    }

    /**
     * Is up to date
     *
     * @return bool
     */
    public function isUpToDate(): bool
    {
        return empty($this->dbVersionInfo->getDbVersionErrors());
    }
}